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.
This commit is contained in:
Matthias Clasen 2003-09-15 22:21:26 +00:00
parent 405f24c9e6
commit 543b020fdc
12 changed files with 155 additions and 70 deletions

View 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> 2003-09-15 Matthias Clasen <maclas@gmx.de>
* gtk/gtkuimanager.c: Doc tweaks.
Smart separators; see Smart separators; see
http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:

View 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> 2003-09-15 Matthias Clasen <maclas@gmx.de>
* gtk/gtkuimanager.c: Doc tweaks.
Smart separators; see Smart separators; see
http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:

View 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> 2003-09-15 Matthias Clasen <maclas@gmx.de>
* gtk/gtkuimanager.c: Doc tweaks.
Smart separators; see Smart separators; see
http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:

View 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> 2003-09-15 Matthias Clasen <maclas@gmx.de>
* gtk/gtkuimanager.c: Doc tweaks.
Smart separators; see Smart separators; see
http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:

View 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> 2003-09-15 Matthias Clasen <maclas@gmx.de>
* gtk/gtkuimanager.c: Doc tweaks.
Smart separators; see Smart separators; see
http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html: http://mail.gnome.org/archives/gtk-devel-list/2003-September/msg00133.html:

View 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> 2003-09-15 Matthias Clasen <maclas@gmx.de>
* gtk/tmpl/gtkuimanager.sgml: Add a paragraph about smart separators. * gtk/tmpl/gtkuimanager.sgml: Add a paragraph about smart separators.

View File

@ -161,6 +161,11 @@ and should not be accessed directly.
@action: the object which received the signal. @action: the object which received the signal.
<!-- ##### ARG GtkAction:is-important ##### -->
<para>
</para>
<!-- ##### ARG GtkAction:label ##### --> <!-- ##### ARG GtkAction:label ##### -->
<para> <para>

View File

@ -40,40 +40,6 @@ members and should not be accessed directly.
</para> </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 ##### --> <!-- ##### FUNCTION gtk_action_group_new ##### -->
<para> <para>
@ -129,6 +95,22 @@ gtk_action_group_add_radio_actions() to construct radio actions.
@action: @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 ##### --> <!-- ##### FUNCTION gtk_action_group_add_actions ##### -->
<para> <para>
@ -152,6 +134,62 @@ gtk_action_group_add_radio_actions() to construct radio actions.
@destroy: @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 ##### --> <!-- ##### FUNCTION gtk_action_group_add_radio_actions ##### -->
<para> <para>
@ -160,6 +198,7 @@ gtk_action_group_add_radio_actions() to construct radio actions.
@action_group: @action_group:
@entries: @entries:
@n_entries: @n_entries:
@value:
@on_change: @on_change:
@user_data: @user_data:
@ -172,6 +211,7 @@ gtk_action_group_add_radio_actions() to construct radio actions.
@action_group: @action_group:
@entries: @entries:
@n_entries: @n_entries:
@value:
@on_change: @on_change:
@user_data: @user_data:
@destroy: @destroy:

View 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 A #GtkRadioAction is similar to #GtkRadioMenuItem. A number of radio
actions can be linked together so that only one may be active at any actions can be linked together so that only one may be active at any
one time. one time.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>

View File

@ -269,18 +269,19 @@ members and should not be accessed directly.
<!-- ##### ENUM GtkUIManagerItemType ##### --> <!-- ##### ENUM GtkUIManagerItemType ##### -->
<para> <para>
These enumeration values are used by gtk_ui_manager_add_ui() to determine
what UI element to create.
</para> </para>
@GTK_UI_MANAGER_AUTO: @GTK_UI_MANAGER_AUTO: Pick the type of the UI element according to context.
@GTK_UI_MANAGER_MENUBAR: @GTK_UI_MANAGER_MENUBAR: Create a menubar.
@GTK_UI_MANAGER_MENU: @GTK_UI_MANAGER_MENU: Create a menu.
@GTK_UI_MANAGER_TOOLBAR: @GTK_UI_MANAGER_TOOLBAR: Create a toolbar.
@GTK_UI_MANAGER_PLACEHOLDER: @GTK_UI_MANAGER_PLACEHOLDER: Insert a placeholder.
@GTK_UI_MANAGER_POPUP: @GTK_UI_MANAGER_POPUP: Create a popup menu.
@GTK_UI_MANAGER_MENUITEM: @GTK_UI_MANAGER_MENUITEM: Create a menuitem.
@GTK_UI_MANAGER_TOOLITEM: @GTK_UI_MANAGER_TOOLITEM: Create a toolitem.
@GTK_UI_MANAGER_SEPARATOR: @GTK_UI_MANAGER_SEPARATOR: Create a separator.
<!-- ##### FUNCTION gtk_ui_manager_add_ui ##### --> <!-- ##### FUNCTION gtk_ui_manager_add_ui ##### -->
<para> <para>

View File

@ -78,30 +78,31 @@ struct _GtkActionClass
void (*_gtk_reserved4) (void); 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 */ /* protected ... for use by child actions */
void gtk_action_block_activate_from (GtkAction *action, void gtk_action_block_activate_from (GtkAction *action,
GtkWidget *proxy); GtkWidget *proxy);
void gtk_action_unblock_activate_from (GtkAction *action, void gtk_action_unblock_activate_from (GtkAction *action,
GtkWidget *proxy); GtkWidget *proxy);
/* protected ... for use by action groups */ /* protected ... for use by action groups */
void gtk_action_set_accel_path (GtkAction *action, void gtk_action_set_accel_path (GtkAction *action,
const gchar *accel_path); const gchar *accel_path);
#endif /* __GTK_ACTION_H__ */ #endif /* __GTK_ACTION_H__ */

View File

@ -415,7 +415,8 @@ gtk_ui_manager_set_add_tearoffs (GtkUIManager *self,
* @pos: the position at which the group will be inserted. * @pos: the position at which the group will be inserted.
* *
* Inserts an action group into the list of action groups associated * 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 * 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. * 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 * 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 * 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 * Return value: the widget found by following the path, or %NULL if no widget
* was found. * 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) * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @error: return location for an error * @error: return location for an error
* *
* Parses a string containing a <link linkend="XML-UI">UI description</link> and * 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; &lt;/ui&gt; * merges it with the current contents of @self. An enclosing &lt;ui&gt;
* element is added if it is missing. * element is added if it is missing.
* *
* Return value: The merge id for the merged UI. The merge id can be used * 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 * @filename: the name of the file to parse
* @error: return location for an error * @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. * merges it with the current contents of @self.
* *
* Return value: The merge id for the merged UI. The merge id can be used * 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: * gtk_ui_manager_get_ui:
* @self: a #GtkUIManager * @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 * Return value: A newly allocated string containing an XML representation of
* the merged UI. * the merged UI.