ToggleAction

Description A GtkToggleAction corresponds roughly to a GtkCheckMenuItem. It has an "active" state specifying whether the action has been checked or not.

class ToggleAction : Action {

protected

GtkToggleAction* gtkToggleAction;

GtkToggleAction* getToggleActionStruct();

void* getStruct();

this(GtkToggleAction* gtkToggleAction);

void setStruct(GObject* obj);

this(string name, string label, string tooltip, StockID stockId);

int[string] connectedSignals;

void delegate(ToggleAction)[] onToggledListeners;

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

static void callBackToggled(GtkToggleAction* toggleactionStruct, ToggleAction _toggleAction);

this(string name, string label, string tooltip, string stockId);

void toggled();

void setActive(int isActive);

int getActive();

void setDrawAsRadio(int drawAsRadio);

int getDrawAsRadio();

}

Constructors

this this(GtkToggleAction* gtkToggleAction): Sets our main struct and passes it to the parent class
this this(string name, string label, string tooltip, StockID stockId): Creates a new GtkToggleAction object. To add the action to a GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). Since 2.4
this this(string name, string label, string tooltip, string stockId): Creates a new GtkToggleAction object. To add the action to a GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). Since 2.4

Members

Functions

addOnToggled void addOnToggled(void delegate(ToggleAction) dlg, ConnectFlags connectFlags)
getActive int getActive(): Returns the checked state of the toggle action. Since 2.4
getDrawAsRadio int getDrawAsRadio(): Returns whether the action should have proxies like a radio action. Since 2.4
getStruct void* getStruct(): the main Gtk struct as a void*
getToggleActionStruct GtkToggleAction* getToggleActionStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
setActive void setActive(int isActive): Sets the checked state on the toggle action. Since 2.4
setDrawAsRadio void setDrawAsRadio(int drawAsRadio): Sets whether the action should have proxies like a radio action. Since 2.4
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 toggle action. Since 2.4

Static functions

callBackToggled void callBackToggled(GtkToggleAction* toggleactionStruct, ToggleAction _toggleAction): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkToggleAction GtkToggleAction* gtkToggleAction;: the main Gtk struct
onToggledListeners void delegate(ToggleAction)[] onToggledListeners;: Undocumented in source.

Inherited Members

From Action

gtkAction GtkAction* gtkAction;: the main Gtk struct
getActionStruct GtkAction* getActionStruct(): 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 BuildableT!(GtkAction): Undocumented in source.
getStockId StockID getStockId(): Gets the stock id of action. Since 2.16
setStockId void setStockId(StockID stockId): Sets the stock id on action Since 2.16
createIcon Image createIcon(GtkIconSize iconSize): This function is intended for use by action implementations to create icons displayed in the proxy widgets. Since 2.4
createMenuItem MenuItem createMenuItem(): Creates a menu item widget that proxies for the given action. Since 2.4
createToolItem ToolItem createToolItem(): Creates a toolbar item widget that proxies for the given action. Since 2.4
createMenu Menu createMenu(): If action provides a GtkMenu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu. Since 2.12
connectedSignals int[string] connectedSignals;
onActivateListeners void delegate(Action)[] onActivateListeners;: Undocumented in source.
addOnActivate void addOnActivate(void delegate(Action) dlg, ConnectFlags connectFlags): The "activate" signal is emitted when the action is activated. Since 2.4 See Also GtkActionGroup, GtkUIManager
callBackActivate void callBackActivate(GtkAction* actionStruct, Action _action): Undocumented in source. Be warned that the author may not have intended to support it.
getName string getName(): Returns the name of the action. Since 2.4
isSensitive int isSensitive(): Returns whether the action is effectively sensitive. Since 2.4
getSensitive int getSensitive(): Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that. Since 2.4
setSensitive void setSensitive(int sensitive): Sets the ::sensitive property of the action to sensitive. Note that this doesn't necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that. Since 2.6
isVisible int isVisible(): Returns whether the action is effectively visible. Since 2.4
getVisible int getVisible(): Returns whether the action itself is visible. Note that this doesn't necessarily mean effective visibility. See gtk_action_is_sensitive() for that. Since 2.4
setVisible void setVisible(int visible): Sets the ::visible property of the action to visible. Note that this doesn't necessarily mean effective visibility. See gtk_action_is_visible() for that. Since 2.6
activate void activate(): Emits the "activate" signal on the specified action, if it isn't insensitive. This gets called by the proxy widgets when they get activated. It can also be used to manually activate an action. Since 2.4
connectProxy void connectProxy(Widget proxy): Warning gtk_action_connect_proxy has been deprecated since version 2.16 and should not be used in newly-written code. Use gtk_activatable_set_related_action() instead. Connects a widget to an action object as a proxy. Synchronises various properties of the action with the widget (such as label text, icon, tooltip, etc), and attaches a callback so that the action gets activated when the proxy widget does. If the widget is already connected to an action, it is disconnected first. Since 2.4
disconnectProxy void disconnectProxy(Widget proxy): Warning gtk_action_disconnect_proxy has been deprecated since version 2.16 and should not be used in newly-written code. Use gtk_activatable_set_related_action() instead. Disconnects a proxy widget from an action. Does not destroy the widget, however. Since 2.4
getProxies ListSG getProxies(): Returns the proxy widgets for an action. See also gtk_widget_get_action(). Since 2.4
connectAccelerator void connectAccelerator(): Installs the accelerator for action if action has an accel path and group. See gtk_action_set_accel_path() and gtk_action_set_accel_group() Since multiple proxies may independently trigger the installation of the accelerator, the action counts the number of times this function has been called and doesn't remove the accelerator until gtk_action_disconnect_accelerator() has been called as many times. Since 2.4
disconnectAccelerator void disconnectAccelerator(): Undoes the effect of one call to gtk_action_connect_accelerator(). Since 2.4
blockActivate void blockActivate(): Disable activation signals from the action This is needed when updating the state of your proxy GtkActivatable widget could result in calling gtk_action_activate(), this is a convenience function to avoid recursing in those cases (updating toggle state for instance). Since 2.16
unblockActivate void unblockActivate(): Reenable activation signals from the action Since 2.16
blockActivateFrom void blockActivateFrom(Widget proxy): Warning gtk_action_block_activate_from has been deprecated since version 2.16 and should not be used in newly-written code. activatables are now responsible for activating the action directly so this doesnt apply anymore. Disables calls to the gtk_action_activate() function by signals on the given proxy widget. This is used to break notification loops for things like check or radio actions. This function is intended for use by action implementations. Since 2.4
unblockActivateFrom void unblockActivateFrom(Widget proxy): Warning gtk_action_unblock_activate_from has been deprecated since version 2.16 and should not be used in newly-written code. activatables are now responsible for activating the action directly so this doesnt apply anymore. Re-enables calls to the gtk_action_activate() function by signals on the given proxy widget. This undoes the blocking done by gtk_action_block_activate_from(). This function is intended for use by action implementations. Since 2.4
getAlwaysShowImage int getAlwaysShowImage(): Returns whether action's menu item proxies will ignore the "gtk-menu-images" setting and always show their image, if available. Since 2.20
setAlwaysShowImage void setAlwaysShowImage(int alwaysShow): Sets whether action's menu item proxies will ignore the "gtk-menu-images" setting and always show their image, if available. Use this if the menu item would be useless or hard to use without their image. Since 2.20
getAccelPath string getAccelPath(): Returns the accel path for this action. Since 2.6
setAccelPath void setAccelPath(string accelPath): Sets the accel path for this action. All proxy widgets associated with the action will have this accel path, so that their accelerators are consistent. Note that accel_path string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string(). Since 2.4
getAccelClosure Closure getAccelClosure(): Returns the accel closure for this action. Since 2.8
setAccelGroup void setAccelGroup(AccelGroup accelGroup): Sets the GtkAccelGroup in which the accelerator for this action will be installed. Since 2.4
setLabel void setLabel(string label): Sets the label of action. Since 2.16
getLabel string getLabel(): Gets the label text of action. Since 2.16
setShortLabel void setShortLabel(string shortLabel): Sets a shorter label text on action. Since 2.16
getShortLabel string getShortLabel(): Gets the short label text of action. Since 2.16
setTooltip void setTooltip(string tooltip): Sets the tooltip text on action Since 2.16
getTooltip string getTooltip(): Gets the tooltip text of action. Since 2.16
setGicon void setGicon(IconIF icon): Sets the icon of action. Since 2.16
getGicon IconIF getGicon(): Gets the gicon of action. Since 2.16
setIconName void setIconName(string iconName): Sets the icon name on action Since 2.16
getIconName string getIconName(): Gets the icon name of action. Since 2.16
setVisibleHorizontal void setVisibleHorizontal(int visibleHorizontal): Sets whether action is visible when horizontal Since 2.16
getVisibleHorizontal int getVisibleHorizontal(): Checks whether action is visible when horizontal Since 2.16
setVisibleVertical void setVisibleVertical(int visibleVertical): Sets whether action is visible when vertical Since 2.16
getVisibleVertical int getVisibleVertical(): Checks whether action is visible when horizontal Since 2.16
setIsImportant void setIsImportant(int isImportant): Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not. Since 2.16
getIsImportant int getIsImportant(): Checks whether action is important or not Since 2.16

ToggleAction

Constructors

Members

Functions

Static functions

Variables

Inherited Members

From Action

Meta

Source