Commit 1f4e829f authored by Soeren Sandmann's avatar Soeren Sandmann Committed by Søren Sandmann Pedersen
Browse files

docs/reference/gtk/tmpl/gtkdialog.sgml

2002-09-01  Soeren Sandmann  <ssp@localhost.localdomain>

	* docs/reference/gtk/tmpl/gtkdialog.sgml
	docs/reference/gtk/tmpl/gtkhbbox.sgml
	docs/reference/gtk/tmpl/gtkvbbox.sgml
	docs/reference/gtk/tmpl/gtktogglebutton.sgml
	docs/reference/gtk/tmpl/gtktreeselection.sgml
	gtk/gtktextbuffer.c
	gtk/gtktogglebutton.c
	gtk/gtktreesortable.c

	Minor documentation fixes:

	#79107, #82854, #76398, Vitaly Tishkov;
	#88627, Brian Tarricone;
	#81046, Owen Taylor
parent a0c80fcc
2002-09-01 Soeren Sandmann <ssp@localhost.localdomain>
* docs/reference/gtk/tmpl/gtkdialog.sgml
docs/reference/gtk/tmpl/gtkhbbox.sgml
docs/reference/gtk/tmpl/gtkvbbox.sgml
docs/reference/gtk/tmpl/gtktogglebutton.sgml
docs/reference/gtk/tmpl/gtktreeselection.sgml
gtk/gtktextbuffer.c
gtk/gtktogglebutton.c
gtk/gtktreesortable.c
Minor documentation fixes:
#79107, #82854, #76398, Vitaly Tishkov;
#88627, Brian Tarricone;
#81046, Owen Taylor
2002-08-31 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkevents-win32.c (_gdk_events_init): On Cygwin, open
......
2002-09-01 Soeren Sandmann <ssp@localhost.localdomain>
* docs/reference/gtk/tmpl/gtkdialog.sgml
docs/reference/gtk/tmpl/gtkhbbox.sgml
docs/reference/gtk/tmpl/gtkvbbox.sgml
docs/reference/gtk/tmpl/gtktogglebutton.sgml
docs/reference/gtk/tmpl/gtktreeselection.sgml
gtk/gtktextbuffer.c
gtk/gtktogglebutton.c
gtk/gtktreesortable.c
Minor documentation fixes:
#79107, #82854, #76398, Vitaly Tishkov;
#88627, Brian Tarricone;
#81046, Owen Taylor
2002-08-31 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkevents-win32.c (_gdk_events_init): On Cygwin, open
......
2002-09-01 Soeren Sandmann <ssp@localhost.localdomain>
* docs/reference/gtk/tmpl/gtkdialog.sgml
docs/reference/gtk/tmpl/gtkhbbox.sgml
docs/reference/gtk/tmpl/gtkvbbox.sgml
docs/reference/gtk/tmpl/gtktogglebutton.sgml
docs/reference/gtk/tmpl/gtktreeselection.sgml
gtk/gtktextbuffer.c
gtk/gtktogglebutton.c
gtk/gtktreesortable.c
Minor documentation fixes:
#79107, #82854, #76398, Vitaly Tishkov;
#88627, Brian Tarricone;
#81046, Owen Taylor
2002-08-31 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkevents-win32.c (_gdk_events_init): On Cygwin, open
......
2002-09-01 Soeren Sandmann <ssp@localhost.localdomain>
* docs/reference/gtk/tmpl/gtkdialog.sgml
docs/reference/gtk/tmpl/gtkhbbox.sgml
docs/reference/gtk/tmpl/gtkvbbox.sgml
docs/reference/gtk/tmpl/gtktogglebutton.sgml
docs/reference/gtk/tmpl/gtktreeselection.sgml
gtk/gtktextbuffer.c
gtk/gtktogglebutton.c
gtk/gtktreesortable.c
Minor documentation fixes:
#79107, #82854, #76398, Vitaly Tishkov;
#88627, Brian Tarricone;
#81046, Owen Taylor
2002-08-31 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkevents-win32.c (_gdk_events_init): On Cygwin, open
......
2002-09-01 Soeren Sandmann <ssp@localhost.localdomain>
* docs/reference/gtk/tmpl/gtkdialog.sgml
docs/reference/gtk/tmpl/gtkhbbox.sgml
docs/reference/gtk/tmpl/gtkvbbox.sgml
docs/reference/gtk/tmpl/gtktogglebutton.sgml
docs/reference/gtk/tmpl/gtktreeselection.sgml
gtk/gtktextbuffer.c
gtk/gtktogglebutton.c
gtk/gtktreesortable.c
Minor documentation fixes:
#79107, #82854, #76398, Vitaly Tishkov;
#88627, Brian Tarricone;
#81046, Owen Taylor
2002-08-31 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkevents-win32.c (_gdk_events_init): On Cygwin, open
......
2002-09-01 Soeren Sandmann <ssp@localhost.localdomain>
* docs/reference/gtk/tmpl/gtkdialog.sgml
docs/reference/gtk/tmpl/gtkhbbox.sgml
docs/reference/gtk/tmpl/gtkvbbox.sgml
docs/reference/gtk/tmpl/gtktogglebutton.sgml
docs/reference/gtk/tmpl/gtktreeselection.sgml
gtk/gtktextbuffer.c
gtk/gtktogglebutton.c
gtk/gtktreesortable.c
Minor documentation fixes:
#79107, #82854, #76398, Vitaly Tishkov;
#88627, Brian Tarricone;
#81046, Owen Taylor
2002-08-31 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkevents-win32.c (_gdk_events_init): On Cygwin, open
......
......@@ -197,6 +197,15 @@ Returns the visual for which a given colormap was created.
@Returns: the visual of the colormap.
<!-- ##### FUNCTION gdk_colormap_get_screen ##### -->
<para>
</para>
@cmap:
@Returns:
<!-- ##### FUNCTION gdk_colors_store ##### -->
<para>
Changes the value of the first @ncolors colors in
......
......@@ -248,3 +248,12 @@ Deprecated equivalent of g_object_unref().
@v:
<!-- ##### FUNCTION gdk_visual_get_screen ##### -->
<para>
</para>
@visual:
@Returns:
......@@ -162,22 +162,22 @@ box.
</para>
<!-- ##### ARG GtkButtonBox:child-internal-pad-y ##### -->
<!-- ##### ARG GtkButtonBox:child-min-height ##### -->
<para>
</para>
<!-- ##### ARG GtkButtonBox:child-internal-pad-x ##### -->
<!-- ##### ARG GtkButtonBox:child-internal-pad-y ##### -->
<para>
</para>
<!-- ##### ARG GtkButtonBox:child-min-width ##### -->
<!-- ##### ARG GtkButtonBox:child-internal-pad-x ##### -->
<para>
</para>
<!-- ##### ARG GtkButtonBox:child-min-height ##### -->
<!-- ##### ARG GtkButtonBox:child-min-width ##### -->
<para>
</para>
......
......@@ -248,17 +248,17 @@ mouse cursor is.
</para>
<!-- ##### ARG GtkButton:child-displacement-y ##### -->
<!-- ##### ARG GtkButton:default-border ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:child-displacement-x ##### -->
<!-- ##### ARG GtkButton:child-displacement-y ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:default-border ##### -->
<!-- ##### ARG GtkButton:child-displacement-x ##### -->
<para>
</para>
......
......@@ -132,13 +132,13 @@ dialog box.
</para>
<para>
<structfield>action_area</structfield> is a #GtkHBox packed below the
<structfield>action_area</structfield> is a #GtkHButtonBox packed below the
dividing #GtkHSeparator in the dialog. It is treated exactly the same
as any other #GtkHBox.
as any other #GtkHButtonBox.
</para>
@action_area:
@vbox:
@action_area:
<!-- ##### ENUM GtkDialogFlags ##### -->
<para>
......
......@@ -2,32 +2,30 @@
GtkHButtonBox
<!-- ##### SECTION Short_Description ##### -->
a container for arranging button horizontally.
a container for arranging buttons horizontally
<!-- ##### SECTION Long_Description ##### -->
<para>
A button box should be used to provide a consistent layout of buttons
throughout your application. There is one default layout and a default
spacing value that are persistant across all #GtkHButtonBox widgets.
throughout your application. The layout/spacing can be altered by the
programmer, or if desired, by the user to alter the 'feel' of a
program to a small degree.
</para>
<para>
The layout/spacing can then be altered by the programmer, or if desired, by
the user to alter the 'feel' of a program to a small degree.
</para>
<para>
A #GtkHButtonBox is created with gtk_hbutton_box_new(). Buttons are packed into
a button box the same way as any other box, using gtk_box_pack_start() or
gtk_box_pack_end().
</para>
<para>
The default spacing between buttons can be set with
gtk_hbutton_box_set_spacing_default() and queried with
gtk_hbutton_box_get_spacing_default().
A #GtkHButtonBox is created with gtk_hbutton_box_new(). Buttons are
packed into a button box the same way widgets are added to any other
container, using gtk_container_add(). You can also use
gtk_box_pack_start() or gtk_box_pack_end(), but for button boxes both
these functions work just like gtk_container_add(), ie., they pack the
button in a way that depends on the current layout style and on
whether the button has had gtk_button_box_set_child_secondary() called
on it.
</para>
<para>
The arrangement and layout of the buttons can be changed using
gtk_hbutton_box_set_layout_default() and queried with
gtk_hbutton_box_get_layout_default().
The spacing between buttons can be set with gtk_box_set_spacing(). The
arrangement and layout of the buttons can be changed with
gtk_button_box_set_layout().
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -49,11 +47,9 @@ gtk_hbutton_box_get_layout_default().
<!-- ##### STRUCT GtkHButtonBox ##### -->
<para>
<structfield>button_box</structfield> is the #GtkHButtonBox widget itself and
should not be modified directly.
GtkHButtonBox does not contain any public fields.
</para>
<!-- ##### FUNCTION gtk_hbutton_box_new ##### -->
<para>
Creates a new horizontal button box.
......
......@@ -100,12 +100,12 @@ selected value for the option menu.
</para>
<!-- ##### ARG GtkOptionMenu:indicator-size ##### -->
<!-- ##### ARG GtkOptionMenu:indicator-spacing ##### -->
<para>
</para>
<!-- ##### ARG GtkOptionMenu:indicator-spacing ##### -->
<!-- ##### ARG GtkOptionMenu:indicator-size ##### -->
<para>
</para>
......
......@@ -153,32 +153,32 @@ Emitted when the range value changes.
</para>
<!-- ##### ARG GtkRange:slider-width ##### -->
<!-- ##### ARG GtkRange:stepper-size ##### -->
<para>
</para>
<!-- ##### ARG GtkRange:arrow-displacement-y ##### -->
<!-- ##### ARG GtkRange:trough-border ##### -->
<para>
</para>
<!-- ##### ARG GtkRange:arrow-displacement-x ##### -->
<!-- ##### ARG GtkRange:stepper-spacing ##### -->
<para>
</para>
<!-- ##### ARG GtkRange:stepper-spacing ##### -->
<!-- ##### ARG GtkRange:slider-width ##### -->
<para>
</para>
<!-- ##### ARG GtkRange:trough-border ##### -->
<!-- ##### ARG GtkRange:arrow-displacement-y ##### -->
<para>
</para>
<!-- ##### ARG GtkRange:stepper-size ##### -->
<!-- ##### ARG GtkRange:arrow-displacement-x ##### -->
<para>
</para>
......
......@@ -54,32 +54,32 @@ The #GtkScrollbar struct does not contain any public data.
</para>
<!-- ##### ARG GtkScrollbar:has-secondary-backward-stepper ##### -->
<!-- ##### ARG GtkScrollbar:has-forward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-secondary-forward-stepper ##### -->
<!-- ##### ARG GtkScrollbar:has-secondary-backward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:fixed-slider-length ##### -->
<!-- ##### ARG GtkScrollbar:has-backward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:min-slider-length ##### -->
<!-- ##### ARG GtkScrollbar:has-secondary-forward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-forward-stepper ##### -->
<!-- ##### ARG GtkScrollbar:min-slider-length ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-backward-stepper ##### -->
<!-- ##### ARG GtkScrollbar:fixed-slider-length ##### -->
<para>
</para>
......
......@@ -107,11 +107,10 @@ Creates a new toggle button with a text label.
<!-- ##### FUNCTION gtk_toggle_button_set_mode ##### -->
<para>
Determines whether or not the toggle button is drawn on screen. The default mode is %FALSE, which results in the button being displayed. To make the button invisible, set <structfield>draw_indicator</structfield> to %TRUE.
</para>
@toggle_button: a #GtkToggleButton.
@draw_indicator: %TRUE or %FALSE.
@toggle_button:
@draw_indicator:
<!-- ##### FUNCTION gtk_toggle_button_get_mode ##### -->
......
......@@ -386,11 +386,6 @@ Should be used if you wish to perform an action when ever the style of a toolbar
</para>
<!-- ##### ARG GtkToolbar:space-size ##### -->
<para>
</para>
<!-- ##### ARG GtkToolbar:shadow-type ##### -->
<para>
......@@ -411,3 +406,8 @@ Should be used if you wish to perform an action when ever the style of a toolbar
</para>
<!-- ##### ARG GtkToolbar:space-size ##### -->
<para>
</para>
......@@ -227,7 +227,9 @@ selected rows. It will be called on every selected row in the view.
<!-- ##### SIGNAL GtkTreeSelection::changed ##### -->
<para>
Emitted whenever the selection has (possibly) changed. Please note that
this signal is
this signal is mostly a hint. It may only be emitted once when a range
of rows are selected, and it may occasionally be emitted when nothing
has happened.
</para>
@treeselection: the object which received the signal.
......
......@@ -901,27 +901,27 @@ Function used for #gtk_tree_view_map_expanded_rows.
</para>
<!-- ##### ARG GtkTreeView:vertical-separator ##### -->
<!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:expander-size ##### -->
<!-- ##### ARG GtkTreeView:indent-expanders ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
<!-- ##### ARG GtkTreeView:allow-rules ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:allow-rules ##### -->
<!-- ##### ARG GtkTreeView:expander-size ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:indent-expanders ##### -->
<!-- ##### ARG GtkTreeView:vertical-separator ##### -->
<para>
</para>
......
......@@ -2,32 +2,30 @@
GtkVButtonBox
<!-- ##### SECTION Short_Description ##### -->
a container for arranging buttons vertically.
a container for arranging buttons vertically
<!-- ##### SECTION Long_Description ##### -->
<para>
A button box should be used to provide a consistent layout of buttons
throughout your application. There is one default layout and a default
spacing value that are persistant across all #GtkVButtonBox widgets.
throughout your application. The layout/spacing can be altered by the
programmer, or if desired, by the user to alter the 'feel' of a
program to a small degree.
</para>
<para>
The layout/spacing can then be altered by the programmer, or if desired, by
the user to alter the 'feel' of a program to a small degree.
</para>
<para>
A #GtkVButtonBox is created with gtk_vbutton_box_new(). Buttons are packed into
a button box the same way as any other box, using gtk_box_pack_start() or
gtk_box_pack_end().
</para>
<para>
The default spacing between buttons can be set with
gtk_vbutton_box_set_spacing_default() and queried with
gtk_vbutton_box_get_spacing_default().
A #GtkVButtonBox is created with gtk_vbutton_box_new(). Buttons are
packed into a button box the same way widgets are added to any other
container, using gtk_container_add(). You can also use
gtk_box_pack_start() or gtk_box_pack_end(), but for button boxes both
these functions work just like gtk_container_add(), ie., they pack the
button in a way that depends on the current layout style and on
whether the button has had gtk_button_box_set_child_secondary() called
on it.
</para>
<para>
The arrangement and layout of the buttons can be changed using
gtk_vbutton_box_set_layout_default() and queried with
gtk_vbutton_box_get_layout_default().
The spacing between buttons can be set with gtk_box_set_spacing(). The
arrangement and layout of the buttons can be changed with
gtk_button_box_set_layout().
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -42,17 +40,16 @@ gtk_vbutton_box_get_layout_default().
</varlistentry>
<varlistentry>
<term>#GtkHButtonBox</term>
<listitem><para>Pack buttons horizontally.</para></listitem>
<listitem><para>Pack buttons horizontally</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### STRUCT GtkVButtonBox ##### -->
<para>
GtkVButtonBox does not contain any public fields.
</para>
<!-- ##### FUNCTION gtk_vbutton_box_new ##### -->
<para>
Creates a new vertical button box.
......
......@@ -2158,12 +2158,12 @@ a widget changes from un-anchored to anchored or vice-versa.
</para>
<!-- ##### ARG GtkWidget:has-focus ##### -->
<!-- ##### ARG GtkWidget:is-focus ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:is-focus ##### -->
<!-- ##### ARG GtkWidget:has-focus ##### -->
<para>
</para>
......@@ -2203,12 +2203,12 @@ a widget changes from un-anchored to anchored or vice-versa.
</para>
<!-- ##### ARG GtkWidget:interior-focus ##### -->
<!-- ##### ARG GtkWidget:focus-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:cursor-aspect-ratio ##### -->
<!-- ##### ARG GtkWidget:cursor-color ##### -->
<para>
</para>
......@@ -2218,22 +2218,22 @@ a widget changes from un-anchored to anchored or vice-versa.
</para>
<!-- ##### ARG GtkWidget:focus-line-pattern ##### -->
<!-- ##### ARG GtkWidget:interior-focus ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:cursor-color ##### -->
<!-- ##### ARG GtkWidget:focus-line-width ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:focus-padding ##### -->
<!-- ##### ARG GtkWidget:cursor-aspect-ratio ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:focus-line-width ##### -->
<!-- ##### ARG GtkWidget:focus-line-pattern ##### -->
<para>
</para>
......
......@@ -2412,11 +2412,12 @@ gtk_text_buffer_get_iter_at_line (GtkTextBuffer *buffer,
* gtk_text_buffer_get_iter_at_offset:
* @buffer: a #GtkTextBuffer
* @iter: iterator to initialize
* @char_offset: char offset from start of buffer, counting from 0
* @char_offset: char offset from start of buffer, counting from 0, or -1
*
* Initializes @iter to a position @char_offset chars from the start
* of the entire buffer.
*
* of the entire buffer. If @char_offset is -1 or greater than the number
* of characters in the buffer, @iter is initialized to the end iterator,
* the iterator one past the last valid character in the buffer.
**/
void
gtk_text_buffer_get_iter_at_offset (GtkTextBuffer *buffer,
......@@ -2437,7 +2438,6 @@ gtk_text_buffer_get_iter_at_offset (GtkTextBuffer *buffer,
* Initialized @iter with the first position in the text buffer. This
* is the same as using gtk_text_buffer_get_iter_at_offset() to get
* the iter at character offset 0.
*
**/
void
gtk_text_buffer_get_start_iter (GtkTextBuffer *buffer,
......
......@@ -250,6 +250,20 @@ gtk_toggle_button_get_property (GObject *object,
}
}
/**
* gtk_toggle_button_set_mode:
* @toggle_button: a #GtkToggleButton
* @draw_indicator: if %TRUE, draw the button as a separate indicator
* and label; if %FALSE, draw the button like a normal button
*
* Sets whether the button is displayed as a separate indicator and label.
* You can call this function on a checkbutton or a radiobutton with
* @draw_indicator = %FALSE to make the button look like a normal button
*
* This function only effects instances of classes like #GtkCheckButton
* and #GtkRadioButton that derive from #GtkToggleButton,
* not instances of #GtkToggleButton itself.
*/
void
gtk_toggle_button_set_mode (GtkToggleButton *toggle_button,