Action

> In GTK+ 3.10, GtkAction has been deprecated. Use gtk.Action > instead, and associate actions with GtkActionable widgets. Use > gio.MenuModel for creating menus with 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 : ObjectG , BuildableIF {

protected

GtkAction* gtkAction;

GtkAction* getActionStruct(bool transferOwnership);

void* getStruct();

this(GtkAction* gtkAction, bool ownedRef);

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

StockID getStockId();

void setStockId(StockID stockId);

Image createIcon(GtkIconSize iconSize);

MenuItem createMenuItem();

ToolItem createToolItem();

Menu createMenu();

static GType getType();

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

void activate();

void blockActivate();

void connectAccelerator();

void disconnectAccelerator();

Closure getAccelClosure();

string getAccelPath();

bool getAlwaysShowImage();

IconIF getGicon();

string getIconName();

bool getIsImportant();

string getLabel();

string getName();

ListSG getProxies();

bool getSensitive();

string getShortLabel();

string getTooltip();

bool getVisible();

bool getVisibleHorizontal();

bool getVisibleVertical();

bool isSensitive();

bool isVisible();

void setAccelGroup(AccelGroup accelGroup);

void setAccelPath(string accelPath);

void setAlwaysShowImage(bool alwaysShow);

void setGicon(IconIF 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 addOnActivate(void delegate(Action) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkAction* gtkAction, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string name, string label, string tooltip, StockID stockId): Creates a new GtkAction object. To add the action to a GtkActionGroup and set the accelerator for the action, call Action.groupAddActionWithAccel. See the section called UI Definitions for information on allowed action names. Since 2.4
this this(string name, string label, string tooltip, string stockId): Creates a new gtk.Action object. To add the action to a gtk.ActionGroup and set the accelerator for the action, call Action.groupAddActionWithAccel. 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.
addOnActivate gulong addOnActivate(void delegate(Action) dlg, ConnectFlags connectFlags): The "activate" signal is emitted when the action is 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 Action.setAccelPath and Action.setAccelGroup
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
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
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
disconnectAccelerator void disconnectAccelerator(): Undoes the effect of one call to Action.connectAccelerator.
getAccelClosure Closure getAccelClosure(): Returns the accel closure for this action.
getAccelPath string getAccelPath(): Returns the accel path for this action.
getActionStruct GtkAction* getActionStruct(bool transferOwnership): Get the main Gtk struct
getAlwaysShowImage bool getAlwaysShowImage(): Returns whether action's menu item proxies will always show their image, if available.
getGicon IconIF 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 ListSG getProxies(): Returns the proxy widgets for an action. See also gtk_activatable_get_related_action().
getSensitive bool getSensitive(): Returns whether the action itself is sensitive. Note that this doesn’t necessarily mean effective sensitivity. See Action.isSensitive for that.
getShortLabel string getShortLabel(): Gets the short label text of action.
getStockId StockID getStockId(): Gets the stock id of action. Since 2.16
getStruct void* getStruct(): the main Gtk struct as a void*
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 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.
setAccelGroup void setAccelGroup(AccelGroup accelGroup): Sets the gtk.AccelGroup 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 gtk-menu-images setting and always show their image, if available.
setGicon void setGicon(IconIF 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 Action.isSensitive
for that.
setShortLabel void setShortLabel(string shortLabel): Sets a shorter label text on action.
setStockId void setStockId(StockID stockId): Sets the stock id on action Since 2.16
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 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

Static functions

getType GType getType()

Variables

gtkAction GtkAction* gtkAction;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
setProperty void setProperty(string propertyName, T value)
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, 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.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
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 g_object_ref_sink().
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 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 g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, 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(ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
ref_ ObjectG ref_(): Increases the reference count of object.
refSink ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
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.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
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(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() 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 g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(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 Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a GObject

From BuildableIF

getBuildableStruct GtkBuildable* getBuildableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
addChild void addChild(Builder builder, ObjectG child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild ObjectG constructChild(Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(Builder builder, ObjectG child, string tagname, void* data): This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.
customTagEnd
void customTagEnd(Builder builder, ObjectG child, string tagname, void** data): This is called at the end of each custom element handled by the buildable.
customTagStart bool customTagStart(Builder builder, ObjectG child, string tagname, GMarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild ObjectG getInternalChild(Builder builder, string childname): Get the internal child called childname of the buildable object.
buildableGetName string buildableGetName(): Gets the name of the buildable object.
parserFinished void parserFinished(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 Builder.addFromFile or Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(Builder builder, string name, Value value): Sets the property name name to value on the buildable object.
buildableSetName void buildableSetName(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 gtk.Action 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 sensitive and visible. gicon, icon-name, label, short-label and stock-id properties are only mirorred if proxy widget has use-action-appearance property set to TRUE.

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

gtk Action classes

Action