ToggleToolButton

Description A GtkToggleToolButton is a GtkToolItem that contains a toggle button. Use gtk_toggle_tool_button_new() to create a new GtkToggleToolButton. Use gtk_toggle_tool_button_new_from_stock() to create a new GtkToggleToolButton containing a stock item.

class ToggleToolButton : ToolButton {

protected

GtkToggleToolButton* gtkToggleToolButton;

GtkToggleToolButton* getToggleToolButtonStruct();

void* getStruct();

this(GtkToggleToolButton* gtkToggleToolButton);

void setStruct(GObject* obj);

int[string] connectedSignals;

void delegate(ToggleToolButton)[] onToggledListeners;

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

static void callBackToggled(GtkToggleToolButton* toggleToolButtonStruct, ToggleToolButton _toggleToolButton);

this();

this(string stockId);

void setActive(int isActive);

int getActive();

}

Constructors

this this(GtkToggleToolButton* gtkToggleToolButton): Sets our main struct and passes it to the parent class
this this(): Returns a new GtkToggleToolButton Since 2.4
this this(string stockId): Creates a new GtkToggleToolButton containing the image and text from a stock item. Some stock ids have preprocessor macros like GTK_STOCK_OK and GTK_STOCK_APPLY. It is an error if stock_id is not a name of a stock item. Since 2.4

Members

Functions

addOnToggled void addOnToggled(void delegate(ToggleToolButton) dlg, ConnectFlags connectFlags): Emitted whenever the toggle tool button changes state. See Also
getActive int getActive(): Queries a GtkToggleToolButton and returns its current state. Returns TRUE if the toggle button is pressed in and FALSE if it is raised. Since 2.4
getStruct void* getStruct(): the main Gtk struct as a void*
getToggleToolButtonStruct GtkToggleToolButton* getToggleToolButtonStruct(): 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 tool 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. Since 2.4
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackToggled void callBackToggled(GtkToggleToolButton* toggleToolButtonStruct, ToggleToolButton _toggleToolButton): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkToggleToolButton GtkToggleToolButton* gtkToggleToolButton;: the main Gtk struct
onToggledListeners void delegate(ToggleToolButton)[] onToggledListeners;: Undocumented in source.

Inherited Members

From ToolButton

gtkToolButton GtkToolButton* gtkToolButton;: the main Gtk struct
getToolButtonStruct GtkToolButton* getToolButtonStruct(): 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.
setActionName void setActionName(string action)
getActionName string getActionName()
connectedSignals int[string] connectedSignals;
onClickedListeners void delegate(ToolButton)[] onClickedListeners;: Undocumented in source.
addOnClicked void addOnClicked(void delegate(ToolButton) dlg, ConnectFlags connectFlags): This signal is emitted when the tool button is clicked with the mouse or activated with the keyboard. See Also GtkToolbar The toolbar widget GtkMenuToolButton A subclass of GtkToolButton that displays on the toolbar a button with an additional dropdown menu GtkToggleToolButton A subclass of GtkToolButton that displays toggle buttons on the toolbar GtkRadioToolButton A subclass of GtkToolButton that displays radio buttons on the toolbar GtkSeparatorToolItem A subclass of GtkToolItem that separates groups of items on a toolbar
callBackClicked void callBackClicked(GtkToolButton* toolbuttonStruct, ToolButton _toolButton): Undocumented in source. Be warned that the author may not have intended to support it.
setLabel void setLabel(string label): Sets label as the label used for the tool button. The "label" property only has an effect if not overridden by a non-NULL "label_widget" property. If both the "label_widget" and "label" properties are NULL, the label is determined by the "stock_id" property. If the "stock_id" property is also NULL, button will not have a label. Since 2.4
getLabel string getLabel(): Returns the label used by the tool button, or NULL if the tool button doesn't have a label. or uses a the label from a stock item. The returned string is owned by GTK+, and must not be modified or freed. Since 2.4
setUseUnderline void setUseUnderline(int useUnderline): If set, an underline in the label property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu. For example, if the label property is "_Open" and use_underline is TRUE, the label on the tool button will be "Open" and the item on the overflow menu will have an underlined 'O'. Labels shown on tool buttons never have mnemonics on them; this property only affects the menu item on the overflow menu. Since 2.4
getUseUnderline int getUseUnderline(): Returns whether underscores in the label property are used as mnemonics on menu items on the overflow menu. See gtk_tool_button_set_use_underline(). Since 2.4
setStockId void setStockId(string stockId): Sets the name of the stock item. See gtk_tool_button_new_from_stock(). The stock_id property only has an effect if not overridden by non-NULL "label" and "icon_widget" properties. Since 2.4
getStockId string getStockId(): Returns the name of the stock item. See gtk_tool_button_set_stock_id(). The returned string is owned by GTK+ and must not be freed or modifed. Since 2.4
setIconName void setIconName(string iconName): Sets the icon for the tool button from a named themed icon. See the docs for GtkIconTheme for more details. The "icon_name" property only has an effect if not overridden by non-NULL "label", "icon_widget" and "stock_id" properties. Since 2.8
getIconName string getIconName(): Returns the name of the themed icon for the tool button, see gtk_tool_button_set_icon_name(). Since 2.8
setIconWidget void setIconWidget(Widget iconWidget): Sets icon as the widget used as icon on button. If icon_widget is NULL the icon is determined by the "stock_id" property. If the "stock_id" property is also NULL, button will not have an icon. Since 2.4
getIconWidget Widget getIconWidget(): Return the widget used as icon widget on button. See gtk_tool_button_set_icon_widget(). Since 2.4
setLabelWidget void setLabelWidget(Widget labelWidget): Sets label_widget as the widget that will be used as the label for button. If label_widget is NULL the "label" property is used as label. If "label" is also NULL, the label in the stock item determined by the "stock_id" property is used as label. If "stock_id" is also NULL, button does not have a label. Since 2.4
getLabelWidget Widget getLabelWidget(): Returns the widget used as label on button. See gtk_tool_button_set_label_widget(). Since 2.4