From 543b020fdcd9bf31b7501d24c24d38b3be41fe85 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 15 Sep 2003 22:21:26 +0000 Subject: [PATCH] Apply egtk-format-protos. Doc tweaks. * 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. --- ChangeLog | 6 ++ ChangeLog.pre-2-10 | 6 ++ ChangeLog.pre-2-4 | 6 ++ ChangeLog.pre-2-6 | 6 ++ ChangeLog.pre-2-8 | 6 ++ docs/reference/ChangeLog | 7 ++ docs/reference/gtk/tmpl/gtkaction.sgml | 5 + docs/reference/gtk/tmpl/gtkactiongroup.sgml | 108 ++++++++++++++------ docs/reference/gtk/tmpl/gtkradioaction.sgml | 2 +- docs/reference/gtk/tmpl/gtkuimanager.sgml | 21 ++-- gtk/gtkaction.h | 39 +++---- gtk/gtkuimanager.c | 13 +-- 12 files changed, 155 insertions(+), 70 deletions(-) diff --git a/ChangeLog b/ChangeLog index a4ddcf40ad..c4a2079127 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,11 @@ +2003-09-16 Matthias Clasen + + * gtk/gtkaction.h: Apply egtk-format-protos. + 2003-09-15 Matthias Clasen + * gtk/gtkuimanager.c: Doc tweaks. + Smart separators; see http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index a4ddcf40ad..c4a2079127 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,5 +1,11 @@ +2003-09-16 Matthias Clasen + + * gtk/gtkaction.h: Apply egtk-format-protos. + 2003-09-15 Matthias Clasen + * gtk/gtkuimanager.c: Doc tweaks. + Smart separators; see http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index a4ddcf40ad..c4a2079127 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,5 +1,11 @@ +2003-09-16 Matthias Clasen + + * gtk/gtkaction.h: Apply egtk-format-protos. + 2003-09-15 Matthias Clasen + * gtk/gtkuimanager.c: Doc tweaks. + Smart separators; see http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index a4ddcf40ad..c4a2079127 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,5 +1,11 @@ +2003-09-16 Matthias Clasen + + * gtk/gtkaction.h: Apply egtk-format-protos. + 2003-09-15 Matthias Clasen + * gtk/gtkuimanager.c: Doc tweaks. + Smart separators; see http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index a4ddcf40ad..c4a2079127 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,5 +1,11 @@ +2003-09-16 Matthias Clasen + + * gtk/gtkaction.h: Apply egtk-format-protos. + 2003-09-15 Matthias Clasen + * gtk/gtkuimanager.c: Doc tweaks. + Smart separators; see http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index a810a23007..06819cedc4 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,10 @@ +2003-09-16 Matthias Clasen + + * gtk/tmpl/gtkaction.sgml: + * gtk/tmpl/gtkradioaction.sgml: + * gtk/tmpl/gtkactiongroup.sgml: + * gtk/tmpl/gtkuimanager.sgml: Updates. + 2003-09-15 Matthias Clasen * gtk/tmpl/gtkuimanager.sgml: Add a paragraph about smart separators. diff --git a/docs/reference/gtk/tmpl/gtkaction.sgml b/docs/reference/gtk/tmpl/gtkaction.sgml index f900a26fd2..e01a7c773d 100644 --- a/docs/reference/gtk/tmpl/gtkaction.sgml +++ b/docs/reference/gtk/tmpl/gtkaction.sgml @@ -161,6 +161,11 @@ and should not be accessed directly. @action: the object which received the signal. + + + + + diff --git a/docs/reference/gtk/tmpl/gtkactiongroup.sgml b/docs/reference/gtk/tmpl/gtkactiongroup.sgml index e297254955..a96d738ba2 100644 --- a/docs/reference/gtk/tmpl/gtkactiongroup.sgml +++ b/docs/reference/gtk/tmpl/gtkactiongroup.sgml @@ -40,40 +40,6 @@ members and should not be accessed directly. - - -GtkActionEntry structs are used with -gtk_action_group_add_actions() to construct actions. - - -@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. - - - -GtkRadioActionEntry structs are used with -gtk_action_group_add_radio_actions() to construct radio actions. - - -@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(). - @@ -129,6 +95,22 @@ gtk_action_group_add_radio_actions() to construct radio actions. @action: + + +GtkActionEntry structs are used with +gtk_action_group_add_actions() to construct actions. + + +@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. + @@ -152,6 +134,62 @@ gtk_action_group_add_radio_actions() to construct radio actions. @destroy: + + +GtkToggleActionEntry structs are used with +gtk_action_group_add_toggle_actions() to construct toggle actions. + + +@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. + + + + + + +@action_group: +@entries: +@n_entries: +@user_data: + + + + + + + +@action_group: +@entries: +@n_entries: +@user_data: +@destroy: + + + + +GtkRadioActionEntry structs are used with +gtk_action_group_add_radio_actions() to construct groups of radio actions. + + +@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(). + @@ -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: diff --git a/docs/reference/gtk/tmpl/gtkradioaction.sgml b/docs/reference/gtk/tmpl/gtkradioaction.sgml index e1541b65d4..41dc3e67ae 100644 --- a/docs/reference/gtk/tmpl/gtkradioaction.sgml +++ b/docs/reference/gtk/tmpl/gtkradioaction.sgml @@ -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. - + diff --git a/docs/reference/gtk/tmpl/gtkuimanager.sgml b/docs/reference/gtk/tmpl/gtkuimanager.sgml index a34872a37e..c649055d29 100644 --- a/docs/reference/gtk/tmpl/gtkuimanager.sgml +++ b/docs/reference/gtk/tmpl/gtkuimanager.sgml @@ -269,18 +269,19 @@ members and should not be accessed directly. - +These enumeration values are used by gtk_ui_manager_add_ui() to determine +what UI element to create. -@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. diff --git a/gtk/gtkaction.h b/gtk/gtkaction.h index 7d8a402241..5e6c05bc49 100644 --- a/gtk/gtkaction.h +++ b/gtk/gtkaction.h @@ -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__ */ diff --git a/gtk/gtkuimanager.c b/gtk/gtkuimanager.c index 5a0538e918..c36beeeb25 100644 --- a/gtk/gtkuimanager.c +++ b/gtk/gtkuimanager.c @@ -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. <popup>) can be addressed by their XML element name - * (e.g. "popup"). The root element (<ui>) 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 UI description and - * merges it with the current contents of @self. An enclosing <ui> </ui> + * Parses a string containing a UI definition and + * merges it with the current contents of @self. An enclosing <ui> * 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 UI description and + * Parses a file containing a UI definition 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 description of the merged UI. + * Creates a UI definition of the merged UI. * * Return value: A newly allocated string containing an XML representation of * the merged UI.