From 160e3574ac503cf7337d1d57a071583587dcbe33 Mon Sep 17 00:00:00 2001 From: Damon Chaplin Date: Mon, 28 Feb 2000 21:39:41 +0000 Subject: [PATCH] new menu item sections and minor update to notebook section from Nicolas 2000-02-28 Damon Chaplin * 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 . 2000-02-18 Damon Chaplin * gtk/tmpl/gtktooltips.sgml: patch from David Benson to note that gtk_tooltips_set_colors() does not work. 2000-02-09 Damon Chaplin * gdk/tmpl/input_methods.sgml: minor fix. --- docs/reference/ChangeLog | 17 ++++ docs/reference/gdk/tmpl/input_methods.sgml | 2 +- docs/reference/gtk/tmpl/gtklistitem.sgml | 35 +++++--- docs/reference/gtk/tmpl/gtkmenuitem.sgml | 90 ++++++++++++------- docs/reference/gtk/tmpl/gtknotebook.sgml | 2 +- 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 + + * 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 . + +2000-02-18 Damon Chaplin + + * gtk/tmpl/gtktooltips.sgml: patch from + David Benson to note that gtk_tooltips_set_colors() + does not work. + +2000-02-09 Damon Chaplin + + * gdk/tmpl/input_methods.sgml: minor fix. + 2000-02-03 Damon Chaplin * 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. -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. 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 - +an item in a #GtkList. +The #GtkListItem widget is used for each item in a #GtkList. + + + +#GtkList +the parent list widget. + + + - +The #GtkListItem struct contains private data only, and should +only be accessed using the functions below. - +Creates a new #GtkListitem. -@Returns: +@Returns: a new #GtkListItem. - +Creates a new #GtkListItem with a child label containing the given string. -@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. - +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. -@list_item: +@list_item: a #GtkListItem. - +Deselects the item, by emitting the item's "deselect" signal. -@list_item: +@list_item: a #GtkListItem. 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 - +the widget used for item in menus - +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. + + +As it derives from #GtkBin it can hold any valid child widget, altough +only a few are really useful. - + + +#GtkBin +for how to handle the child. + + +#GtkItem +is the abstract class for all sorts of items. + + +#GtkMenu +is always the parent of #GtkMenuItem. + + @@ -19,102 +38,113 @@ GtkMenuItem +@item: the parent class object +@submenu: the submenu attached to this item; read only - +Creates a new #GtkMenuItem. -@Returns: +@Returns: the newly created #GtkMenuItem - +Creates a new #GtkMenuItem whose child is a simple #GtlLabel. -@label: -@Returns: +@label: the text for the label +@Returns: the newly created #GtkMenuItem - +Sets the widget submenu, or changes it. -@menu_item: -@submenu: +@menu_item: the menu item widget +@submenu: the submenu - +Removes the widget's submenu. -@menu_item: +@menu_item: the menu item widget - +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. + + +This function is useless in usual applications. -@menu_item: -@placement: +@menu_item: the menu item +@placement: the submenu placement - +Sets whether the menu item should show a submenu indicator, which is a right +arrow. -@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 - +Emits the "select" signal on the given item. Behaves exactly like +#gtk_item_select. -@menu_item: +@menu_item: the menu item - +Emits the "deselect" signal on the given item. Behaves exactly like +#gtk_item_deselect. -@menu_item: +@menu_item: the menu item - +Emits the "activate" signal on the given item -@menu_item: +@menu_item: the menu item - +Sets the menu item to be right-justified. Only useful for menu bars. -@menu_item: +@menu_item: the menu item - +Emitted when the item is activated. @menuitem: the object which received the signal. - +Emitted when the item is activated, but also if the menu item has a +submenu. For normal applications, the relevant signal is "activate". @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. -??? I don't see such a macro in gtknotebook.h (v1.2.3). +Compatibility macro; in gtkcompat.h. 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 - +A choice from multiple check menu items. - +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. + +The correct way to create a group of radio menu items is aproximativly +this: + + + +How to create a group of radio menu items. + +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); +} + + - + + +#GtkMenuItem +because a radio menu item is a menu item. + + +#GtkCheckItem +to know how to handle the check. + + - +The structure contains only provate data that must be accessed through +the interface functions. - +Creates a new #GtkRadioMenuItem. -@group: -@Returns: +@group: the group to wich the radio menu item is to be attached +@Returns: the newly created radio menu item - +Creates a new #GtkRadioMenuItem whose child is a simple #GtlLabel. -@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 - +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. -@radio_menu_item: -@Returns: +@radio_menu_item: the radio menu item +@Returns: its group - +Sets the group of a radio menu item, or changes it. -@radio_menu_item: -@group: +@radio_menu_item: the radio menu item +@group: the new group