CheckButton

Description A GtkCheckButton places a discrete GtkToggleButton next to a widget, (usually a GtkLabel). See the section on GtkToggleButton widgets for more information about toggle/check buttons. The important signal ('toggled') is also inherited from GtkToggleButton.

Constructors

this
this(GtkCheckButton* gtkCheckButton)

Sets our main struct and passes it to the parent class

this
this(string label, bool mnemonic)

Creates a new GtkCheckButton with a GtkLabel to the right of it. If mnemonic is true the label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the check button.

this
this(string label, void delegate(CheckButton) onClicked, bool mnemonic)
this
this()

Creates a new GtkCheckButton.

Members

Functions

getCheckButtonStruct
GtkCheckButton* getCheckButtonStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

gtkCheckButton
GtkCheckButton* gtkCheckButton;

the main Gtk struct

Inherited Members

From ToggleButton

gtkToggleButton
GtkToggleButton* gtkToggleButton;

the main Gtk struct

getToggleButtonStruct
GtkToggleButton* getToggleButtonStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals
int[string] connectedSignals;
onToggledListeners
void delegate(ToggleButton)[] onToggledListeners;
Undocumented in source.
addOnToggled
void addOnToggled(void delegate(ToggleButton) dlg, ConnectFlags connectFlags)

Should be connected if you wish to perform an action whenever the GtkToggleButton's state is changed. See Also GtkButton a more general button. GtkCheckButton another way of presenting a toggle option. GtkCheckMenuItem a GtkToggleButton as a menu item.

callBackToggled
void callBackToggled(GtkToggleButton* togglebuttonStruct, ToggleButton _toggleButton)
Undocumented in source. Be warned that the author may not have intended to support it.
setMode
void setMode(int drawIndicator)

Sets whether the button is displayed as a separate indicator and label. You can call this function on a checkbutton or a radiobutton with draw_indicator = FALSE to make the button look like a normal button This function only affects instances of classes like GtkCheckButton and GtkRadioButton that derive from GtkToggleButton, not instances of GtkToggleButton itself.

getMode
int getMode()

Retrieves whether the button is displayed as a separate indicator and label. See gtk_toggle_button_set_mode().

toggled
void toggled()

Emits the toggled signal on the GtkToggleButton. There is no good reason for an application ever to call this function.

getActive
int getActive()

Queries a GtkToggleButton and returns its current state. Returns TRUE if the toggle button is pressed in and FALSE if it is raised.

setActive
void setActive(int isActive)

Sets the status of the toggle button. Set to TRUE if you want the GtkToggleButton to be 'pressed in', and FALSE to raise it. This action causes the toggled signal to be emitted.

getInconsistent
int getInconsistent()

Gets the value set by gtk_toggle_button_set_inconsistent().

setInconsistent
void setInconsistent(int setting)

If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state. This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user toggles the toggle button. This has to be done manually, gtk_toggle_button_set_inconsistent() only affects visual appearance, it doesn't affect the semantics of the button.

Meta