summaryrefslogtreecommitdiff
path: root/gtk/gtkfontbutton.c
diff options
context:
space:
mode:
authorSven Herzberg <sven@imendio.com>2008-12-03 13:15:39 +0000
committerSven Herzberg <herzi@src.gnome.org>2008-12-03 13:15:39 +0000
commitb07127231e8343e0f41575fbbe473f570dd6c814 (patch)
treecd1becf4c0e8f7beeb64b47c0b63c65a58dd1869 /gtk/gtkfontbutton.c
parentd18e98388c102049e60a2bdcc9e489c4c7c647d3 (diff)
downloadgtk+-b07127231e8343e0f41575fbbe473f570dd6c814.tar.gz
Bug 562998 – GtkFontButton documentation improvements
2008-12-03 Sven Herzberg <sven@imendio.com> Bug 562998 – GtkFontButton documentation improvements * gtk/gtkfontbutton.c: mention the way the font string should be used. Patch by Sven Herzberg and Nelson Benitez svn path=/trunk/; revision=21842
Diffstat (limited to 'gtk/gtkfontbutton.c')
-rw-r--r--gtk/gtkfontbutton.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/gtk/gtkfontbutton.c b/gtk/gtkfontbutton.c
index a4c6788cdb..362860254b 100644
--- a/gtk/gtkfontbutton.c
+++ b/gtk/gtkfontbutton.c
@@ -628,7 +628,12 @@ gtk_font_button_set_show_size (GtkFontButton *font_button,
* gtk_font_button_get_font_name:
* @font_button: a #GtkFontButton
*
- * Retrieves the name of the currently selected font.
+ * Retrieves the name of the currently selected font. This name includes
+ * style and size information as well. If you want to render something
+ * with the font, use this string with pango_font_description_from_string() .
+ * If you're interested in peeking certain values (family name,
+ * style, size, weight) just query these properties from the
+ * #PangoFontDescription object.
*
* Returns: an internal copy of the font name which must not be freed.
*