summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@redhat.com>2001-05-18 18:28:52 +0000
committerOwen Taylor <otaylor@src.gnome.org>2001-05-18 18:28:52 +0000
commit02d5f41c9ea5116977c68fef42a984c180c04d84 (patch)
tree32e7bafd22e7497d6f47f4d7a9f68f3670afe2cc
parent60530b8a8ebec252fe212d8911834badb5587ca4 (diff)
downloadgdk-pixbuf-02d5f41c9ea5116977c68fef42a984c180c04d84.tar.gz
Add documentation about GtkSizeGroup.
Fri May 18 12:28:08 2001 Owen Taylor <otaylor@redhat.com> * gtk/tmpl/gtksizegroup.sgml gtk/gtk-sections.txt gtk/gtk.types: Add documentation about GtkSizeGroup.
-rw-r--r--docs/reference/ChangeLog5
-rw-r--r--docs/reference/gtk/gtk-docs.sgml2
-rw-r--r--docs/reference/gtk/gtk-sections.txt19
-rw-r--r--docs/reference/gtk/gtk.types1
-rw-r--r--docs/reference/gtk/tmpl/gtk-unused.sgml36
-rw-r--r--docs/reference/gtk/tmpl/gtkbbox.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtkcontainer.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtkhscale.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtkhscrollbar.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtkpaned.sgml10
-rw-r--r--docs/reference/gtk/tmpl/gtkrange.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtkrc.sgml1
-rw-r--r--docs/reference/gtk/tmpl/gtksizegroup.sgml112
-rw-r--r--docs/reference/gtk/tmpl/gtktogglebutton.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml8
-rw-r--r--docs/reference/gtk/tmpl/gtkvscale.sgml5
-rw-r--r--docs/reference/gtk/tmpl/gtkvscrollbar.sgml5
17 files changed, 205 insertions, 29 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index d42afca31..2faf697c7 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+Fri May 18 12:28:08 2001 Owen Taylor <otaylor@redhat.com>
+
+ * gtk/tmpl/gtksizegroup.sgml gtk/gtk-sections.txt gtk/gtk.types:
+ Add documentation about GtkSizeGroup.
+
2001-05-11 Havoc Pennington <hp@pobox.com>
* gtk/tmpl/gtkvruler.sgml,
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index bbc1d256d..a86aa9b95 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -75,6 +75,7 @@
<!entity GtkScrollbar SYSTEM "sgml/gtkscrollbar.sgml">
<!entity GtkScrolledWindow SYSTEM "sgml/gtkscrolledwindow.sgml">
<!entity GtkSeparator SYSTEM "sgml/gtkseparator.sgml">
+<!entity GtkSizeGroup SYSTEM "sgml/gtksizegroup.sgml">
<!entity GtkSocket SYSTEM "sgml/gtksocket.sgml">
<!entity GtkSpinButton SYSTEM "sgml/gtkspinbutton.sgml">
<!entity GtkStatusbar SYSTEM "sgml/gtkstatusbar.sgml">
@@ -352,6 +353,7 @@ An advanced widget set.
&GtkHandleBox;
&GtkIMContext;
&GtkIMMulticontext;
+ &GtkSizeGroup;
&GtkTooltips;
&GtkViewport;
</sect1>
diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index 455a2052a..4dfa32fc3 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
</SECTION>
-
+<SECTION>
+<FILE>gtksizegroup</FILE>
+<TITLE>GtkSizeGroup</TITLE>
+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
+<SUBSECTION Standard>
+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
+</SECTION>
<SECTION>
<FILE>gtksocket</FILE>
diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types
index 54b1e81c8..a3d7a8f62 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 4cb131d8c..b39f07348 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:
+<!-- ##### ARG GtkAccelLabel:accel-width ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
+<para>
+
+</para>
+
+
<!-- ##### STRUCT GtkData ##### -->
<para>
The #GtkData-struct struct contains no public fields.
@@ -540,6 +552,18 @@ gtk_font_selection_set_filter().
</para>
+<!-- ##### ARG GtkHScale:adjustment ##### -->
+<para>
+the #GtkAdjustment which sets the range of the scale.
+</para>
+
+
+<!-- ##### ARG GtkHScrollbar:adjustment ##### -->
+<para>
+
+</para>
+
+
<!-- ##### STRUCT GtkIMContextSimple ##### -->
<para>
@@ -723,6 +747,18 @@ produce superscript and subscript.
</para>
+<!-- ##### ARG GtkVScale:adjustment ##### -->
+<para>
+the #GtkAdjustment which sets the range of the scale.
+</para>
+
+
+<!-- ##### ARG GtkVScrollbar:adjustment ##### -->
+<para>
+
+</para>
+
+
<!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkbbox.sgml b/docs/reference/gtk/tmpl/gtkbbox.sgml
index 07185209d..8e57ef0d5 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.
+<!-- ##### ARG GtkButtonBox:layout-style ##### -->
+<para>
+
+</para>
+
diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml
index 5fd8635c6..81b031484 100644
--- a/docs/reference/gtk/tmpl/gtkcontainer.sgml
+++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml
@@ -422,8 +422,3 @@ GtkContainer
</para>
-<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
-<para>
-
-</para>
-
diff --git a/docs/reference/gtk/tmpl/gtkhscale.sgml b/docs/reference/gtk/tmpl/gtkhscale.sgml
index e23b09583..60a554e47 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.
-<!-- ##### ARG GtkHScale:adjustment ##### -->
-<para>
-the #GtkAdjustment which sets the range of the scale.
-</para>
-
diff --git a/docs/reference/gtk/tmpl/gtkhscrollbar.sgml b/docs/reference/gtk/tmpl/gtkhscrollbar.sgml
index 5317f3eae..e29afd25f 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
-<!-- ##### ARG GtkHScrollbar:adjustment ##### -->
-<para>
-
-</para>
-
diff --git a/docs/reference/gtk/tmpl/gtkpaned.sgml b/docs/reference/gtk/tmpl/gtkpaned.sgml
index 214980a40..f3f8f1df4 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:
+<!-- ##### ARG GtkPaned:position ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkPaned:position-set ##### -->
+<para>
+
+</para>
+
diff --git a/docs/reference/gtk/tmpl/gtkrange.sgml b/docs/reference/gtk/tmpl/gtkrange.sgml
index 63fb9f0f6..349085ee4 100644
--- a/docs/reference/gtk/tmpl/gtkrange.sgml
+++ b/docs/reference/gtk/tmpl/gtkrange.sgml
@@ -79,3 +79,8 @@ GtkRange
</para>
+<!-- ##### ARG GtkRange:adjustment ##### -->
+<para>
+
+</para>
+
diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml
index 88a0a4a50..aeceb3e5e 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.
</para>
-@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 000000000..70783a970
--- /dev/null
+++ b/docs/reference/gtk/tmpl/gtksizegroup.sgml
@@ -0,0 +1,112 @@
+<!-- ##### SECTION Title ##### -->
+GtkSizeGroup
+
+<!-- ##### SECTION Short_Description ##### -->
+Grouping widgets so they request the same size
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#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.
+</para>
+<para>
+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.
+</para>
+<para>
+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.
+</para>
+<para>
+#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.
+</para>
+<para>
+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.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### ENUM GtkSizeGroupMode ##### -->
+<para>
+
+</para>
+
+@GTK_SIZE_GROUP_NONE:
+@GTK_SIZE_GROUP_HORIZONTAL:
+@GTK_SIZE_GROUP_VERTICAL:
+@GTK_SIZE_GROUP_BOTH:
+
+<!-- ##### FUNCTION gtk_size_group_new ##### -->
+<para>
+
+</para>
+
+@mode:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_size_group_set_mode ##### -->
+<para>
+
+</para>
+
+@size_group:
+@type:
+
+
+<!-- ##### FUNCTION gtk_size_group_get_mode ##### -->
+<para>
+
+</para>
+
+@size_group:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_size_group_add_widget ##### -->
+<para>
+
+</para>
+
+@size_group:
+@widget:
+
+
+<!-- ##### FUNCTION gtk_size_group_remove_widget ##### -->
+<para>
+
+</para>
+
+@size_group:
+@widget:
+
+
+<!-- ##### ARG GtkSizeGroup:mode ##### -->
+<para>
+
+</para>
+
diff --git a/docs/reference/gtk/tmpl/gtktogglebutton.sgml b/docs/reference/gtk/tmpl/gtktogglebutton.sgml
index 15a339be1..fecc48fb6 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.
</para>
+<!-- ##### ARG GtkToggleButton:inconsistent ##### -->
+<para>
+
+</para>
+
<!-- ##### ARG GtkToggleButton:draw-indicator ##### -->
<para>
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 68e43c4aa..768a60049 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
</para>
@tree_column:
+@clickable:
+<!-- # Unused Parameters # -->
@active:
diff --git a/docs/reference/gtk/tmpl/gtkvscale.sgml b/docs/reference/gtk/tmpl/gtkvscale.sgml
index 81a6ffa29..5e111ac40 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.
-<!-- ##### ARG GtkVScale:adjustment ##### -->
-<para>
-the #GtkAdjustment which sets the range of the scale.
-</para>
-
diff --git a/docs/reference/gtk/tmpl/gtkvscrollbar.sgml b/docs/reference/gtk/tmpl/gtkvscrollbar.sgml
index 758fd4334..36837e20e 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
-<!-- ##### ARG GtkVScrollbar:adjustment ##### -->
-<para>
-
-</para>
-