AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

[docs] Improve GtkAction documentation

Browse Source 
Simple GtkAction API docs update that makes it easier to understand
how action affects the appearance of proxy.

Signed-off-by: Javier Jardón <jjardon@gnome.org>
This commit is contained in:
Tadej Borovšak 2010-06-04 00:06:05 +02:00 committed by Javier Jardón
parent bb5c585777
commit 2c8e635a62
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gtk/gtkaction.c
View File

@ -32,7 +32,7 @@
* SECTION:gtkaction
* @Short_description: An action which can be triggered by a menu or toolbar item
* @Title: GtkAction
* @See_also: #GtkActionGroup, #GtkUIManager
* @See_also: #GtkActionGroup, #GtkUIManager, #GtkActivatable
*
* Actions represent operations that the user can be perform, along with
* some information how it should be presented in the interface. Each action
@ -60,11 +60,16 @@
* 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.
* 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.
*/
#include "config.h"