gtkmm r1098 - in trunk: . gtk/src

[murrayc svn gnome org]

Author: murrayc
Date: Thu Feb 19 18:12:31 2009
New Revision: 1098
URL: http://svn.gnome.org/viewvc/gtkmm?rev=1098&view=rev

Log:
2009-02-19  Murray Cumming  <murrayc murrayc com>

* gtk/src/gtk_docs_override.xml: Fixed the documentation for 
Widget::set_tooltip_markup(), Widget::get_snapshot(), and 
Widget::get_composite_name() to not mention NULL strings and freeing.
Mentioned by some guy on irc who couldn't be bothered to submit a bug.

Modified:
   trunk/ChangeLog
   trunk/gtk/src/gtk_docs_override.xml

Modified: trunk/gtk/src/gtk_docs_override.xml
==============================================================================
--- trunk/gtk/src/gtk_docs_override.xml	(original)
+++ trunk/gtk/src/gtk_docs_override.xml	Thu Feb 19 18:12:31 2009
@@ -978,6 +978,50 @@
 <return></return>
 </function>
 
+<function name="gtk_widget_set_tooltip_markup">
+<description>
+Sets @markup as the contents of the tooltip, which is marked up with
+the &lt;link linkend=&quot;PangoMarkupFormat&quot;&gt;Pango text markup language&lt;/link&gt;.
+
+This function will take care of setting GtkWidget:has-tooltip to %TRUE
+and of the default handler for the GtkWidget::query-tooltip signal.
+
+See also the GtkWidget:tooltip-markup property and
+gtk_tooltip_set_markup().
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="markup">
+<parameter_description> the contents of the tooltip for @widget.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_widget_get_composite_name">
+<description>
+Obtains the composite name of a widget. 
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return> the composite name of @widget, or an emoty string if @widget is not
+a composite child.
+</return>
+</function>
+
 <function name="gtk_window_set_default">
 <description>
 The default widget is the widget that&apos;s activated when the user
@@ -1001,6 +1045,53 @@
 <return></return>
 </function>
 
+<function name="gtk_widget_get_snapshot">
+<description>
+Create a #GdkPixmap of the contents of the widget and its children.
+
+Works even if the widget is obscured. The depth and visual of the
+resulting pixmap is dependent on the widget being snapshot and likely
+differs from those of a target widget displaying the pixmap.
+The function gdk_pixbuf_get_from_drawable() can be used to convert
+the pixmap to a visual independant representation.
+
+The snapshot area used by this function is the @widget's allocation plus
+any extra space occupied by additional windows belonging to this widget
+(such as the arrows of a spin button).
+Thus, the resulting snapshot pixmap is possibly larger than the allocation.
+
+The resulting pixmap is shrunken to
+match the specified clip_rect. The (x,y) coordinates of @clip_rect are
+interpreted widget relative. If width or height of @clip_rect are 0 or
+negative, the width or height of the resulting pixmap will be shrunken
+by the respective amount.
+For instance a @clip_rect &lt;literal&gt;{ +5, +5, -10, -10 }&lt;/literal&gt; will
+chop off 5 pixels at each side of the snapshot pixmap.
+If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
+coordinates upon return. A @clip_rect of &lt;literal&gt;{ -1, -1, 0, 0 }&lt;/literal&gt;
+can be used to preserve the auto-grown snapshot area and use @clip_rect
+as a pure output parameter.
+
+The returned pixmap can be an empty RefPtr, if the resulting @clip_area was empty.
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description>    a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="clip_rect">
+<parameter_description> a #GdkRectangle
+</parameter_description>
+</parameter>
+</parameters>
+<return> #GdkPixmap snapshot of the widget
+
+Since: 2.14
+</return>
+</function>
+
 <function name="gtk_window_set_focus">
 <description>
 If @focus is not the current focus widget, and is focusable, sets