[gtkmm] gtk/src/gtk_docs.xml: Regenerated.
- From: Murray Cumming <murrayc src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtkmm] gtk/src/gtk_docs.xml: Regenerated.
- Date: Mon, 21 Sep 2009 11:45:57 +0000 (UTC)
commit dcb749cb3115bb7705ed4d2dcb81c2645d56d367
Author: Murray Cumming <murrayc murrayc com>
Date: Mon Sep 21 13:45:38 2009 +0200
gtk/src/gtk_docs.xml: Regenerated.
ChangeLog | 4 +
gtk/src/gtk_docs.xml | 350 +++++++++++++++++++++++++++++++++++---------------
2 files changed, 252 insertions(+), 102 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index bc89788..1974e22 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2.18.0:
+2009-09-21 Murray Cumming <murrayc murrayc com>
+
+ * gtk/src/gtk_docs.xml: Regenerated.
+
2009-09-21 Murray Cumming <murrayc murrayc-desktop>
Regenerate enums .defs.
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index 914eaab..09c2aeb 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -300,7 +300,6 @@ user may save; for example, when the user opens an existing file and then
does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
a file name already — for example, if the user just created a new
file and is saving it for the first time, do not call this function.
-]|
</description>
@@ -1862,6 +1861,29 @@ Since: 2.10
</return>
</function>
+<function name="gtk_range_set_flippable">
+<description>
+If a range is flippable, it will switch its direction if it is
+horizontal and its direction is %GTK_TEXT_DIR_RTL.
+
+See gtk_widget_get_direction().
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="flippable">
+<parameter_description> %TRUE to make the range flippable
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_spin_button_set_numeric">
<description>
Sets the flag that determines if non-numeric text can be typed into
@@ -3429,7 +3451,6 @@ if the state is wildcarded. Therefore, you should usually
call gtk_icon_source_set_state_wildcarded() to un-wildcard it
in addition to calling this function.
-
</description>
<parameters>
<parameter name="source">
@@ -6290,7 +6311,6 @@ user may save; for example, when the user opens an existing file and then
does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
a file name already — for example, if the user just created a new
file and is saving it for the first time, do not call this function.
-]|
</description>
@@ -6371,7 +6391,6 @@ if the size is wildcarded. Therefore, you should usually
call gtk_icon_source_set_size_wildcarded() to un-wildcard it
in addition to calling this function.
-
</description>
<parameters>
<parameter name="source">
@@ -8810,6 +8829,24 @@ Since: 2.10
<return></return>
</function>
+<function name="gtk_range_get_flippable">
+<description>
+Gets the value set by gtk_range_set_flippable().
+
+
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the range is flippable
+
+Since: 2.18
+</return>
+</function>
+
<function name="gtk_entry_set_position">
<description>
Sets the cursor position in an entry to the given value.
@@ -8914,6 +8951,28 @@ Deprecated: 2.16: Use gtk_orientable_get_orientation() instead.
</return>
</function>
+<function name="_gtk_window_set_is_toplevel">
+<description>
+Internal function used by #GtkPlug when it gets parented/unparented by a
+#GtkSocket. This keeps the @window's #GTK_TOPLEVEL flag in sync with the
+global list of toplevel windows.
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="is_toplevel">
+<parameter_description> %TRUE if the window is still a real toplevel (nominally a
+parent of the root window); %FALSE if it is not (for example, for an
+in-process, parented GtkPlug)
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_hsv_to_rgb">
<description>
Converts a color from HSV space to RGB.
@@ -11923,6 +11982,7 @@ Since: 2.10
<function name="gtk_cell_renderer_get_sensitive">
<description>
+Returns: %TRUE if the cell renderer is sensitive
</description>
<parameters>
@@ -11931,7 +11991,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return>the cell renderer's sensitivity.
+<return> %TRUE if the cell renderer is sensitive
Since: 2.18
</return>
@@ -13049,30 +13109,6 @@ Since: 2.10
</return>
</function>
-<function name="gtk_cell_renderer_set_padding">
-<description>
-Sets the renderer's padding.
-
-Since: 2.18
-
-</description>
-<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="xpad">
-<parameter_description> the x padding of the cell renderer
-</parameter_description>
-</parameter>
-<parameter name="ypad">
-<parameter_description> the y padding of the cell renderer
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
<function name="gtk_widget_has_grab">
<description>
Determines whether the widget is currently grabbing events, so it
@@ -13782,7 +13818,7 @@ Return value: mark name
<function name="gtk_icon_set_copy">
<description>
-Copies @icon_set by value.
+Copies @icon_set by value.
</description>
@@ -14094,22 +14130,24 @@ there are too many tabs to fit in the area.
<return></return>
</function>
-<function name="_gtk_windwo_set_is_toplevel">
+<function name="gtk_cell_renderer_set_padding">
<description>
-Internal function used by #GtkPlug when it gets parented/unparented by a
-#GtkSocket. This keeps the @window's #GTK_TOPLEVEL flag in sync with the
-global list of toplevel windows.
+Sets the renderer's padding.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="is_toplevel">
-<parameter_description> %TRUE if the window is still a real toplevel (nominally a
-parent of the root window); %FALSE if it is not (for example, for an
-in-process, parented GtkPlug)
+<parameter name="xpad">
+<parameter_description> the x padding of the cell renderer
+</parameter_description>
+</parameter>
+<parameter name="ypad">
+<parameter_description> the y padding of the cell renderer
</parameter_description>
</parameter>
</parameters>
@@ -14347,7 +14385,7 @@ DND operation, or -1.
<function name="gtk_icon_source_set_filename">
<description>
Sets the name of an image file to use as a base image when creating
-icon variants for #GtkIconSet. The filename must be absolute.
+icon variants for #GtkIconSet. The filename must be absolute.
</description>
<parameters>
@@ -17779,6 +17817,31 @@ Since: 2.6
</return>
</function>
+<function name="gtk_widget_set_receives_default">
+<description>
+Specifies whether @widget will be treated as the default widget
+within its toplevel when it has the focus, even if another widget
+is the default.
+
+See gtk_widget_grab_default() for details about the meaning of
+"default".
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="receives_default">
+<parameter_description> whether or not @widget can be a default widget.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_text_buffer_get_iter_at_line_offset">
<description>
Obtains an iterator pointing to @char_offset within the given
@@ -17967,7 +18030,6 @@ override your application's default icons. If an icon already
existed in @factory for @stock_id, it is unreferenced and replaced
with the new @icon_set.
-
</description>
<parameters>
<parameter name="factory">
@@ -19108,7 +19170,8 @@ folder.
</parameter_description>
</parameter>
</parameters>
-<return> a selected #GFile
+<return> a selected #GFile. You own the returned file; use
+g_object_unref() to release it.
Since: 2.14
</return>
@@ -19792,7 +19855,7 @@ Since: 2.4
<function name="gtk_icon_source_get_direction">
<description>
Obtains the text direction this icon source applies to. The return
-value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
+value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
wildcarded.
@@ -23740,6 +23803,7 @@ Please note that nodes that are deleted are not unreffed.
<function name="gtk_widget_is_sensitive">
<description>
+Returns: %TRUE if the widget is effectively sensitive
</description>
<parameters>
@@ -23748,8 +23812,7 @@ Please note that nodes that are deleted are not unreffed.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is effectively sensitive, which means
-it is sensitive itself and also its parent widget is sensntive
+<return> %TRUE if the widget is effectively sensitive
Since: 2.18
</return>
@@ -24035,7 +24098,6 @@ etc. Returns the integer value for the size.
</parameter>
</parameters>
<return> integer value representing the size
-
</return>
</function>
@@ -25200,6 +25262,7 @@ To reliably find the toplevel #GtkWindow, use
gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
is set on the result.
+
</description>
<parameters>
<parameter name="widget">
@@ -26654,6 +26717,27 @@ Gets the value set by gtk_range_set_inverted().
</return>
</function>
+<function name="gtk_about_dialog_set_program_name">
+<description>
+Sets the name to display in the about dialog.
+If this is not set, it defaults to g_get_application_name().
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the program name
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_file_chooser_select_uri">
<description>
Selects the file to by @uri. If the URI doesn't refer to a
@@ -27760,21 +27844,28 @@ Since: 2.2
</return>
</function>
-<function name="gtk_about_dialog_set_program_name">
+<function name="gtk_widget_set_window">
<description>
-Sets the name to display in the about dialog.
-If this is not set, it defaults to g_get_application_name().
+Sets a widget's window. This function should only be used in a
+widget's GtkWidget::realize() implementation. The %window passed is
+usually either new window created with gdk_window_new(), or the
+window of its parent widget as returned by
+gtk_widget_get_parent_window().
-Since: 2.12
+Widgets must indicate whether they will create their own #GdkWindow
+by calling gtk_widget_set_has_window(). This is usually done in the
+widget's init() function.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the program name
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
@@ -28483,7 +28574,6 @@ add the sources to the icon set does not matter.
gtk_icon_set_new_from_pixbuf() creates a new icon set with a
default icon source based on the given pixbuf.
-
</description>
<parameters>
<parameter name="icon_set">
@@ -29390,6 +29480,7 @@ to be called when the window has its "final" size, i.e. after calling
gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints()
on the window.
+
</description>
<parameters>
<parameter name="window">
@@ -31172,7 +31263,6 @@ are using.
Obtains a list of icon sizes this icon set can render. The returned
array must be freed with g_free().
-
</description>
<parameters>
<parameter name="icon_set">
@@ -31804,7 +31894,6 @@ Removes an icon factory from the list of default icon
factories. Not normally used; you might use it for a library that
can be unloaded or shut down.
-
</description>
<parameters>
<parameter name="factory">
@@ -32149,7 +32238,6 @@ There will normally be an icon factory added for each library or
application that comes with icons. The default icon factories
can be overridden by themes.
-
</description>
<parameters>
<parameter name="factory">
@@ -32549,7 +32637,7 @@ you should use this function if you already have a file name to which the
user may save; for example, when the user opens an existing file and then
does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
a file name already — for example, if the user just created a new
-file and is saving it for the first time, do not call this function.
+file and is saving it for the first time, do not call this function.
</description>
@@ -35517,6 +35605,26 @@ Since: 2.4
</return>
</function>
+<function name="gtk_widget_has_default">
+<description>
+Determines whether @widget is the current default widget within its
+toplevel. See gtk_widget_set_can_default().
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @widget is the current default widget within
+its toplevel, %FALSE otherwise
+
+Since: 2.18
+</return>
+</function>
+
<function name="gtk_drag_dest_add_text_targets">
<description>
Add the text targets supported by #GtkSelection to
@@ -36195,7 +36303,6 @@ Registers @alias as another name for @target.
So calling gtk_icon_size_from_name() with @alias as argument
will return @target.
-
</description>
<parameters>
<parameter name="alias">
@@ -38935,7 +39042,7 @@ up additional columns in a #GtkComboBox.
Note that GTK+ doesn't guarantee that cell renderers will
continue to use the same kind of widget for editing in future
releases, therefore you should check the type of @editable
-before doing any specific setup, as in the following example:
+before doing any specific setup.
Since: 2.6
@@ -40266,7 +40373,7 @@ The function is used for all stock items whose
to use strings different from the actual gettext translation domain
of your application for this, as long as your #GtkTranslateFunc uses
the correct domain when calling dgettext(). This can be useful, e.g.
-when dealing with message contexts.
+when dealing with message contexts. file and is saving it for the first time, do not call this function.
Since: 2.8
@@ -40851,6 +40958,7 @@ Since: 2.10
<function name="gtk_cell_renderer_get_visible">
<description>
+Returns: %TRUE if the cell renderer is visible
</description>
<parameters>
@@ -40859,7 +40967,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return>the cell renderer's visibility.
+<return> %TRUE if the cell renderer is visible
Since: 2.18
</return>
@@ -44711,6 +44819,25 @@ Since: 2.10
</return>
</function>
+<function name="gtk_window_get_opacity">
+<description>
+Fetches the requested opacity for this window. See
+gtk_window_set_opacity().
+
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+</parameters>
+<return> the requested opacity for this window.
+
+Since: 2.12
+</return>
+</function>
+
<function name="gtk_editable_cut_clipboard">
<description>
Removes the contents of the currently selected content in the editable and
@@ -46002,6 +46129,25 @@ bouncing block for each call to gtk_progress_bar_pulse().
<return></return>
</function>
+<function name="gtk_widget_is_drawable">
+<description>
+Determines whether @widget can be drawn to. A widget can be drawn
+to if it is mapped and visible.
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @widget is drawable, %FALSE otherwise
+
+Since: 2.18
+</return>
+</function>
+
<function name="gtk_cell_view_new_with_pixbuf">
<description>
Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
@@ -47092,7 +47238,6 @@ using this function directly, so that themes are taken into
account.
-
</description>
<parameters>
<parameter name="stock_id">
@@ -54653,7 +54798,7 @@ modified or freed.
<function name="gtk_icon_size_get_name">
<description>
-Gets the canonical name of the given icon size. The returned string
+Gets the canonical name of the given icon size. The returned string
is statically allocated and should not be freed.
</description>
@@ -56405,7 +56550,6 @@ will only be used with that text direction.
#GtkIconSet prefers non-wildcarded sources (exact matches) over
wildcarded sources, and will use an exact match when possible.
-
</description>
<parameters>
<parameter name="source">
@@ -56658,22 +56802,23 @@ can later be plugged into a #GtkSocket by gtk_socket_add_id().
</return>
</function>
-<function name="gtk_window_get_opacity">
+<function name="gtk_widget_is_toplevel">
<description>
-Fetches the requested opacity for this window. See
-gtk_window_set_opacity().
+Determines whether @widget is a toplevel widget. Currently only
+#GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
+widgets have no parent widget.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the requested opacity for this window.
+<return> %TRUE if @widget is a toplevel, %FALSE otherwise
-Since: 2.12
+Since: 2.18
</return>
</function>
@@ -60257,6 +60402,7 @@ Gets the current mode of the size group. See gtk_size_group_set_mode().
<function name="gtk_widget_get_sensitive">
<description>
+Returns: %TRUE if the widget is sensitive
</description>
<parameters>
@@ -60265,10 +60411,7 @@ Gets the current mode of the size group. See gtk_size_group_set_mode().
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is sensitive (in the sense of returning
-the value that has been set using gtk_widget_set_sensitive()). The
-effective sensitivity of a widget is however determined by both its
-own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
+<return> %TRUE if the widget is sensitive
Since: 2.18
</return>
@@ -61083,6 +61226,7 @@ Since: 2.4
<function name="gtk_widget_get_state">
<description>
+Returns: the state of @widget.
</description>
<parameters>
@@ -61091,7 +61235,7 @@ Since: 2.4
</parameter_description>
</parameter>
</parameters>
-<return> the state of @widget. See gtk_widget_set_state().
+<return> the state of @widget.
Since: 2.18
</return>
@@ -61167,7 +61311,7 @@ look different when insensitive; and it might change size depending
on toolbar mode (small/large icons). So a single icon set would
contain all those variants of the icon. #GtkIconSet contains a list
of #GtkIconSource from which it can derive specific icon variants in
-the set.
+the set.
In the simplest case, #GtkIconSet contains one source pixbuf from
which it derives all variants. The convenience function
@@ -64502,6 +64646,29 @@ Return value: the currently pushed colormap, or %NULL if there is none.
</return>
</function>
+<function name="gtk_widget_get_receives_default">
+<description>
+Determines whether @widget is alyways treated as default widget
+withing its toplevel when it has the focus, even if another widget
+is the default.
+
+See gtk_widget_set_receives_default().
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @widget acts as default widget when focussed,
+%FALSE otherwise
+
+Since: 2.18
+</return>
+</function>
+
<function name="gtk_message_dialog_format_secondary_markup">
<description>
Sets the secondary text of the message dialog to be @message_format (with
@@ -67264,7 +67431,7 @@ longer needed.
<function name="gtk_icon_size_lookup_for_settings">
<description>
Obtains the pixel size of a semantic icon size, possibly
-modified by user preferences for a particular
+modified by user preferences for a particular
#GtkSettings. Normally @size would be
#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
isn't normally needed, gtk_widget_render_icon() is the usual
@@ -67899,26 +68066,6 @@ Since: 2.10
</return>
</function>
-<function name="gtk_widget_get_has_default">
-<description>
-Determines whether @widget is the current default widget within its
-toplevel. See gtk_widget_set_can_default().
-
-
-</description>
-<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if @widget is the current default widget within
-its toplevel, %FALSE otherwise
-
-Since: 2.18
-</return>
-</function>
-
<function name="gtk_status_icon_get_blinking">
<description>
Return value: %TRUE if the icon is blinking
@@ -68486,7 +68633,6 @@ if the text direction is wildcarded. Therefore, you should usually
call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
in addition to calling this function.
-
</description>
<parameters>
<parameter name="source">
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
