diff options
| -rw-r--r-- | docs/reference/ChangeLog | 17 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/input_methods.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtklistitem.sgml | 35 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkmenuitem.sgml | 90 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtknotebook.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkradiomenuitem.sgml | 67 |
6 files changed, 153 insertions, 60 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 7488baa57d..7a210ceb87 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,20 @@ +2000-02-28 Damon Chaplin <damon@helixcode.com> + + * gtk/tmpl/gtkradiomenuitem.sgml: + * gtk/tmpl/gtkmenuitem.sgml: + * gtk/tmpl/gtknotebook.sgml: new menu item sections and minor update to + notebook section from Nicolas GEORGE <nicolas.george@ens.fr>. + +2000-02-18 Damon Chaplin <damon@helixcode.com> + + * gtk/tmpl/gtktooltips.sgml: patch from + David Benson <daveb@idealab.com> to note that gtk_tooltips_set_colors() + does not work. + +2000-02-09 Damon Chaplin <damon@helixcode.com> + + * gdk/tmpl/input_methods.sgml: minor fix. + 2000-02-03 Damon Chaplin <damon@karuna.freeserve.co.uk> * gdk/gdk-sections.txt: rearranged a bit. diff --git a/docs/reference/gdk/tmpl/input_methods.sgml b/docs/reference/gdk/tmpl/input_methods.sgml index fe528dee3a..4ba54c8bd3 100644 --- a/docs/reference/gdk/tmpl/input_methods.sgml +++ b/docs/reference/gdk/tmpl/input_methods.sgml @@ -193,7 +193,7 @@ styles is returned. <!-- ##### FUNCTION gdk_im_begin ##### --> <para> -Starts editing, using the given #GdkInputContext and #GdkWindow. +Starts editing, using the given input context and #GdkWindow. This should be called when the widget receives the input focus, typically in the widget's focus_in_event method. </para> diff --git a/docs/reference/gtk/tmpl/gtklistitem.sgml b/docs/reference/gtk/tmpl/gtklistitem.sgml index f2e778412e..696726c07a 100644 --- a/docs/reference/gtk/tmpl/gtklistitem.sgml +++ b/docs/reference/gtk/tmpl/gtklistitem.sgml @@ -2,55 +2,68 @@ GtkListItem <!-- ##### SECTION Short_Description ##### --> - +an item in a #GtkList. <!-- ##### SECTION Long_Description ##### --> <para> +The #GtkListItem widget is used for each item in a #GtkList. </para> <!-- ##### SECTION See_Also ##### --> <para> +<variablelist> + +<varlistentry> +<term>#GtkList</term> +<listitem><para>the parent list widget.</para></listitem> +</varlistentry> + +</variablelist> </para> <!-- ##### STRUCT GtkListItem ##### --> <para> - +The #GtkListItem struct contains private data only, and should +only be accessed using the functions below. </para> <!-- ##### FUNCTION gtk_list_item_new ##### --> <para> - +Creates a new #GtkListitem. </para> -@Returns: +@Returns: a new #GtkListItem. <!-- ##### FUNCTION gtk_list_item_new_with_label ##### --> <para> - +Creates a new #GtkListItem with a child label containing the given string. </para> -@label: -@Returns: +@label: the string to use for the child label. +@Returns: a new #GtkListItem with a child #GtkLabel with the text set to +@label. <!-- ##### FUNCTION gtk_list_item_select ##### --> <para> - +Selects the item, by emitting the item's "select" signal. +Depending on the selection mode of the list, this may cause other items to +be deselected. </para> -@list_item: +@list_item: a #GtkListItem. <!-- ##### FUNCTION gtk_list_item_deselect ##### --> <para> - +Deselects the item, by emitting the item's "deselect" signal. </para> -@list_item: +@list_item: a #GtkListItem. <!-- ##### SIGNAL GtkListItem::toggle-focus-row ##### --> diff --git a/docs/reference/gtk/tmpl/gtkmenuitem.sgml b/docs/reference/gtk/tmpl/gtkmenuitem.sgml index e75da30f74..5cd172bb74 100644 --- a/docs/reference/gtk/tmpl/gtkmenuitem.sgml +++ b/docs/reference/gtk/tmpl/gtkmenuitem.sgml @@ -2,16 +2,35 @@ GtkMenuItem <!-- ##### SECTION Short_Description ##### --> - +the widget used for item in menus <!-- ##### SECTION Long_Description ##### --> <para> - +The #GtkMenuItem widget and the derived widgets are the only valid +childs for menus. Their function is to correctly handle highlighting, +alignment, events and submenus. +</para> +<para> +As it derives from #GtkBin it can hold any valid child widget, altough +only a few are really useful. </para> <!-- ##### SECTION See_Also ##### --> <para> - +<variablelist> +<varlistentry> +<term>#GtkBin</term> +<listitem><para>for how to handle the child.</para></listitem> +</varlistentry> +<varlistentry> +<term>#GtkItem</term> +<listitem><para>is the abstract class for all sorts of items.</para></listitem> +</varlistentry> +<varlistentry> +<term>#GtkMenu</term> +<listitem><para>is always the parent of #GtkMenuItem.</para></listitem> +</varlistentry> +</variablelist> </para> <!-- ##### STRUCT GtkMenuItem ##### --> @@ -19,102 +38,113 @@ GtkMenuItem </para> +@item: the parent class object +@submenu: the submenu attached to this item; read only <!-- ##### FUNCTION gtk_menu_item_new ##### --> <para> - +Creates a new #GtkMenuItem. </para> -@Returns: +@Returns: the newly created #GtkMenuItem <!-- ##### FUNCTION gtk_menu_item_new_with_label ##### --> <para> - +Creates a new #GtkMenuItem whose child is a simple #GtlLabel. </para> -@label: -@Returns: +@label: the text for the label +@Returns: the newly created #GtkMenuItem <!-- ##### FUNCTION gtk_menu_item_set_submenu ##### --> <para> - +Sets the widget submenu, or changes it. </para> -@menu_item: -@submenu: +@menu_item: the menu item widget +@submenu: the submenu <!-- ##### FUNCTION gtk_menu_item_remove_submenu ##### --> <para> - +Removes the widget's submenu. </para> -@menu_item: +@menu_item: the menu item widget <!-- ##### FUNCTION gtk_menu_item_set_placement ##### --> <para> - +Specifies the placement of the submenu around the menu item. The placement +is usually #GTK_LEFT_RIGHT for menu items in a popup menu and +#GTK_TOP_BOTTOM in menu bars. +</para> +<para> +This function is useless in usual applications. </para> -@menu_item: -@placement: +@menu_item: the menu item +@placement: the submenu placement <!-- ##### FUNCTION gtk_menu_item_configure ##### --> <para> - +Sets whether the menu item should show a submenu indicator, which is a right +arrow. </para> -@menu_item: -@show_toggle_indicator: -@show_submenu_indicator: +@menu_item: the menu item +@show_toggle_indicator: unused +@show_submenu_indicator: whether to show the arrow or not <!-- ##### FUNCTION gtk_menu_item_select ##### --> <para> - +Emits the "select" signal on the given item. Behaves exactly like +#gtk_item_select. </para> -@menu_item: +@menu_item: the menu item <!-- ##### FUNCTION gtk_menu_item_deselect ##### --> <para> - +Emits the "deselect" signal on the given item. Behaves exactly like +#gtk_item_deselect. </para> -@menu_item: +@menu_item: the menu item <!-- ##### FUNCTION gtk_menu_item_activate ##### --> <para> - +Emits the "activate" signal on the given item </para> -@menu_item: +@menu_item: the menu item <!-- ##### FUNCTION gtk_menu_item_right_justify ##### --> <para> - +Sets the menu item to be right-justified. Only useful for menu bars. </para> -@menu_item: +@menu_item: the menu item <!-- ##### SIGNAL GtkMenuItem::activate ##### --> <para> - +Emitted when the item is activated. </para> @menuitem: the object which received the signal. <!-- ##### SIGNAL GtkMenuItem::activate-item ##### --> <para> - +Emitted when the item is activated, but also if the menu item has a +submenu. For normal applications, the relevant signal is "activate". </para> @menuitem: the object which received the signal. diff --git a/docs/reference/gtk/tmpl/gtknotebook.sgml b/docs/reference/gtk/tmpl/gtknotebook.sgml index df5086d721..bc8cb99e26 100644 --- a/docs/reference/gtk/tmpl/gtknotebook.sgml +++ b/docs/reference/gtk/tmpl/gtknotebook.sgml @@ -172,7 +172,7 @@ ignored. <!-- ##### MACRO gtk_notebook_current_page ##### --> <para> -??? I don't see such a macro in gtknotebook.h (v1.2.3). +Compatibility macro; in gtkcompat.h. </para> diff --git a/docs/reference/gtk/tmpl/gtkradiomenuitem.sgml b/docs/reference/gtk/tmpl/gtkradiomenuitem.sgml index 3d6ed3fe9b..3e9f1f6664 100644 --- a/docs/reference/gtk/tmpl/gtkradiomenuitem.sgml +++ b/docs/reference/gtk/tmpl/gtkradiomenuitem.sgml @@ -2,58 +2,91 @@ GtkRadioMenuItem <!-- ##### SECTION Short_Description ##### --> - +A choice from multiple check menu items. <!-- ##### SECTION Long_Description ##### --> <para> - +A radio menu item is a check menu item that belongs to a group. At each +instant exactly one of the radio menu items from a group is selected. +</para> +<para> +The correct way to create a group of radio menu items is aproximativly +this: </para> +<para> +<example> +<title>How to create a group of radio menu items.</title> +<programlisting> +GList *group = NULL; +GtkWidget *item; +gint i; + +for(i = 0; i < 5; i++) +{ + item = gtk_radio_menu_item_new_with_label (group, "This is an example"); + group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (item)); + if (i == 1) + gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE); +} +</programlisting> +</example> <!-- ##### SECTION See_Also ##### --> <para> - +<variablelist> +<varlistentry> +<term>#GtkMenuItem</term> +<listitem><para>because a radio menu item is a menu item.</para></listitem> +</varlistentry> +<varlistentry> +<term>#GtkCheckItem</term> +<listitem><para>to know how to handle the check.</para></listitem> +</varlistentry> +</variablelist> </para> <!-- ##### STRUCT GtkRadioMenuItem ##### --> <para> - +The structure contains only provate data that must be accessed through +the interface functions. </para> <!-- ##### FUNCTION gtk_radio_menu_item_new ##### --> <para> - +Creates a new #GtkRadioMenuItem. </para> -@group: -@Returns: +@group: the group to wich the radio menu item is to be attached +@Returns: the newly created radio menu item <!-- ##### FUNCTION gtk_radio_menu_item_new_with_label ##### --> <para> - +Creates a new #GtkRadioMenuItem whose child is a simple #GtlLabel. </para> -@group: -@label: -@Returns: +@group: the group to wich the radio menu item is to be attached +@label: the text for the label +@Returns: the newly created radio menu item <!-- ##### FUNCTION gtk_radio_menu_item_group ##### --> <para> - +Returns the group to which the radio menu item belongs, as a #GList of +#GtkRadioMenuItem. The list belongs to GTK+ and should not be freed. </para> -@radio_menu_item: -@Returns: +@radio_menu_item: the radio menu item +@Returns: its group <!-- ##### FUNCTION gtk_radio_menu_item_set_group ##### --> <para> - +Sets the group of a radio menu item, or changes it. </para> -@radio_menu_item: -@group: +@radio_menu_item: the radio menu item +@group: the new group |