ActionGroup

Actions are organised into groups. An action group is essentially a map from names to #GtkAction objects.

All actions that would make sense to use in a particular context should be in a single group. Multiple action groups may be used for a particular user interface. In fact, it is expected that most nontrivial applications will make use of multiple groups. For example, in an application that can edit multiple documents, one group holding global actions (e.g. quit, about, new), and one group per document holding actions that act on that document (eg. save, cut/copy/paste, etc). Each window’s menus would be constructed from a combination of two action groups.

Accelerators ## {#Action-Accel}

Accelerators are handled by the GTK+ accelerator map. All actions are assigned an accelerator path (which normally has the form <Actions>/group-name/action-name) and a shortcut is associated with this accelerator path. All menuitems and toolitems take on this accelerator path. The GTK+ accelerator map code makes sure that the correct shortcut is displayed next to the menu item.

GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI}

The #GtkActionGroup implementation of the #GtkBuildable interface accepts #GtkAction objects as <child> elements in UI definitions.

Note that it is probably more common to define actions and action groups in the code, since they are directly related to what the code can do.

The GtkActionGroup implementation of the GtkBuildable interface supports a custom <accelerator> element, which has attributes named “key“ and “modifiers“ and allows to specify accelerators. This is similar to the <accelerator> element of #GtkWidget, the main difference is that it doesn’t allow you to specify a signal.

A #GtkDialog UI definition fragment. ##

<object class="GtkActionGroup" id="actiongroup">
  <child>
      <object class="GtkAction" id="About">
          <property name="name">About</property>
          <property name="stock_id">gtk-about</property>
          <signal handler="about_activate" name="activate"/>
      </object>
      <accelerator key="F1" modifiers="GDK_CONTROL_MASK | GDK_SHIFT_MASK"/>
  </child>
</object>

class ActionGroup : ObjectWrap , Buildable {

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

static GType _getGType();

GType _gType [@property getter];

ActionGroup self();

static ActionGroupGidBuilder builder();

gtk.accel_group.AccelGroup accelGroup [@property getter];

gtk.accel_group.AccelGroup accelGroup [@property setter];

string name [@property getter];

bool sensitive [@property getter];

bool sensitive [@property setter];

bool visible [@property getter];

bool visible [@property setter];

this(string name);

void addAction(gtk.action.Action action);

void addActionWithAccel(gtk.action.Action action, string accelerator);

gtk.accel_group.AccelGroup getAccelGroup();

gtk.action.Action getAction(string actionName);

string getName();

bool getSensitive();

bool getVisible();

gtk.action.Action[] listActions();

void removeAction(gtk.action.Action action);

void setAccelGroup(gtk.accel_group.AccelGroup accelGroup);

void setSensitive(bool sensitive);

void setTranslateFunc(gtk.types.TranslateFunc func);

void setTranslationDomain(string domain);

void setVisible(bool visible);

string translateString(string string_);

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

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

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

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

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(string name): Creates a new #GtkActionGroup object. The name of the action group is used when associating keybindings[Action-Accel] with the actions.

Members

Functions

addAction void addAction(gtk.action.Action action): Adds an action object to the action group. Note that this function does not set up the accel path of the action, which can lead to problems if a user tries to modify the accelerator of a menuitem associated with the action. Therefore you must either set the accel path yourself with gtk.action.Action.setAccelPath, or use gtk_action_group_add_action_with_accel (..., NULL).
addActionWithAccel void addActionWithAccel(gtk.action.Action action, string accelerator): Adds an action object to the action group and sets up the accelerator.
connectConnectProxy gulong connectConnectProxy(T callback, Flag!"After" after): Connect to ConnectProxy signal.
connectDisconnectProxy gulong connectDisconnectProxy(T callback, Flag!"After" after): Connect to DisconnectProxy signal.
connectPostActivate gulong connectPostActivate(T callback, Flag!"After" after): Connect to PostActivate signal.
connectPreActivate gulong connectPreActivate(T callback, Flag!"After" after): Connect to PreActivate signal.
getAccelGroup gtk.accel_group.AccelGroup getAccelGroup(): Gets the accelerator group.
getAction gtk.action.Action getAction(string actionName): Looks up an action in the action group by name.
getName string getName(): Gets the name of the action group.
getSensitive bool getSensitive(): Returns true if the group is sensitive. The constituent actions can only be logically sensitive (see gtk.action.Action.isSensitive) if they are sensitive (see gtk.action.Action.getSensitive) and their group is sensitive.
getVisible bool getVisible(): Returns true if the group is visible. The constituent actions can only be logically visible (see gtk.action.Action.isVisible) if they are visible (see gtk.action.Action.getVisible) and their group is visible.
listActions gtk.action.Action[] listActions(): Lists the actions in the action group.
removeAction void removeAction(gtk.action.Action action): Removes an action object from the action group.
self ActionGroup self(): Returns this, for use in with statements.
setAccelGroup void setAccelGroup(gtk.accel_group.AccelGroup accelGroup): Sets the accelerator group to be used by every action in this group.
setSensitive void setSensitive(bool sensitive): Changes the sensitivity of action_group
setTranslateFunc void setTranslateFunc(gtk.types.TranslateFunc func): Sets a function to be used for translating the label and tooltip of #GtkActionEntrys added by gtk.action_group.ActionGroup.addActions.
setTranslationDomain void setTranslationDomain(string domain): Sets the translation domain and uses glib.global.dgettext for translating the label and tooltip of #GtkActionEntrys added by gtk.action_group.ActionGroup.addActions.
setVisible void setVisible(bool visible): Changes the visible of action_group.
translateString string translateString(string string_): Translates a string using the function set with gtk.action_group.ActionGroup.setTranslateFunc. This is mainly intended for language bindings.

Properties

_gType GType _gType [@property getter]
accelGroup gtk.accel_group.AccelGroup accelGroup [@property getter]: Get accelGroup property.
accelGroup gtk.accel_group.AccelGroup accelGroup [@property setter]: Set accelGroup 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.
visible bool visible [@property getter]: Get visible property.
visible bool visible [@property setter]: Set visible property.

Static functions

_getGType GType _getGType()
builder ActionGroupGidBuilder builder(): Get builder for gtk.action_group.ActionGroup

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.

gtk action_group classes

ActionGroup

GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI}

From mixin BuildableT!()

From `mixin BuildableT!()`