Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AnimationMixer (2)
- AudioStreamPlayer
- CanvasItem (2)
- CanvasLayer (1)
- EditorFileSystem
- EditorPlugin (1)
- EditorResourcePreview
- HTTPRequest
- InstancePlaceholder
- MissingNode
- MultiplayerSpawner
- MultiplayerSynchronizer
- NavigationAgent2D
- NavigationAgent3D
- Node3D (31)
- ResourcePreloader
- ShaderGlobalsOverride
- StatusIndicator
- Timer
- Viewport (2)
- WorldEnvironment
- BaseButton (3)
- ColorRect
- Container (13)
- GraphEdit
- ItemList
- Label
- LineEdit
- MenuBar
- NinePatchRect
- Panel
- Range (6)
- ReferenceRect
- RichTextLabel
- Separator (2)
- TabBar
- TextEdit (1)
- TextureRect
- Tree
- VideoStreamPlayer
Table of contents
-
var alignment: int = 0 -
var toggle_mode: bool = true -
self["theme_override_constants/check_v_offset"] = 0 as int -
self["theme_override_icons/checked"] = icon as Texture2D -
self["theme_override_icons/checked_disabled"] = icon as Texture2D -
self["theme_override_icons/checked_disabled_mirrored"] = icon as Texture2D -
self["theme_override_icons/checked_mirrored"] = icon as Texture2D -
self["theme_override_icons/unchecked"] = icon as Texture2D -
self["theme_override_icons/unchecked_disabled"] = icon as Texture2D -
self["theme_override_icons/unchecked_disabled_mirrored"] = icon as Texture2D -
self["theme_override_icons/unchecked_mirrored"] = icon as Texture2D
CheckButton #
is_instantiable, Node, core, not_builtin_classes
A button that represents a binary choice.
CheckButton is a toggle button displayed as a check field. It's similar to CheckBox in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an immediate effect on something. For example, it can be used when pressing it shows or hides advanced settings, without asking the user to confirm this action.
See also BaseButton which contains common properties and methods associated with this node.
Members #
var alignment: int = 0#
var toggle_mode: bool = true#
Methods #
Annotations #
Constants #
Constructors #
Enums #
Operators #
Signals #
Theme Items #
self["theme_override_constants/check_v_offset"] = 0 as int#
The vertical offset used when rendering the toggle icons (in pixels).
self["theme_override_icons/checked"] = icon as Texture2D#
The icon to display when the CheckButton is checked (for left-to-right layouts).
self["theme_override_icons/checked_disabled"] = icon as Texture2D#
The icon to display when the CheckButton is checked and disabled (for left-to-right layouts).
self["theme_override_icons/checked_disabled_mirrored"] = icon as Texture2D#
The icon to display when the CheckButton is checked and disabled (for right-to-left layouts).
self["theme_override_icons/checked_mirrored"] = icon as Texture2D#
The icon to display when the CheckButton is checked (for right-to-left layouts).
self["theme_override_icons/unchecked"] = icon as Texture2D#
The icon to display when the CheckButton is unchecked (for left-to-right layouts).
self["theme_override_icons/unchecked_disabled"] = icon as Texture2D#
The icon to display when the CheckButton is unchecked and disabled (for left-to-right layouts).
self["theme_override_icons/unchecked_disabled_mirrored"] = icon as Texture2D#
The icon to display when the CheckButton is unchecked and disabled (for right-to-left layouts).
self["theme_override_icons/unchecked_mirrored"] = icon as Texture2D#
The icon to display when the CheckButton is unchecked (for right-to-left layouts).