Commit b6a61425 authored by Tadej Borovšak's avatar Tadej Borovšak Committed by Javier Jardón

[docs] Move documentation to inline comments: GtkAction

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611952Signed-off-by: default avatarJavier Jardón <jjardon@gnome.org>
parent 6cdeb370
<!-- ##### SECTION Title ##### -->
GtkAction
<!-- ##### SECTION Short_Description ##### -->
An action which can be triggered by a menu or toolbar item
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
As well as the callback that is called when the action gets activated, the
following also gets associated with the action:
<itemizedlist>
<listitem><para>a name (not translated, for path lookup)</para></listitem>
<listitem><para>a label (translated, for display)</para></listitem>
<listitem><para>an accelerator</para></listitem>
<listitem><para>whether label indicates a stock id</para></listitem>
<listitem><para>a tooltip (optional, translated)</para></listitem>
<listitem><para>a toolbar label (optional, shorter than label)</para></listitem>
</itemizedlist>
The action will also have some state information:
<itemizedlist>
<listitem><para>visible (shown/hidden)</para></listitem>
<listitem><para>sensitive (enabled/disabled)</para></listitem>
</itemizedlist>
</para>
<para>
Apart from regular actions, there are <link linkend="GtkToggleAction">toggle
actions</link>, which can be toggled between two states and <link
linkend="GtkRadioAction">radio actions</link>, of which only one in a group
can be in the "active" state. Other actions can be implemented as #GtkAction
subclasses.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkActionGroup, #GtkUIManager
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkAction ##### -->
<para>
The <structname>GtkAction</structname> struct contains only private members
and should not be accessed directly.
</para>
<!-- ##### SIGNAL GtkAction::activate ##### -->
<para>
</para>
@action: the object which received the signal.
<!-- ##### ARG GtkAction:action-group ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:always-show-image ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:gicon ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:hide-if-empty ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:icon-name ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:is-important ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:label ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:name ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:sensitive ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:short-label ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:stock-id ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:tooltip ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:visible ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:visible-horizontal ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:visible-overflown ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:visible-vertical ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_action_new ##### -->
<para>
</para>
@name:
@label:
@tooltip:
@stock_id:
@Returns:
<!-- ##### FUNCTION gtk_action_get_name ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_is_sensitive ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_get_sensitive ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_sensitive ##### -->
<para>
</para>
@action:
@sensitive:
<!-- ##### FUNCTION gtk_action_is_visible ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_get_visible ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_visible ##### -->
<para>
</para>
@action:
@visible:
<!-- ##### FUNCTION gtk_action_activate ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION gtk_action_create_icon ##### -->
<para>
</para>
@action:
@icon_size:
@Returns:
<!-- ##### FUNCTION gtk_action_create_menu_item ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_create_tool_item ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_create_menu ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_connect_proxy ##### -->
<para>
</para>
@action:
@proxy:
<!-- ##### FUNCTION gtk_action_disconnect_proxy ##### -->
<para>
</para>
@action:
@proxy:
<!-- ##### FUNCTION gtk_action_get_proxies ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_connect_accelerator ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION gtk_action_disconnect_accelerator ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION gtk_action_block_activate ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION gtk_action_unblock_activate ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION gtk_action_block_activate_from ##### -->
<para>
</para>
@action:
@proxy:
<!-- ##### FUNCTION gtk_action_unblock_activate_from ##### -->
<para>
</para>
@action:
@proxy:
<!-- ##### FUNCTION gtk_action_get_always_show_image ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_always_show_image ##### -->
<para>
</para>
@action:
@always_show:
<!-- ##### FUNCTION gtk_action_get_accel_path ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_accel_path ##### -->
<para>
</para>
@action:
@accel_path:
<!-- ##### FUNCTION gtk_action_get_accel_closure ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_accel_group ##### -->
<para>
</para>
@action:
@accel_group:
<!-- ##### FUNCTION gtk_action_set_label ##### -->
<para>
</para>
@action:
@label:
<!-- ##### FUNCTION gtk_action_get_label ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_short_label ##### -->
<para>
</para>
@action:
@short_label:
<!-- ##### FUNCTION gtk_action_get_short_label ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_tooltip ##### -->
<para>
</para>
@action:
@tooltip:
<!-- ##### FUNCTION gtk_action_get_tooltip ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_stock_id ##### -->
<para>
</para>
@action:
@stock_id:
<!-- ##### FUNCTION gtk_action_get_stock_id ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_gicon ##### -->
<para>
</para>
@action:
@icon:
<!-- ##### FUNCTION gtk_action_get_gicon ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_icon_name ##### -->
<para>
</para>
@action:
@icon_name:
<!-- ##### FUNCTION gtk_action_get_icon_name ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_visible_horizontal ##### -->
<para>
</para>
@action:
@visible_horizontal:
<!-- ##### FUNCTION gtk_action_get_visible_horizontal ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_visible_vertical ##### -->
<para>
</para>
@action:
@visible_vertical:
<!-- ##### FUNCTION gtk_action_get_visible_vertical ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_action_set_is_important ##### -->
<para>
</para>
@action:
@is_important:
<!-- ##### FUNCTION gtk_action_get_is_important ##### -->
<para>
</para>
@action:
@Returns:
......@@ -28,6 +28,45 @@
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
/**
* SECTION:gtkaction
* @Short_description: An action which can be triggered by a menu or toolbar item
* @Title: GtkAction
* @See_also: #GtkActionGroup, #GtkUIManager
*
* 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:
* <itemizedlist>
* <listitem><para>a name (not translated, for path lookup)</para></listitem>
* <listitem><para>a label (translated, for display)</para></listitem>
* <listitem><para>an accelerator</para></listitem>
* <listitem><para>whether label indicates a stock id</para></listitem>
* <listitem><para>a tooltip (optional, translated)</para></listitem>
* <listitem><para>a toolbar label (optional, shorter than label)</para></listitem>
* </itemizedlist>
* The action will also have some state information:
* <itemizedlist>
* <listitem><para>visible (shown/hidden)</para></listitem>
* <listitem><para>sensitive (enabled/disabled)</para></listitem>
* </itemizedlist>
* Apart from regular actions, there are <link linkend="GtkToggleAction">toggle
* actions</link>, which can be toggled between two states and <link
* linkend="GtkRadioAction">radio actions</link>, 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 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.
*/
#include "config.h"
#include "gtkaction.h"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment