Action

> In GTK+ 3.10, GtkAction has been deprecated. Use #GAction > instead, and associate actions with #GtkActionable widgets. Use > #GMenuModel for creating menus with gtk.menu.Menu.newFromModel.

Actions represent operations that the user can be perform, along with some information how it should be presented in the interface. Each action provides methods to create icons, menu items and toolbar items representing itself.

As well as the callback that is called when the action gets activated, the following also gets associated with the action:

a name (not translated, for path lookup)
a label (translated, for display)
an accelerator
whether label indicates a stock id
a tooltip (optional, translated)
a toolbar label (optional, shorter than label)

More...

class Action : ObjectWrap , Buildable {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

Action self();

static ActionGidBuilder builder();

gtk.action_group.ActionGroup actionGroup [@property getter];

gtk.action_group.ActionGroup actionGroup [@property setter];

bool alwaysShowImage [@property getter];

bool alwaysShowImage [@property setter];

gio.icon.Icon gicon [@property getter];

gio.icon.Icon gicon [@property setter];

bool hideIfEmpty [@property getter];

bool hideIfEmpty [@property setter];

string iconName [@property getter];

string iconName [@property setter];

bool isImportant [@property getter];

bool isImportant [@property setter];

string label [@property getter];

string label [@property setter];

string name [@property getter];

bool sensitive [@property getter];

bool sensitive [@property setter];

string shortLabel [@property getter];

string shortLabel [@property setter];

string stockId [@property getter];

string stockId [@property setter];

string tooltip [@property getter];

string tooltip [@property setter];

bool visible [@property getter];

bool visible [@property setter];

bool visibleHorizontal [@property getter];

bool visibleHorizontal [@property setter];

bool visibleOverflown [@property getter];

bool visibleOverflown [@property setter];

bool visibleVertical [@property getter];

bool visibleVertical [@property setter];

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

void activate();

void blockActivate();

void connectAccelerator();

gtk.widget.Widget createIcon(gtk.types.IconSize iconSize);

gtk.widget.Widget createMenu();

gtk.widget.Widget createMenuItem();

gtk.widget.Widget createToolItem();

void disconnectAccelerator();

gobject.closure.Closure getAccelClosure();

string getAccelPath();

bool getAlwaysShowImage();

gio.icon.Icon getGicon();

string getIconName();

bool getIsImportant();

string getLabel();

string getName();

gtk.widget.Widget[] getProxies();

bool getSensitive();

string getShortLabel();

string getStockId();

string getTooltip();

bool getVisible();

bool getVisibleHorizontal();

bool getVisibleVertical();

bool isSensitive();

bool isVisible();

void setAccelGroup(gtk.accel_group.AccelGroup accelGroup);

void setAccelPath(string accelPath);

void setAlwaysShowImage(bool alwaysShow);

void setGicon(gio.icon.Icon icon);

void setIconName(string iconName);

void setIsImportant(bool isImportant);

void setLabel(string label);

void setSensitive(bool sensitive);

void setShortLabel(string shortLabel);

void setStockId(string stockId);

void setTooltip(string tooltip);

void setVisible(bool visible);

void setVisibleHorizontal(bool visibleHorizontal);

void setVisibleVertical(bool visibleVertical);

void unblockActivate();

gulong connectActivate(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(string name, string label, string tooltip, string stockId): Creates a new #GtkAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk.action_group.ActionGroup.addActionWithAccel. See the [UI Definition section][XML-UI] for information on allowed action names.

Members

Functions

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.
blockActivate void blockActivate(): Disable activation signals from the action
connectAccelerator void connectAccelerator(): Installs the accelerator for action if action has an accel path and group. See gtk.action.Action.setAccelPath and gtk.action.Action.setAccelGroup
connectActivate gulong connectActivate(T callback, Flag!"After" after): Connect to Activate signal.
createIcon gtk.widget.Widget createIcon(gtk.types.IconSize iconSize): This function is intended for use by action implementations to create icons displayed in the proxy widgets.
createMenu gtk.widget.Widget 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.
createMenuItem gtk.widget.Widget createMenuItem(): Creates a menu item widget that proxies for the given action.
createToolItem gtk.widget.Widget createToolItem(): Creates a toolbar item widget that proxies for the given action.
disconnectAccelerator void disconnectAccelerator(): Undoes the effect of one call to gtk.action.Action.connectAccelerator.
getAccelClosure gobject.closure.Closure getAccelClosure(): Returns the accel closure for this action.
getAccelPath string getAccelPath(): Returns the accel path for this action.
getAlwaysShowImage bool getAlwaysShowImage(): Returns whether action's menu item proxies will always show their image, if available.
getGicon gio.icon.Icon getGicon(): Gets the gicon of action.
getIconName string getIconName(): Gets the icon name of action.
getIsImportant bool getIsImportant(): Checks whether action is important or not
getLabel string getLabel(): Gets the label text of action.
getName string getName(): Returns the name of the action.
getProxies gtk.widget.Widget[] getProxies(): Returns the proxy widgets for an action. See also gtk.activatable.Activatable.getRelatedAction.
getSensitive bool getSensitive(): Returns whether the action itself is sensitive. Note that this doesn’t necessarily mean effective sensitivity. See gtk.action.Action.isSensitive for that.
getShortLabel string getShortLabel(): Gets the short label text of action.
getStockId string getStockId(): Gets the stock id of action.
getTooltip string getTooltip(): Gets the tooltip text of action.
getVisible bool getVisible(): Returns whether the action itself is visible. Note that this doesn’t necessarily mean effective visibility. See gtk.action.Action.isSensitive for that.
getVisibleHorizontal bool getVisibleHorizontal(): Checks whether action is visible when horizontal
getVisibleVertical bool getVisibleVertical(): Checks whether action is visible when horizontal
isSensitive bool isSensitive(): Returns whether the action is effectively sensitive.
isVisible bool isVisible(): Returns whether the action is effectively visible.
self Action self(): Returns this, for use in with statements.
setAccelGroup void setAccelGroup(gtk.accel_group.AccelGroup accelGroup): Sets the #GtkAccelGroup in which the accelerator for this action will be installed.
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.
setAlwaysShowImage void setAlwaysShowImage(bool alwaysShow): Sets whether action's menu item proxies will ignore the #GtkSettings:gtk-menu-images setting and always show their image, if available.
setGicon void setGicon(gio.icon.Icon icon): Sets the icon of action.
setIconName void setIconName(string iconName): Sets the icon name on action
setIsImportant void setIsImportant(bool isImportant): Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not.
setLabel void setLabel(string label): Sets the label of action.
setSensitive void setSensitive(bool sensitive): Sets the :sensitive property of the action to sensitive. Note that this doesn’t necessarily mean effective sensitivity. See gtk.action.Action.isSensitive
for that.
setShortLabel void setShortLabel(string shortLabel): Sets a shorter label text on action.
setStockId void setStockId(string stockId): Sets the stock id on action
setTooltip void setTooltip(string tooltip): Sets the tooltip text on action
setVisible void setVisible(bool visible): Sets the :visible property of the action to visible. Note that this doesn’t necessarily mean effective visibility. See gtk.action.Action.isVisible
for that.
setVisibleHorizontal void setVisibleHorizontal(bool visibleHorizontal): Sets whether action is visible when horizontal
setVisibleVertical void setVisibleVertical(bool visibleVertical): Sets whether action is visible when vertical
unblockActivate void unblockActivate(): Reenable activation signals from the action

Properties

_gType GType _gType [@property getter]
actionGroup gtk.action_group.ActionGroup actionGroup [@property getter]: Get actionGroup property.
actionGroup gtk.action_group.ActionGroup actionGroup [@property setter]: Set actionGroup property.
alwaysShowImage bool alwaysShowImage [@property getter]: Get alwaysShowImage property.
alwaysShowImage bool alwaysShowImage [@property setter]: Set alwaysShowImage property.
gicon gio.icon.Icon gicon [@property getter]: Get gicon property.
gicon gio.icon.Icon gicon [@property setter]: Set gicon property.
hideIfEmpty bool hideIfEmpty [@property getter]: Get hideIfEmpty property.
hideIfEmpty bool hideIfEmpty [@property setter]: Set hideIfEmpty property.
iconName string iconName [@property getter]: Get iconName property.
iconName string iconName [@property setter]: Set iconName property.
isImportant bool isImportant [@property getter]: Get isImportant property.
isImportant bool isImportant [@property setter]: Set isImportant property.
label string label [@property getter]: Get label property.
label string label [@property setter]: Set label property.
name string name [@property getter]: Get name property.
sensitive bool sensitive [@property getter]: Get sensitive property.
sensitive bool sensitive [@property setter]: Set sensitive property.
shortLabel string shortLabel [@property getter]: Get shortLabel property.
shortLabel string shortLabel [@property setter]: Set shortLabel property.
stockId string stockId [@property getter]: Get stockId property.
stockId string stockId [@property setter]: Set stockId property.
tooltip string tooltip [@property getter]: Get tooltip property.
tooltip string tooltip [@property setter]: Set tooltip property.
visible bool visible [@property getter]: Get visible property.
visible bool visible [@property setter]: Set visible property.
visibleHorizontal bool visibleHorizontal [@property getter]: Get visibleHorizontal property.
visibleHorizontal bool visibleHorizontal [@property setter]: Set visibleHorizontal property.
visibleOverflown bool visibleOverflown [@property getter]: Get visibleOverflown property.
visibleOverflown bool visibleOverflown [@property setter]: Set visibleOverflown property.
visibleVertical bool visibleVertical [@property getter]: Get visibleVertical property.
visibleVertical bool visibleVertical [@property setter]: Set visibleVertical property.

Static functions

_getGType GType _getGType()
builder ActionGidBuilder builder(): Get builder for gtk.action.Action

Mixed In Members

From `mixin BuildableT!()`

addChild void addChild(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild gobject.object.ObjectWrap constructChild(gtk.builder.Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, void* data): This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
customTagStart bool customTagStart(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, glib.types.MarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild gobject.object.ObjectWrap getInternalChild(gtk.builder.Builder builder, string childname): Get the internal child called childname of the buildable object.
getName string getName(): Gets the name of the buildable object.
parserFinished void parserFinished(gtk.builder.Builder builder): Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(gtk.builder.Builder builder, string name, gobject.value.Value value): Sets the property name name to value on the buildable object.
setName void setName(string name): Sets the name of the buildable object.

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap wrapper.
_cPtr void* _cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
_ref void* _ref(void* gObj): Calls g_object_ref() on a GObject.
_unref _unref(void* gObj): Calls g_object_unref() on a GObject.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap self(): Convenience method to return this cast to a type. For use in D with statements.
_getDObject T _getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectWrap refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

From Buildable

_getGType GType _getGType()
addChild void addChild(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild gobject.object.ObjectWrap constructChild(gtk.builder.Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, void* data): This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
customTagStart bool customTagStart(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, glib.types.MarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild gobject.object.ObjectWrap getInternalChild(gtk.builder.Builder builder, string childname): Get the internal child called childname of the buildable object.
getName string getName(): Gets the name of the buildable object.
parserFinished void parserFinished(gtk.builder.Builder builder): Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(gtk.builder.Builder builder, string name, gobject.value.Value value): Sets the property name name to value on the buildable object.
setName void setName(string name): Sets the name of the buildable object.

Detailed Description

The action will also have some state information:

visible (shown/hidden)
sensitive (enabled/disabled)

Apart from regular actions, there are [toggle actions]GtkToggleAction, which can be toggled between two states and [radio actions]GtkRadioAction, of which only one in a group can be in the “active” state. Other actions can be implemented as #GtkAction subclasses.

Each action can have one or more proxy widgets. To act as an action proxy, widget needs to implement #GtkActivatable interface. Proxies mirror the state of the action and should change when the action’s state changes. Properties that are always mirrored by proxies are #GtkAction:sensitive and #GtkAction:visible. #GtkAction:gicon, #GtkAction:icon-name, #GtkAction:label, #GtkAction:short-label and #GtkAction:stock-id properties are only mirorred if proxy widget has #GtkActivatable:use-action-appearance property set to true.

When the proxy is activated, it should activate its action.

gtk action classes

Action

From mixin BuildableT!()

From `mixin BuildableT!()`