Commit 39179e34 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkFontSelection

parent fe65ec5b
......@@ -43,6 +43,7 @@ gtkfilechooserdialog.sgml
gtkfilechooserwidget.sgml
gtkfilefilter.sgml
gtkfontbutton.sgml
gtkfontsel.sgml
gtkframe.sgml
gtkhbbox.sgml
gtkhbox.sgml
......
<!-- ##### SECTION Title ##### -->
GtkFontSelection
<!-- ##### SECTION Short_Description ##### -->
A widget for selecting fonts
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkFontSelection widget lists the available fonts, styles and sizes,
allowing the user to select a font.
It is used in the #GtkFontSelectionDialog widget to provide a dialog box for
selecting fonts.
</para>
<para>
To set the font which is initially selected, use
gtk_font_selection_set_font_name().
</para>
<para>
To get the selected font use gtk_font_selection_get_font_name().
</para>
<para>
To change the text which is shown in the preview area, use
gtk_font_selection_set_preview_text().
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkFontSelectionDialog</term>
<listitem><para>a dialog box which uses #GtkFontSelection.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkFontSelection ##### -->
<para>
The #GtkFontSelection struct contains private data only, and should
only be accessed using the functions below.
</para>
<!-- ##### ARG GtkFontSelection:font-name ##### -->
<para>
</para>
<!-- ##### ARG GtkFontSelection:preview-text ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_font_selection_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_font_name ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_set_font_name ##### -->
<para>
</para>
@fontsel:
@fontname:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_preview_text ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_set_preview_text ##### -->
<para>
</para>
@fontsel:
@text:
<!-- ##### FUNCTION gtk_font_selection_get_face ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_face_list ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_family ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_size ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_family_list ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_preview_entry ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_size_entry ##### -->
<para>
</para>
@fontsel:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_get_size_list ##### -->
<para>
</para>
@fontsel:
@Returns:
......@@ -58,6 +58,28 @@
#include "gtkbuildable.h"
#include "gtkprivate.h"
/**
* SECTION:gtkfontsel
* @Short_description: A widget for selecting fonts
* @Title: GtkFontSelection
* @See_also: #GtkFontSelectionDialog
*
* The #GtkFontSelection widget lists the available fonts, styles and sizes,
* allowing the user to select a font.
* It is used in the #GtkFontSelectionDialog widget to provide a dialog box for
* selecting fonts.
*
* To set the font which is initially selected, use
* gtk_font_selection_set_font_name().
*
* To get the selected font use gtk_font_selection_get_font_name().
*
* To change the text which is shown in the preview area, use
* gtk_font_selection_set_preview_text().
*/
struct _GtkFontSelectionPrivate
{
GtkWidget *font_entry; /* Used _get_family_entry() for consistency, -mr */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment