→ index of namespace ui

→ index of project ui

→ index of module MCheckBox

Class `MCheckBox.ui::CheckBox`

Synopsis:

Base classes:

Derived classes:

MRadioButton.ui::RadioButton

Functions:

New(int bSelected, String caption) -

Methods:

beginXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int -
calcSizeX() : float -
getCurrentIconName() : String -
getCurrentLabelIcon() : ui::Icon -
getProvidedActionNames() : StringArray -
handleHold() -
handleToggleSelection() -
initCheckBox(int bSelected, String caption) -
initCheckBoxOnly(int bSelected, String caption) -
isMouseFocusLocked() : int -
isSelected() : int - Query the current state of the checkbox (enabled=true, disabled=false)
isTabCycleMember() : int -
onDraw() -
onKey(Key k) : int -
onKeyboardFocus() -
onKeyboardFocusLost(int bQuiet) -
onLookAndFeelChanged() -
onMouse(ui::MouseEvent ev) : int -
onMouseClick(ui::MouseEvent ev) : int -
onMouseEnter(ui::MouseEvent ev) : int -
onMouseHold(ui::MouseEvent ev) : int -
onMouseLeave(ui::MouseEvent ev) : int -
onTabFocus() -
provideActionToggle() -
randomize() -
setCaption(String caption) -
setDefaultInnerPadding() -
setEnableHold(int bHold) -
setEnableMixedState(int bMixed) -
setForceIconNameSelected(String name) -
setIconNamePrefix(String s) -
setIconNameSuffix(String s) -
setSelected(int b) - Set the current state of the checkbox (enabled=true, disabled=false)
setSelectedAction(int b) -
setSelectedAndDisable(int b) -
setSelectedAndEditable(int b) -
setSelectedAndEnable(int b) -
toggleSelection() -
toggleSelectionAction() -
toggleSelectionActionTrueOrFalse() -
toggleSelectionActionTrueOrMaybe() -
wantKeyRepeat(Key k) : int -

Constants:

Function New

Signature

New	(	int	bSelected	,
		String	caption
		)

Arguments

int	bSelected	–
String	caption	–

→ top of page

Method beginXFMTag

Signature

beginXFMTag	(	ui::AbstractXMLForm	form	,
		HashTable	attributes
		)
	:	int

Arguments

ui::AbstractXMLForm	form	–
HashTable	attributes	–

Returns

int

–

→ top of page

Method calcSizeX

Signature

calcSizeX

(

)

float

Returns

float

–

→ top of page

Method getCurrentIconName

Signature

getCurrentIconName

(

)

String

Returns

String

–

→ top of page

Method getCurrentLabelIcon

Signature

getCurrentLabelIcon

(

)

ui::Icon

Returns

ui::Icon

–

→ top of page

Method getProvidedActionNames

Signature

getProvidedActionNames

(

)

StringArray

Returns

StringArray

–

→ top of page

Method handleHold

Signature

handleHold

(

)

→ top of page

Method handleToggleSelection

Signature

handleToggleSelection

(

)

→ top of page

Method initCheckBox

Signature

initCheckBox	(	int	bSelected	,
		String	caption
		)

Arguments

int	bSelected	–
String	caption	–

→ top of page

Method initCheckBoxOnly

Signature

initCheckBoxOnly	(	int	bSelected	,
		String	caption
		)

Arguments

int	bSelected	–
String	caption	–

→ top of page

Method isMouseFocusLocked

Signature

isMouseFocusLocked

(

)

int

Returns

int

–

→ top of page

Method isSelected

Query the current state of the checkbox (enabled=true, disabled=false)

Signature

isSelected

(

)

int

Returns

int

–

→ top of page

Method isTabCycleMember

Signature

isTabCycleMember

(

)

int

Returns

int

–

→ top of page

Method onDraw

Signature

onDraw

(

)

→ top of page

Method onKey

Signature

onKey	(	Key	k	)
	:	int

Arguments

Key

–

Returns

int

–

→ top of page

Method onKeyboardFocus

Signature

onKeyboardFocus

(

)

→ top of page

Method onKeyboardFocusLost

Signature

onKeyboardFocusLost

(

int

bQuiet

)

Arguments

int

bQuiet

–

→ top of page

Method onLookAndFeelChanged

Signature

onLookAndFeelChanged

(

)

→ top of page

Method onMouse

Signature

onMouse	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseClick

Signature

onMouseClick	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseEnter

Signature

onMouseEnter	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseHold

Signature

onMouseHold	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onMouseLeave

Signature

onMouseLeave	(	ui::MouseEvent	ev	)
	:	int

Arguments

ui::MouseEvent

–

Returns

int

–

→ top of page

Method onTabFocus

Signature

onTabFocus

(

)

→ top of page

Method provideActionToggle

Signature

provideActionToggle

(

)

→ top of page

Method randomize

Signature

randomize

(

)

→ top of page

Method setCaption

Signature

setCaption

(

String

caption

)

Arguments

String

caption

–

→ top of page

Method setDefaultInnerPadding

Signature

setDefaultInnerPadding

(

)

→ top of page

Method setEnableHold

Signature

setEnableHold

(

int

bHold

)

Arguments

int

bHold

–

→ top of page

Method setEnableMixedState

Signature

setEnableMixedState

(

int

bMixed

)

Arguments

int

bMixed

–

→ top of page

Method setForceIconNameSelected

Signature

setForceIconNameSelected

(

String

name

)

Arguments

String

name

–

→ top of page

Method setIconNamePrefix

Signature

setIconNamePrefix

(

String

)

Arguments

String

–

→ top of page

Method setIconNameSuffix

Signature

setIconNameSuffix

(

String

)

Arguments

String

–

→ top of page

Method setSelected

Set the current state of the checkbox (enabled=true, disabled=false)

Signature

setSelected

(

int

)

Arguments

int

–

→ top of page

Method setSelectedAction

Signature

setSelectedAction

(

int

)

Arguments

int

–

→ top of page

Method setSelectedAndDisable

Signature

setSelectedAndDisable

(

int

)

Arguments

int

–

→ top of page

Method setSelectedAndEditable

Signature

setSelectedAndEditable

(

int

)

Arguments

int

–

→ top of page

Method setSelectedAndEnable

Signature

setSelectedAndEnable

(

int

)

Arguments

int

–

→ top of page

Method toggleSelection

Signature

toggleSelection

(

)

→ top of page

Method toggleSelectionAction

Signature

toggleSelectionAction

(

)

→ top of page

Method toggleSelectionActionTrueOrFalse

Signature

toggleSelectionActionTrueOrFalse

(

)

→ top of page

Method toggleSelectionActionTrueOrMaybe

Signature

toggleSelectionActionTrueOrMaybe

(

)

→ top of page

Method wantKeyRepeat

Signature

wantKeyRepeat	(	Key	k	)
	:	int

Arguments

Key

–

Returns

int

–

→ top of page

Constant `ACTION_HOLD_CLICK (String)`

Constant `ACTION_KEY (String)`

Constant `ACTION_TOGGLE (String)`

Constant `TEXT_POS_X (int)`

Project Modules:	`MAbstractXMLForm` , `MAcceleratorKey` , `MAcceleratorList` , `MAction` , `MActionConsumer` , `MActionProvider` , `MBezier01Edit` , `MBezierEdit` , `MButton` , `MCharFilter` , `MCharFilterBinary255Expr` , `MCharFilterFloat` , `MCharFilterFloatExpr` , `MCharFilterHex` , `MCharFilterHexExpr` , `MCharFilterHexShort` , `MCharFilterHexShortExpr` , `MCharFilterUFix16` , `MCheckBox` , `MChoiceDialog` , `MCmdProvider` , `MColorBox` , `MColorButton` , `MComboBox` , `MComboBoxPopup` , `MComboBoxTM` , `MComboField` , `MComposite` , `MControl` , `MCursorShapes` , `MDial` , `MDialog` , `MDragHandleLabel` , `MDynamicPopupMenuAction` , `MFBO` , `MFloatAction` , `MFloatField` , `MFloatingLayer` , `MFloatParam` , `MFloatParamDialog` , `MFloatParamEditor` , `MFlowLayout` , `MFont` , `MFontCache` , `MFontResource` , `MForm` , `MFT2Face` , `MFT2FontResource` , `MFT2Glyph` , `MGeometry4f` , `MGraph` , `MGraphForm` , `MGridLayout` , `MHiddenPanel` , `MHSVColorPicker` , `MIcon` , `MIconCache` , `MInfoDialog` , `MIntAction` , `MKeyAction` , `MKeyboardMonitor` , `MKeyHelpDialog` , `MLabel` , `MLayer` , `MLayerSwitch` , `MLayout` , `MLogger` , `MLookAndFeel` , `MLookAndFeel_Dark` , `MLookAndFeel_Light` , `MLookAndFeel_Mono` , `MMouseEvent` , `MObjectAction` , `MOpaquePanel` , `MPanel` , `MPNGIcon` , `MPopupMenu` , `MPopupMenuBar` , `MPopupMenuBarButton` , `MPopupMenuButton` , `MPopupMenuCheckButton` , `MPopupMenuFolderButton` , `MPopupMenuSeparator` , `MPopupMenuWindowDock` , `MRadioButton` , `MRadioButtonGroup` , `MRectangle2f` , `MRepeatButton` , `MScroller` , `MScrollPane` , `MShader` , `MShader_ColorGrading` , `MShader_GradientH` , `MShader_GradientR` , `MShader_GradientV` , `MShader_InvertColor` , `MShader_PatternFill` , `MShader_PatternGradientH` , `MShader_PatternGradientR` , `MShader_PatternGradientV` , `MShader_SharpenFilter` , `MShader_SharpenFilterAndColorGrading` , `MShape` , `MShapePolyline` , `MSizeGroup` , `MSizeGroupX` , `MSizeGroupXY` , `MSizeGroupY` , `MSlider` , `MSpacer` , `MSplitPane` , `MStatusBar` , `MStringAction` , `MStringDialog` , `MSuperBorderLayout` , `MTableCellEditor` , `MTableCellEditorCheckBox` , `MTableCellEditorComboBox` , `MTableCellEditorFloatParam` , `MTableCellEditorString` , `MTableModel` , `MTableView` , `MTableViewData` , `MTableViewHeader` , `MTabSwitch` , `MTextEdit` , `MTextEditDialog` , `MTextField` , `MTextFieldIncDec` , `MTextInputDialog` , `MTextView` , `MTimerAction` , `MTitledPanel` , `MToolTip` , `MTransparentPanel` , `MTreeTableModel` , `MTreeTableNode` , `MUI` , `MUIConstants` , `MUIPluginLoader` , `MUIRenderer` , `MUserDataContainer` , `MValueAction` , `MView` , `MViewPane` , `MWindow` , `MWindowDock` , `MWindowTitleBar` , `MXFMObject` , `MXMLForm` , `MXYPad`
Project Classes:	`CmdProvider` , `ColorBox` , `graph::AttribsBase` , `graph::BBox` , `graph::Canvas` , `graph::Cell` , `graph::Edge` , `graph::GR` , `graph::Graph` , `graph::GRGradient` , `graph::GRPalette` , `graph::GRParseContext` , `graph::GRStyle` , `graph::GRUtils` , `graph::Node` , `graph::Port` , `graph::PortsBase` , `HSVColorPicker` , `ui::AbstractXMLForm` , `ui::AcceleratorKey` , `ui::AcceleratorList` , `ui::Action` , `ui::ActionConsumer` , `ui::ActionProvider` , `ui::Bezier01Edit` , `ui::BezierEdit` , `ui::BezierEditState` , `ui::BezierHistory` , `ui::BezierLUT01` , `ui::BorderLayout` , `ui::Button` , `ui::CharFilter` , `ui::CharFilterBinary255Expr` , `ui::CharFilterFloat` , `ui::CharFilterFloatExpr` , `ui::CharFilterHex` , `ui::CharFilterHexExpr` , `ui::CharFilterHexShort` , `ui::CharFilterHexShortExpr` , `ui::CharFilterUFix16` , `ui::CheckBox` , `ui::ChoiceDialog` , `ui::ColorButton` , `ui::ComboBox` , `ui::ComboBoxPopup` , `ui::ComboBoxTM` , `ui::ComboField` , `ui::Composite` , `ui::Control` , `ui::CursorShapes` , `ui::Dial` , `ui::Dialog` , `ui::DragHandleLabel` , `ui::DynamicPopupMenuAction` , `ui::FBO` , `ui::FloatAction` , `ui::FloatField` , `ui::FloatingLayer` , `ui::FloatParam` , `ui::FloatParamDialog` , `ui::FloatParamEditor` , `ui::FlowLayout` , `ui::Font` , `ui::FontCache` , `ui::FontResource` , `ui::Form` , `ui::FT2Face` , `ui::FT2FontResource` , `ui::FT2Glyph` , `ui::FT2LocalFileFontResource` , `ui::FT2PakFileFontResource` , `ui::Geometry4f` , `ui::GraphEdge` , `ui::GraphEdgeArrow` , `ui::GraphForm` , `ui::GraphPortButton` , `ui::GridLayout` , `ui::HiddenPanel` , `ui::Icon` , `ui::IconCache` , `ui::InfoDialog` , `ui::IntAction` , `ui::KeyAction` , `ui::KeyboardFocusListener` , `ui::KeyboardMonitor` , `ui::KeyboardMonitorEntry` , `ui::KeyHelpButton` , `ui::KeyHelpDialog` , `ui::KeyHelpToolTip` , `ui::KeyRepeatAction` , `ui::KeyRepeatConsumer` , `ui::Label` , `ui::Layer` , `ui::LayerSwitch` , `ui::Layout` , `ui::Logger` , `ui::LookAndFeel` , `ui::LookAndFeelDefs` , `ui::LookAndFeel_Dark` , `ui::LookAndFeel_Light` , `ui::LookAndFeel_Mono` , `ui::MouseEvent` , `ui::MouseHoldAction` , `ui::MouseHoldConsumer` , `ui::ObjectAction` , `ui::OpaquePanel` , `ui::Panel` , `ui::PNGIcon` , `ui::PopupMenu` , `ui::PopupMenuBar` , `ui::PopupMenuBarButton` , `ui::PopupMenuButton` , `ui::PopupMenuCheckButton` , `ui::PopupMenuFolderButton` , `ui::PopupMenuRadioButton` , `ui::PopupMenuSeparator` , `ui::PopupMenuWindowDock` , `ui::RadioButton` , `ui::RadioButtonGroup` , `ui::Rectangle2f` , `ui::RepeatButton` , `ui::Scroller` , `ui::ScrollPane` , `ui::Shader` , `ui::Shader_ColorGrading` , `ui::Shader_GradientH` , `ui::Shader_GradientR` , `ui::Shader_GradientV` , `ui::Shader_InvertColor` , `ui::Shader_PatternFill` , `ui::Shader_PatternGradientH` , `ui::Shader_PatternGradientR` , `ui::Shader_PatternGradientV` , `ui::Shader_SharpenFilter` , `ui::Shader_SharpenFilterAndColorGrading` , `ui::Shape` , `ui::ShapePolyline` , `ui::SizeGroup` , `ui::SizeGroupX` , `ui::SizeGroupXY` , `ui::SizeGroupY` , `ui::Slider` , `ui::Spacer` , `ui::SplitPane` , `ui::StatusBar` , `ui::StatusBarListener` , `ui::StatusBarMessage` , `ui::StringAction` , `ui::StringDialog` , `ui::StringDialogTextField` , `ui::SuperBorderLayout` , `ui::TableCellEditor` , `ui::TableCellEditorCheckBox` , `ui::TableCellEditorComboBox` , `ui::TableCellEditorFloatParam` , `ui::TableCellEditorString` , `ui::TableGraphPanel` , `ui::TableModel` , `ui::TableView` , `ui::TableViewData` , `ui::TableViewHeader` , `ui::TabSwitch` , `ui::TabSwitchLabelPanel` , `ui::TextEdit` , `ui::TextEditDialog` , `ui::TextEditPlugin` , `ui::TextEditUndoEntry` , `ui::TextField` , `ui::TextFieldIncDec` , `ui::TextInputDialog` , `ui::TextView` , `ui::TextViewSyntaxHighlighter` , `ui::TimerAction` , `ui::TitledPanel` , `ui::ToolTip` , `ui::TransparentPanel` , `ui::TreeTableModel` , `ui::TreeTableNode` , `ui::TriadKeyConsumer` , `ui::UI` , `ui::UIConstants` , `ui::UIRenderer` , `ui::UserDataContainer` , `ui::ValueAction` , `ui::View` , `ui::ViewPane` , `ui::Window` , `ui::WindowDock` , `ui::WindowTitleBar` , `ui::XFMObject` , `ui::XMLForm` , `ui::XYPad`
Project Functions:	`getTableViewStepCoarse` , `Screen_onApplicationActive` , `Screen_onClose` , `Screen_onDrainEventQueue` , `Screen_onDraw` , `Screen_onDropFiles` , `Screen_onExpose` , `Screen_onInputFocusActive` , `Screen_onKeyboard` , `Screen_onMouse` , `Screen_onMouseFocusActive` , `Screen_onMoveWindow` , `Screen_onOpen` , `Screen_onResize` , `Screen_onTimer` , `SetDebugLevel` , `SetDebugLevel` , `SetEnableProfiling`
All Namespaces:	`default` , `graph` , `ui`
All Projects:	`core` , `eqxmms` , `ShaderVG` , `ShaderVG_Text` , `tkanalogrytm` , `tkchipmunk` , `tkclap` , `tkfileutils` , `tkfreeglut` , `tkfreetype2` , `tkfreeverb` , `tkmath` , `tkmidi` , `tkmidipipe` , `tkminnie` , `tkoldmath` , `tkopengl` , `tkportaudio` , `tkradiastools` , `tksamplechain` , `tksampleedit` , `tksampler` , `tksdl` , `tksdl_net` , `tksidplay2` , `tkspeexdsp` , `tksqlite` , `tktriangulate` , `tkui` , `tkvst2` , `tkzip` , `ui` , `yingtest`

auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:42:00

Class MCheckBox.ui::CheckBox

Class `MCheckBox.ui::CheckBox`