ToggleButton

A GtkToggleButton is a GtkButton which will remain 'pressed-in' when clicked. Clicking again will cause the toggle button to return to its normal state.

A toggle button is created by calling either gtk_toggle_button_new() or gtk_toggle_button_new_with_label(). If using the former, it is advisable to pack a widget, (such as a GtkLabel and/or a GtkImage), into the toggle button's container. (See GtkButton for more information).

The state of a GtkToggleButton can be set specifically using gtk_toggle_button_set_active(), and retrieved using gtk_toggle_button_get_active().

To simply switch the state of a toggle button, use gtk_toggle_button_toggled().

class ToggleButton : Button {

protected

GtkToggleButton* gtkToggleButton;

GtkToggleButton* getToggleButtonStruct();

void* getStruct();

this(GtkToggleButton* gtkToggleButton);

void setStruct(GObject* obj);

this(string label, bool mnemonic);

int[string] connectedSignals;

void delegate(ToggleButton)[] onToggledListeners;

void addOnToggled(void delegate(ToggleButton) dlg, ConnectFlags connectFlags);

static void callBackToggled(GtkToggleButton* togglebuttonStruct, ToggleButton _toggleButton);

this();

void setMode(int drawIndicator);

int getMode();

void toggled();

int getActive();

void setActive(int isActive);

int getInconsistent();

void setInconsistent(int setting);

}

Constructors

this this(GtkToggleButton* gtkToggleButton): Sets our main struct and passes it to the parent class
this this(string label, bool mnemonic): Creates a new toggle button with a text label.
this this(): Creates a new toggle button. A widget should be packed into the button, as in gtk_button_new().

Members

Functions

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, GtkCheckButton, GtkCheckMenuItem
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.
getInconsistent int getInconsistent(): Gets the value set by gtk_toggle_button_set_inconsistent().
getMode int getMode(): Retrieves whether the button is displayed as a separate indicator and label. See gtk_toggle_button_set_mode().
getStruct void* getStruct(): the main Gtk struct as a void*
getToggleButtonStruct GtkToggleButton* getToggleButtonStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
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 and the "clicked" signal to be emitted.
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.
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.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
toggled void toggled(): Emits the "toggled" signal on the GtkToggleButton. There is no good reason for an application ever to call this function.

Static functions

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

Variables

connectedSignals int[string] connectedSignals;
gtkToggleButton GtkToggleButton* gtkToggleButton;: the main Gtk struct
onToggledListeners void delegate(ToggleButton)[] onToggledListeners;: Undocumented in source.

Inherited Members

From Button

gtkButton GtkButton* gtkButton;: the main Gtk struct
getButtonStruct GtkButton* getButtonStruct(): 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.
__anonymous mixin ActionableT!(GtkButton): Undocumented in source.
__anonymous mixin ActivatableT!(GtkButton): Undocumented in source.
setIconSize void setIconSize(IconSize iconSize)
getIconSize IconSize getIconSize()
connectedSignals int[string] connectedSignals;
onActivateListeners void delegate(Button)[] onActivateListeners;: Undocumented in source.
addOnActivate void addOnActivate(void delegate(Button) dlg, ConnectFlags connectFlags): The ::activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the "clicked" signal.
callBackActivate void callBackActivate(GtkButton* widgetStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
onClickedListeners void delegate(Button)[] onClickedListeners;: Undocumented in source.
addOnClicked void addOnClicked(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button has been activated (pressed and released).
callBackClicked void callBackClicked(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
onEnterListeners void delegate(Button)[] onEnterListeners;: Undocumented in source.
addOnEnter void addOnEnter(void delegate(Button) dlg, ConnectFlags connectFlags): Warning GtkButton::enter has been deprecated since version 2.8 and should not be used in newly-written code. Use the "enter-notify-event" signal. Emitted when the pointer enters the button.
callBackEnter void callBackEnter(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
onLeaveListeners void delegate(Button)[] onLeaveListeners;: Undocumented in source.
addOnLeave void addOnLeave(void delegate(Button) dlg, ConnectFlags connectFlags): Warning GtkButton::leave has been deprecated since version 2.8 and should not be used in newly-written code. Use the "leave-notify-event" signal. Emitted when the pointer leaves the button.
callBackLeave void callBackLeave(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
onPressedListeners void delegate(Button)[] onPressedListeners;: Undocumented in source.
addOnPressed void addOnPressed(void delegate(Button) dlg, ConnectFlags connectFlags): Warning GtkButton::pressed has been deprecated since version 2.8 and should not be used in newly-written code. Use the "button-press-event" signal. Emitted when the button is pressed.
callBackPressed void callBackPressed(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
onReleasedListeners void delegate(Button)[] onReleasedListeners;: Undocumented in source.
addOnReleased void addOnReleased(void delegate(Button) dlg, ConnectFlags connectFlags): Warning GtkButton::released has been deprecated since version 2.8 and should not be used in newly-written code. Use the "button-release-event" signal. Emitted when the button is released.
callBackReleased void callBackReleased(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
pressed void pressed(): Warning gtk_button_pressed has been deprecated since version 2.20 and should not be used in newly-written code. Use the "button-press-event" signal. Emits a "pressed" signal to the given GtkButton.
released void released(): Warning gtk_button_released has been deprecated since version 2.20 and should not be used in newly-written code. Use the "button-release-event" signal. Emits a "released" signal to the given GtkButton.
clicked void clicked(): Emits a "clicked" signal to the given GtkButton.
enter void enter(): Warning gtk_button_enter has been deprecated since version 2.20 and should not be used in newly-written code. Use the "enter-notify-event" signal. Emits a "enter" signal to the given GtkButton.
leave void leave(): Warning gtk_button_leave has been deprecated since version 2.20 and should not be used in newly-written code. Use the "leave-notify-event" signal. Emits a "leave" signal to the given GtkButton.
setRelief void setRelief(GtkReliefStyle newstyle): Sets the relief style of the edges of the given GtkButton widget. Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE. The default style is, as one can guess, GTK_RELIEF_NORMAL.
getRelief GtkReliefStyle getRelief(): Returns the current relief style of the given GtkButton.
getLabel string getLabel(): Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container.
setLabel void setLabel(string label): Sets the text of the label of the button to str. This text is also used to select the stock item if gtk_button_set_use_stock() is used. This will also clear any previously set labels.
getUseStock int getUseStock(): Warning gtk_button_get_use_stock is deprecated and should not be used in newly-written code. 3.10 Returns whether the button label is a stock item.
setUseStock void setUseStock(int useStock): Warning gtk_button_set_use_stock is deprecated and should not be used in newly-written code. 3.10 If TRUE, the label set on the button is used as a stock id to select the stock item for the button.
getUseUnderline int getUseUnderline(): Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline().
setUseUnderline void setUseUnderline(int useUnderline): If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.
setFocusOnClick void setFocusOnClick(int focusOnClick): Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don't want the keyboard focus removed from the main area of the application. Since 2.4
getFocusOnClick int getFocusOnClick(): Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click(). Since 2.4
setAlignment void setAlignment(float xalign, float yalign): Sets the alignment of the child. This property has no effect unless the child is a GtkMisc or a GtkAlignment. Since 2.4
getAlignment void getAlignment(float xalign, float yalign): Gets the alignment of the child in the button. Since 2.4
setImage void setImage(Widget image): Set the image of button to the given widget. The image will be displayed if the label text is NULL or if "always-show-image" is TRUE. You don't have to call gtk_widget_show() on image yourself. Since 2.6
getImage Widget getImage(): Gets the widget that is currenty set as the image of button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock(). Since 2.6
setImagePosition void setImagePosition(GtkPositionType position): Sets the position of the image relative to the text inside the button. Since 2.10
getImagePosition GtkPositionType getImagePosition(): Gets the position of the image relative to the text inside the button. Since 2.10
setAlwaysShowImage void setAlwaysShowImage(int alwaysShow): If TRUE, the button will always show the image in addition to the label, if available. Use this property if the button would be useless or hard to use without the image.
getAlwaysShowImage int getAlwaysShowImage(): Returns whether the button will always show the image in addition to the label, if available.
getEventWindow Window getEventWindow(): Returns the button's event window if it is realized, NULL otherwise. This function should be rarely needed. Since 2.22