diff options
author | Matthias Clasen <matthiasc@src.gnome.org> | 2003-09-15 22:21:26 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2003-09-15 22:21:26 +0000 |
commit | 543b020fdcd9bf31b7501d24c24d38b3be41fe85 (patch) | |
tree | 492e62a8b386c672d96b64fa90e7614f5f16f580 /docs | |
parent | 405f24c9e6d71c9e6848651d7436728007f1b9e2 (diff) | |
download | gdk-pixbuf-543b020fdcd9bf31b7501d24c24d38b3be41fe85.tar.gz |
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.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 7 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkaction.sgml | 5 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkactiongroup.sgml | 108 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkradioaction.sgml | 2 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkuimanager.sgml | 21 |
5 files changed, 98 insertions, 45 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index a810a2300..06819cedc 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -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. diff --git a/docs/reference/gtk/tmpl/gtkaction.sgml b/docs/reference/gtk/tmpl/gtkaction.sgml index f900a26fd..e01a7c773 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. +<!-- ##### ARG GtkAction:is-important ##### --> +<para> + +</para> + <!-- ##### ARG GtkAction:label ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkactiongroup.sgml b/docs/reference/gtk/tmpl/gtkactiongroup.sgml index e29725495..a96d738ba 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. </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: diff --git a/docs/reference/gtk/tmpl/gtkradioaction.sgml b/docs/reference/gtk/tmpl/gtkradioaction.sgml index e1541b65d..41dc3e67a 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. -</para> +</para> <!-- ##### SECTION See_Also ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkuimanager.sgml b/docs/reference/gtk/tmpl/gtkuimanager.sgml index a34872a37..c649055d2 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. <!-- ##### 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> |