From 02d5f41c9ea5116977c68fef42a984c180c04d84 Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Fri, 18 May 2001 18:28:52 +0000 Subject: [PATCH] Add documentation about GtkSizeGroup. Fri May 18 12:28:08 2001 Owen Taylor * gtk/tmpl/gtksizegroup.sgml gtk/gtk-sections.txt gtk/gtk.types: Add documentation about GtkSizeGroup. --- docs/reference/ChangeLog | 5 + docs/reference/gtk/gtk-docs.sgml | 2 + docs/reference/gtk/gtk-sections.txt | 19 ++- docs/reference/gtk/gtk.types | 1 + docs/reference/gtk/tmpl/gtk-unused.sgml | 36 ++++++ docs/reference/gtk/tmpl/gtkbbox.sgml | 5 + docs/reference/gtk/tmpl/gtkcontainer.sgml | 5 - docs/reference/gtk/tmpl/gtkhscale.sgml | 5 - docs/reference/gtk/tmpl/gtkhscrollbar.sgml | 5 - docs/reference/gtk/tmpl/gtkpaned.sgml | 10 ++ docs/reference/gtk/tmpl/gtkrange.sgml | 5 + docs/reference/gtk/tmpl/gtkrc.sgml | 1 - docs/reference/gtk/tmpl/gtksizegroup.sgml | 112 ++++++++++++++++++ docs/reference/gtk/tmpl/gtktogglebutton.sgml | 5 + .../reference/gtk/tmpl/gtktreeviewcolumn.sgml | 8 +- docs/reference/gtk/tmpl/gtkvscale.sgml | 5 - docs/reference/gtk/tmpl/gtkvscrollbar.sgml | 5 - 17 files changed, 205 insertions(+), 29 deletions(-) create mode 100644 docs/reference/gtk/tmpl/gtksizegroup.sgml diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index d42afca31e..2faf697c7b 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Fri May 18 12:28:08 2001 Owen Taylor + + * gtk/tmpl/gtksizegroup.sgml gtk/gtk-sections.txt gtk/gtk.types: + Add documentation about GtkSizeGroup. + 2001-05-11 Havoc Pennington * gtk/tmpl/gtkvruler.sgml, diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index bbc1d256df..a86aa9b958 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -75,6 +75,7 @@ + @@ -352,6 +353,7 @@ An advanced widget set. &GtkHandleBox; &GtkIMContext; &GtkIMMulticontext; + &GtkSizeGroup; &GtkTooltips; &GtkViewport; diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt index 455a2052a0..4dfa32fc38 100644 --- a/docs/reference/gtk/gtk-sections.txt +++ b/docs/reference/gtk/gtk-sections.txt @@ -1917,7 +1917,24 @@ GTK_TYPE_SETTINGS gtk_settings_get_type - +
+gtksizegroup +GtkSizeGroup +GtkSizeGroupMode +gtk_size_group_new +gtk_size_group_set_mode +gtk_size_group_get_mode +gtk_size_group_add_widget +gtk_size_group_remove_widget + +GTK_SIZE_GROUP +GTK_IS_SIZE_GROUP +GTK_TYPE_SIZE_GROUP +gtk_size_group_get_type +GTK_SIZE_GROUP_CLASS +GTK_IS_SIZE_GROUP_CLASS +GTK_SIZE_GROUP_GET_CLASS +
gtksocket diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types index 54b1e81c82..a3d7a8f628 100644 --- a/docs/reference/gtk/gtk.types +++ b/docs/reference/gtk/gtk.types @@ -73,6 +73,7 @@ gtk_scale_get_type gtk_scrollbar_get_type gtk_scrolled_window_get_type gtk_separator_get_type +gtk_size_group_get_type gtk_socket_get_type gtk_spin_button_get_type gtk_statusbar_get_type diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index 4cb131d8ce..b39f073487 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -301,6 +301,18 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN @a: + + + + + + + + + + + + The #GtkData-struct struct contains no public fields. @@ -540,6 +552,18 @@ gtk_font_selection_set_filter(). + + +the #GtkAdjustment which sets the range of the scale. + + + + + + + + + @@ -723,6 +747,18 @@ produce superscript and subscript. + + +the #GtkAdjustment which sets the range of the scale. + + + + + + + + + diff --git a/docs/reference/gtk/tmpl/gtkbbox.sgml b/docs/reference/gtk/tmpl/gtkbbox.sgml index 07185209dd..8e57ef0d56 100644 --- a/docs/reference/gtk/tmpl/gtkbbox.sgml +++ b/docs/reference/gtk/tmpl/gtkbbox.sgml @@ -150,3 +150,8 @@ box. @ipad_y: the vertical padding that should be used by each button in @widget. + + + + + diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml index 5fd8635c62..81b031484b 100644 --- a/docs/reference/gtk/tmpl/gtkcontainer.sgml +++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml @@ -422,8 +422,3 @@ GtkContainer - - - - - diff --git a/docs/reference/gtk/tmpl/gtkhscale.sgml b/docs/reference/gtk/tmpl/gtkhscale.sgml index e23b095834..60a554e47f 100644 --- a/docs/reference/gtk/tmpl/gtkhscale.sgml +++ b/docs/reference/gtk/tmpl/gtkhscale.sgml @@ -37,8 +37,3 @@ Creates a new #GtkHScale. @Returns: a new #GtkHScale. - - -the #GtkAdjustment which sets the range of the scale. - - diff --git a/docs/reference/gtk/tmpl/gtkhscrollbar.sgml b/docs/reference/gtk/tmpl/gtkhscrollbar.sgml index 5317f3eae9..e29afd25fd 100644 --- a/docs/reference/gtk/tmpl/gtkhscrollbar.sgml +++ b/docs/reference/gtk/tmpl/gtkhscrollbar.sgml @@ -33,8 +33,3 @@ Creates a new horizontal scrollbar. @Returns: the new GTKHScrollbar - - - - - diff --git a/docs/reference/gtk/tmpl/gtkpaned.sgml b/docs/reference/gtk/tmpl/gtkpaned.sgml index 214980a40e..f3f8f1df49 100644 --- a/docs/reference/gtk/tmpl/gtkpaned.sgml +++ b/docs/reference/gtk/tmpl/gtkpaned.sgml @@ -168,3 +168,13 @@ Set the width of the gutter. (The area between the two panes). @Returns: + + + + + + + + + + diff --git a/docs/reference/gtk/tmpl/gtkrange.sgml b/docs/reference/gtk/tmpl/gtkrange.sgml index 63fb9f0f6f..349085ee4e 100644 --- a/docs/reference/gtk/tmpl/gtkrange.sgml +++ b/docs/reference/gtk/tmpl/gtkrange.sgml @@ -79,3 +79,8 @@ GtkRange + + + + + diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml index 88a0a4a507..aeceb3e5ec 100644 --- a/docs/reference/gtk/tmpl/gtkrc.sgml +++ b/docs/reference/gtk/tmpl/gtkrc.sgml @@ -495,7 +495,6 @@ This can later be composited together with other #GtkRcStyle structures to form a #GtkStyle. -@parent_instance: @name: @bg_pixmap_name: @font_desc: diff --git a/docs/reference/gtk/tmpl/gtksizegroup.sgml b/docs/reference/gtk/tmpl/gtksizegroup.sgml new file mode 100644 index 0000000000..70783a970f --- /dev/null +++ b/docs/reference/gtk/tmpl/gtksizegroup.sgml @@ -0,0 +1,112 @@ + +GtkSizeGroup + + +Grouping widgets so they request the same size + + + +#GtkSizeGroup provides a mechanism for grouping a number of widgets +together so they all request the same amount of space. This is +typically useful when you want a column of widgets to have the same +size, but you can't use a #GtkTable widget. + + +In detail, the size requested for each widget in a #GtkSizeGroup is +the maximum of the sizes that would have been requested for each +widget in the size group if they were not in the size group. The mode +of the size group (see gtk_size_group_set_mode()) determines whether +this applies to the horizontal size, the vertical size, or both sizes. + + +Note that size groups only affect the amount of space requested, not +the size that the widgets finally receive. If you want the widgets in +a #GtkSizeGroup to actually be the same size, you need to pack them in +such a way that they get the size they request and not more. For +example, if you are packing your widgets into a table, you would not +include the %GTK_FILL flag. + + +#GtkSizeGroup objects are referenced by each widget in the size group, +so once you have added all widgets to a #GtkSizeGroup, you can drop +the initial reference to the size group with g_object_unref(). If the +widgets in the size group are subsequently destroyed, then they will +be removed from the size group and drop their references on the size +group; when all widgets have been removed, the size group will be +freed. + + +Widgets can be part of multiple size groups; GTK+ will compute the +horizontal size of a widget from the horizontal requisition of all +widgets that can be reached from the widget by a chain of size groups +of type %GTK_SIZE_GROUP_HORIZONTAL or %GTK_SIZE_GROUP_BOTH, and the +vertical size from the vertical requisition of all widgets that can be +reached from the widget by a chain of size groups of type +%GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH. + + + + + + + + + + + + +@GTK_SIZE_GROUP_NONE: +@GTK_SIZE_GROUP_HORIZONTAL: +@GTK_SIZE_GROUP_VERTICAL: +@GTK_SIZE_GROUP_BOTH: + + + + + + +@mode: +@Returns: + + + + + + + +@size_group: +@type: + + + + + + + +@size_group: +@Returns: + + + + + + + +@size_group: +@widget: + + + + + + + +@size_group: +@widget: + + + + + + + diff --git a/docs/reference/gtk/tmpl/gtktogglebutton.sgml b/docs/reference/gtk/tmpl/gtktogglebutton.sgml index 15a339be11..fecc48fb61 100644 --- a/docs/reference/gtk/tmpl/gtktogglebutton.sgml +++ b/docs/reference/gtk/tmpl/gtktogglebutton.sgml @@ -174,6 +174,11 @@ Should be connected if you wish to perform an action whenever the Sets whether the toggle button should be pressed in or not. + + + + + A value of TRUE causes the toggle button to be invisible. FALSE displays it diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml index 68e43c4aac..768a600491 100644 --- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml +++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml @@ -34,8 +34,10 @@ GtkTreeViewColumn @alignment: @window: @xalign: -@model_changed_signal: +@property_changed_signal: +@clickable_signal: @width: +@requested_width: @min_width: @max_width: @displayed_width: @@ -53,7 +55,7 @@ GtkTreeViewColumn @sort_column_id: @sort_order: @visible: -@button_active: +@clickable: @dirty: @show_sort_indicator: @maybe_reordered: @@ -239,6 +241,8 @@ GtkTreeViewColumn @tree_column: +@clickable: + @active: diff --git a/docs/reference/gtk/tmpl/gtkvscale.sgml b/docs/reference/gtk/tmpl/gtkvscale.sgml index 81a6ffa294..5e111ac40f 100644 --- a/docs/reference/gtk/tmpl/gtkvscale.sgml +++ b/docs/reference/gtk/tmpl/gtkvscale.sgml @@ -37,8 +37,3 @@ Creates a new #GtkVScale. @Returns: a new #GtkVScale. - - -the #GtkAdjustment which sets the range of the scale. - - diff --git a/docs/reference/gtk/tmpl/gtkvscrollbar.sgml b/docs/reference/gtk/tmpl/gtkvscrollbar.sgml index 758fd43349..36837e20e7 100644 --- a/docs/reference/gtk/tmpl/gtkvscrollbar.sgml +++ b/docs/reference/gtk/tmpl/gtkvscrollbar.sgml @@ -33,8 +33,3 @@ Creates a new vertical scrollbar. @Returns: the new GTKVScrollbar - - - - -