[gtk+] [docs] Improve GtkAction documentation
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] [docs] Improve GtkAction documentation
- Date: Thu, 3 Jun 2010 22:07:39 +0000 (UTC)
commit 2c8e635a6276ea5a7f031e4d53838866d8c26428
Author: Tadej Borovšak <tadeboro gmail com>
Date: Fri Jun 4 00:06:05 2010 +0200
[docs] Improve GtkAction documentation
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>
gtk/gtkaction.c | 17 +++++++++++------
1 files changed, 11 insertions(+), 6 deletions(-)
---
diff --git a/gtk/gtkaction.c b/gtk/gtkaction.c
index 4425696..d9440d3 100644
--- a/gtk/gtkaction.c
+++ b/gtk/gtkaction.c
@@ -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"
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]