]> Pileus Git - ~andy/gtk/commitdiff
Apply egtk-format-protos. Doc tweaks.
authorMatthias Clasen <matthiasc@src.gnome.org>
Mon, 15 Sep 2003 22:21:26 +0000 (22:21 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Mon, 15 Sep 2003 22:21:26 +0000 (22:21 +0000)
* gtk/gtkaction.h: Apply egtk-format-protos.
* gtk/gtkuimanager.c: Doc tweaks.

* gtk/tmpl/gtkaction.sgml:
* gtk/tmpl/gtkradioaction.sgml:
* gtk/tmpl/gtkactiongroup.sgml:
* gtk/tmpl/gtkuimanager.sgml: Updates.

12 files changed:
ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/reference/ChangeLog
docs/reference/gtk/tmpl/gtkaction.sgml
docs/reference/gtk/tmpl/gtkactiongroup.sgml
docs/reference/gtk/tmpl/gtkradioaction.sgml
docs/reference/gtk/tmpl/gtkuimanager.sgml
gtk/gtkaction.h
gtk/gtkuimanager.c

index a4ddcf40ad1a2ecc81fecc7d080149b640e427d2..c4a2079127b1067dc8095e48a8c1b98d448df0be 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
+2003-09-16  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkaction.h: Apply egtk-format-protos.
+
 2003-09-15  Matthias Clasen  <maclas@gmx.de>
 
+       * gtk/gtkuimanager.c: Doc tweaks.
+
        Smart separators; see 
        http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:
        
index a4ddcf40ad1a2ecc81fecc7d080149b640e427d2..c4a2079127b1067dc8095e48a8c1b98d448df0be 100644 (file)
@@ -1,5 +1,11 @@
+2003-09-16  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkaction.h: Apply egtk-format-protos.
+
 2003-09-15  Matthias Clasen  <maclas@gmx.de>
 
+       * gtk/gtkuimanager.c: Doc tweaks.
+
        Smart separators; see 
        http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:
        
index a4ddcf40ad1a2ecc81fecc7d080149b640e427d2..c4a2079127b1067dc8095e48a8c1b98d448df0be 100644 (file)
@@ -1,5 +1,11 @@
+2003-09-16  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkaction.h: Apply egtk-format-protos.
+
 2003-09-15  Matthias Clasen  <maclas@gmx.de>
 
+       * gtk/gtkuimanager.c: Doc tweaks.
+
        Smart separators; see 
        http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:
        
index a4ddcf40ad1a2ecc81fecc7d080149b640e427d2..c4a2079127b1067dc8095e48a8c1b98d448df0be 100644 (file)
@@ -1,5 +1,11 @@
+2003-09-16  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkaction.h: Apply egtk-format-protos.
+
 2003-09-15  Matthias Clasen  <maclas@gmx.de>
 
+       * gtk/gtkuimanager.c: Doc tweaks.
+
        Smart separators; see 
        http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:
        
index a4ddcf40ad1a2ecc81fecc7d080149b640e427d2..c4a2079127b1067dc8095e48a8c1b98d448df0be 100644 (file)
@@ -1,5 +1,11 @@
+2003-09-16  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkaction.h: Apply egtk-format-protos.
+
 2003-09-15  Matthias Clasen  <maclas@gmx.de>
 
+       * gtk/gtkuimanager.c: Doc tweaks.
+
        Smart separators; see 
        http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:
        
index a810a23007d898cc82fc57e1442b029c7cb728ad..06819cedc4af0b28f2d8fd54c949d5cde139f9d6 100644 (file)
@@ -1,3 +1,10 @@
+2003-09-16  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/tmpl/gtkaction.sgml: 
+       * gtk/tmpl/gtkradioaction.sgml: 
+       * gtk/tmpl/gtkactiongroup.sgml: 
+       * gtk/tmpl/gtkuimanager.sgml: Updates.
+
 2003-09-15  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/tmpl/gtkuimanager.sgml: Add a paragraph about smart separators.
index f900a26fd221d3e70b54721fa40bb3c0e8b72c9e..e01a7c773d98792c0b6a3aac5561dfa831d798f5 100644 (file)
@@ -161,6 +161,11 @@ and should not be accessed directly.
 
 @action: the object which received the signal.
 
+<!-- ##### ARG GtkAction:is-important ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkAction:label ##### -->
 <para>
 
index e297254955ef8963db9ca59e10c0d9f455522615..a96d738ba21b04cf7bd701d6400e9cb2f5072e9a 100644 (file)
@@ -40,40 +40,6 @@ members and should not be accessed directly.
 </para>
 
 
-<!-- ##### STRUCT GtkActionEntry ##### -->
-<para>
-<structname>GtkActionEntry</structname> structs are used with 
-gtk_action_group_add_actions() to construct actions.
-</para>
-
-@name: The name of the action.
-@stock_id: The stock id for the action.
-@label: The label for the action. This field should typically be marked for 
-    translation, see gtk_action_group_set_translation_domain().
-@accelerator: The accelerator for the action, in the format understood by 
-    gtk_accelerator_parse().
-@tooltip: The tooltip for the action. This field should typically be marked 
-    for translation, see gtk_action_group_set_translation_domain().
-@callback: The function to call when the action is activated.
-@is_toggle: If this is %TRUE, a #GtkToggleAction is constructed, else a 
-    #GtkAction.
-
-<!-- ##### STRUCT GtkRadioActionEntry ##### -->
-<para>
-<structname>GtkRadioActionEntry</structname> structs are used with 
-gtk_action_group_add_radio_actions() to construct radio actions.
-</para>
-
-@name: The name of the action.
-@stock_id: The stock id for the action.
-@label: The label for the action. This field should typically be marked for 
-    translation, see gtk_action_group_set_translation_domain().
-@accelerator: The accelerator for the action, in the format understood by 
-    gtk_accelerator_parse().
-@tooltip: The tooltip for the action. This field should typically be marked for 
-    translation, see gtk_action_group_set_translation_domain().
-@value: The value to set on the radio action. See gtk_radio_action_get_current_value().
-
 <!-- ##### FUNCTION gtk_action_group_new ##### -->
 <para>
 
@@ -129,6 +95,22 @@ gtk_action_group_add_radio_actions() to construct radio actions.
 @action: 
 
 
+<!-- ##### STRUCT GtkActionEntry ##### -->
+<para>
+<structname>GtkActionEntry</structname> structs are used with 
+gtk_action_group_add_actions() to construct actions.
+</para>
+
+@name: The name of the action.
+@stock_id: The stock id for the action.
+@label: The label for the action. This field should typically be marked for 
+    translation, see gtk_action_group_set_translation_domain().
+@accelerator: The accelerator for the action, in the format understood by 
+    gtk_accelerator_parse().
+@tooltip: The tooltip for the action. This field should typically be marked 
+    for translation, see gtk_action_group_set_translation_domain().
+@callback: The function to call when the action is activated.
+
 <!-- ##### FUNCTION gtk_action_group_add_actions ##### -->
 <para>
 
@@ -152,6 +134,62 @@ gtk_action_group_add_radio_actions() to construct radio actions.
 @destroy: 
 
 
+<!-- ##### STRUCT GtkToggleActionEntry ##### -->
+<para>
+<structname>GtkToggleActionEntry</structname> structs are used with 
+gtk_action_group_add_toggle_actions() to construct toggle actions.
+</para>
+
+@name: The name of the action.
+@stock_id: The stock id for the action.
+@label: The label for the action. This field should typically be marked for 
+    translation, see gtk_action_group_set_translation_domain().
+@accelerator: The accelerator for the action, in the format understood by 
+    gtk_accelerator_parse().
+@tooltip: The tooltip for the action. This field should typically be marked 
+    for translation, see gtk_action_group_set_translation_domain().
+@callback: The function to call when the action is activated.
+@is_active: The initial state of the toggle action.
+
+<!-- ##### FUNCTION gtk_action_group_add_toggle_actions ##### -->
+<para>
+
+</para>
+
+@action_group: 
+@entries: 
+@n_entries: 
+@user_data: 
+
+
+<!-- ##### FUNCTION gtk_action_group_add_toggle_actions_full ##### -->
+<para>
+
+</para>
+
+@action_group: 
+@entries: 
+@n_entries: 
+@user_data: 
+@destroy: 
+
+
+<!-- ##### STRUCT GtkRadioActionEntry ##### -->
+<para>
+<structname>GtkRadioActionEntry</structname> structs are used with 
+gtk_action_group_add_radio_actions() to construct groups of radio actions.
+</para>
+
+@name: The name of the action.
+@stock_id: The stock id for the action.
+@label: The label for the action. This field should typically be marked for 
+    translation, see gtk_action_group_set_translation_domain().
+@accelerator: The accelerator for the action, in the format understood by 
+    gtk_accelerator_parse().
+@tooltip: The tooltip for the action. This field should typically be marked for 
+    translation, see gtk_action_group_set_translation_domain().
+@value: The value to set on the radio action. See gtk_radio_action_get_current_value().
+
 <!-- ##### FUNCTION gtk_action_group_add_radio_actions ##### -->
 <para>
 
@@ -160,6 +198,7 @@ gtk_action_group_add_radio_actions() to construct radio actions.
 @action_group: 
 @entries: 
 @n_entries: 
+@value: 
 @on_change: 
 @user_data: 
 
@@ -172,6 +211,7 @@ gtk_action_group_add_radio_actions() to construct radio actions.
 @action_group: 
 @entries: 
 @n_entries: 
+@value: 
 @on_change: 
 @user_data: 
 @destroy: 
index e1541b65d44db3a16f5eac32898d526927c50948..41dc3e67ae10bf6565ed4bf72f73b3243bc288c3 100644 (file)
@@ -9,7 +9,7 @@ an action of which only one in a group can be active
 A #GtkRadioAction is similar to #GtkRadioMenuItem. A number of radio
 actions can be linked together so that only one may be active at any 
 one time.
-</para>   
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
index a34872a37e24c1ad9ddbdb85af241fb1d8049252..c649055d29aef0bc83c66222e0e86cd2e02ea742 100644 (file)
@@ -269,18 +269,19 @@ members and should not be accessed directly.
 
 <!-- ##### ENUM GtkUIManagerItemType ##### -->
 <para>
-
+These enumeration values are used by gtk_ui_manager_add_ui() to determine
+what UI element to create.
 </para>
 
-@GTK_UI_MANAGER_AUTO: 
-@GTK_UI_MANAGER_MENUBAR: 
-@GTK_UI_MANAGER_MENU: 
-@GTK_UI_MANAGER_TOOLBAR: 
-@GTK_UI_MANAGER_PLACEHOLDER: 
-@GTK_UI_MANAGER_POPUP: 
-@GTK_UI_MANAGER_MENUITEM: 
-@GTK_UI_MANAGER_TOOLITEM: 
-@GTK_UI_MANAGER_SEPARATOR: 
+@GTK_UI_MANAGER_AUTO: Pick the type of the UI element according to context.
+@GTK_UI_MANAGER_MENUBAR: Create a menubar.
+@GTK_UI_MANAGER_MENU: Create a menu.
+@GTK_UI_MANAGER_TOOLBAR: Create a toolbar.
+@GTK_UI_MANAGER_PLACEHOLDER: Insert a placeholder.
+@GTK_UI_MANAGER_POPUP: Create a popup menu.
+@GTK_UI_MANAGER_MENUITEM: Create a menuitem.
+@GTK_UI_MANAGER_TOOLITEM: Create a toolitem.
+@GTK_UI_MANAGER_SEPARATOR: Create a separator.
 
 <!-- ##### FUNCTION gtk_ui_manager_add_ui ##### -->
 <para>
index 7d8a402241e65982319a79fa3942f66251fff1c0..5e6c05bc49feb510259e56148acd1f71dda27b9e 100644 (file)
@@ -78,30 +78,31 @@ struct _GtkActionClass
   void (*_gtk_reserved4) (void);
 };
 
-GType      gtk_action_get_type              (void);
+GType        gtk_action_get_type              (void);
+const gchar* gtk_action_get_name              (GtkAction   *action);
+void         gtk_action_activate              (GtkAction   *action);
+GtkWidget *  gtk_action_create_icon           (GtkAction   *action,
+                                              GtkIconSize  icon_size);
+GtkWidget *  gtk_action_create_menu_item      (GtkAction   *action);
+GtkWidget *  gtk_action_create_tool_item      (GtkAction   *action);
+void         gtk_action_connect_proxy         (GtkAction   *action,
+                                              GtkWidget   *proxy);
+void         gtk_action_disconnect_proxy      (GtkAction   *action,
+                                              GtkWidget   *proxy);
+GSList    *  gtk_action_get_proxies           (GtkAction   *action);
 
-const gchar* gtk_action_get_name            (GtkAction   *action);
-void       gtk_action_activate              (GtkAction   *action);
-
-GtkWidget *gtk_action_create_icon           (GtkAction   *action,
-                                            GtkIconSize  icon_size);
-GtkWidget *gtk_action_create_menu_item      (GtkAction   *action);
-GtkWidget *gtk_action_create_tool_item      (GtkAction   *action);
-void       gtk_action_connect_proxy         (GtkAction   *action,
-                                            GtkWidget   *proxy);
-void       gtk_action_disconnect_proxy      (GtkAction   *action,
-                                            GtkWidget   *proxy);
-GSList    *gtk_action_get_proxies           (GtkAction   *action);
 
 /* protected ... for use by child actions */
-void       gtk_action_block_activate_from   (GtkAction   *action,
-                                            GtkWidget   *proxy);
-void       gtk_action_unblock_activate_from (GtkAction   *action,
-                                            GtkWidget   *proxy);
+void         gtk_action_block_activate_from   (GtkAction   *action,
+                                              GtkWidget   *proxy);
+void         gtk_action_unblock_activate_from (GtkAction   *action,
+                                              GtkWidget   *proxy);
+
 
 /* protected ... for use by action groups */
-void       gtk_action_set_accel_path        (GtkAction   *action,
-                                            const gchar *accel_path);
+void         gtk_action_set_accel_path        (GtkAction   *action,
+                                              const gchar *accel_path);
+
 
 
 #endif  /* __GTK_ACTION_H__ */
index 5a0538e918f75695019fc1e0f2e55c93b1053fbf..c36beeeb25654001f173661386ff5a1dabdb3a31 100644 (file)
@@ -415,7 +415,8 @@ gtk_ui_manager_set_add_tearoffs (GtkUIManager *self,
  * @pos: the position at which the group will be inserted.
  * 
  * Inserts an action group into the list of action groups associated 
- * with @self.
+ * with @self. Actions in earlier groups hide actions with the same 
+ * name in later groups. 
  *
  * Since: 2.4
  **/
@@ -510,7 +511,7 @@ gtk_ui_manager_get_accel_group (GtkUIManager *self)
  * The path consists of the names specified in the XML description of the UI. 
  * separated by '/'. Elements which don't have a name or action attribute in 
  * the XML (e.g. &lt;popup&gt;) can be addressed by their XML element name 
- * (e.g. "popup"). The root element (&lt;ui&gt;) can be omitted in the path.
+ * (e.g. "popup"). The root element ("/ui") can be omitted in the path.
  * 
  * Return value: the widget found by following the path, or %NULL if no widget
  *   was found.
@@ -1154,8 +1155,8 @@ add_ui_from_string (GtkUIManager *self,
  * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
  * @error: return location for an error
  * 
- * Parses a string containing a <link linkend="XML-UI">UI description</link> and 
- * merges it with the current contents of @self. An enclosing &lt;ui&gt; &lt;/ui&gt;
+ * Parses a string containing a <link linkend="XML-UI">UI definition</link> and 
+ * merges it with the current contents of @self. An enclosing &lt;ui&gt; 
  * element is added if it is missing.
  * 
  * Return value: The merge id for the merged UI. The merge id can be used
@@ -1197,7 +1198,7 @@ gtk_ui_manager_add_ui_from_string (GtkUIManager *self,
  * @filename: the name of the file to parse 
  * @error: return location for an error
  * 
- * Parses a file containing a <link linkend="XML-UI">UI description</link> and 
+ * Parses a file containing a <link linkend="XML-UI">UI definition</link> and 
  * merges it with the current contents of @self. 
  * 
  * Return value: The merge id for the merged UI. The merge id can be used
@@ -2191,7 +2192,7 @@ print_node (GtkUIManager *self,
  * gtk_ui_manager_get_ui:
  * @self: a #GtkUIManager
  * 
- * Creates a <link linkend="XML-UI">description</link> of the merged UI.
+ * Creates a <link linkend="XML-UI">UI definition</link> of the merged UI.
  * 
  * Return value: A newly allocated string containing an XML representation of 
  * the merged UI.