An action which can be triggered by a menu or toolbar item.
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)
The action will also have some state information:
visible (shown/hidden)
sensitive (enabled/disabled)
Apart from regular actions, there are
ToggleAction
, which can be toggled
between two states and
RadioAction
, of which only one in a group can be in
the "active" state. Other actions can be implemented as
Action
subclasses.
Each action can have one or more proxy menu item, toolbar button or other proxy
widgets. Proxies mirror the state of the action (text label, tooltip, icon, visible,
sensitive, etc), and should change when the action's state changes. When the proxy
is activated, it should activate its action.
activate
public 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.
connectAccelerator
public void connectAccelerator()
Installs the accelerator for action if action has an accel path and 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
disconnectAccelerator()
has been called as many times.
connectProxy
public void connectProxy(Widget proxy)
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.
proxy
- the proxy widget
createIcon
public Widget createIcon(IconSize iconSize)
This function is intended for use by action implementations to create icons
displayed in the proxy widgets.
iconSize
- the size of the icon that should be created
- a widget that displays the icon for this action
createMenuItem
public Widget createMenuItem()
Creates a menu item widget that proxies for the given action.
- a menu item connected to the action
createToolItem
public Widget createToolItem()
Creates a toolbar item widget that proxies for the given action.
- a toolbar item connected to the action
disconnectAccelerator
public void disconnectAccelerator()
disconnectProxy
public void disconnectProxy(Widget proxy)
Disconnects a proxy widget from an action. Does not destroy the widget, however.
proxy
- the proxy widget
getAcceleratorPath
public String getAcceleratorPath()
getName
public String getName()
Returns the name of the action.
- the name of the action
getProxies
public List getProxies()
Returns the proxy widgets for an action.
- a List of proxy widgets
getType
public static Type getType()
Retrieve the runtime type used by the GLib library.
gtk_action_activate
protected static final void gtk_action_activate(Handle action)
gtk_action_connect_accelerator
protected static final void gtk_action_connect_accelerator(Handle action)
gtk_action_connect_proxy
protected static final void gtk_action_connect_proxy(Handle action,
Handle proxy)
gtk_action_create_icon
protected static final Handle gtk_action_create_icon(Handle action,
int iconSize)
gtk_action_create_menu_item
protected static final Handle gtk_action_create_menu_item(Handle action)
gtk_action_create_tool_item
protected static final Handle gtk_action_create_tool_item(Handle action)
gtk_action_disconnect_accelerator
protected static final void gtk_action_disconnect_accelerator(Handle action)
gtk_action_disconnect_proxy
protected static final void gtk_action_disconnect_proxy(Handle action,
Handle proxy)
gtk_action_get_accel_path
protected static final String gtk_action_get_accel_path(Handle action)
gtk_action_get_name
protected static final String gtk_action_get_name(Handle action)
gtk_action_get_proxies
protected static final Handle[] gtk_action_get_proxies(Handle action)
gtk_action_get_sensitive
protected static final boolean gtk_action_get_sensitive(Handle action)
gtk_action_get_type
protected static final int gtk_action_get_type()
gtk_action_get_visible
protected static final boolean gtk_action_get_visible(Handle action)
gtk_action_is_sensitive
protected static final boolean gtk_action_is_sensitive(Handle action)
gtk_action_is_visible
protected static final boolean gtk_action_is_visible(Handle action)
gtk_action_new
protected static final Handle gtk_action_new(String name,
String label,
String tooltip,
String stockId)
gtk_action_set_sensitive
protected static final void gtk_action_set_sensitive(Handle action,
boolean sensitive)
gtk_action_set_visible
protected static final void gtk_action_set_visible(Handle action,
boolean visible)
isSensitive
public boolean isSensitive()
isVisible
public boolean isVisible()
setSensitive
public void setSensitive(boolean sensitive)
setVisible
public void setVisible(boolean visible)