gtk2/docs/reference/gtk/tmpl/gtkfontsel.sgml
Owen Taylor 1a48dcb14f === Released 2.3.3 ===
Tue Feb 24 14:45:03 2004  Owen Taylor  <otaylor@redhat.com>

        * === Released 2.3.3 ===

        * configure.in: Version 2.3.3, interface age 0.

        * NEWS: Finish updates for 2.3.3.
2004-02-24 22:25:41 +00:00

116 lines
2.5 KiB
Plaintext

<!-- ##### 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()
or 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>
<!-- ##### STRUCT GtkFontSelection ##### -->
<para>
The #GtkFontSelection struct contains private data only, and should
only be accessed using the functions below.
</para>
<!-- ##### ARG GtkFontSelection:font ##### -->
<para>
</para>
<!-- ##### ARG GtkFontSelection:font-name ##### -->
<para>
</para>
<!-- ##### ARG GtkFontSelection:preview-text ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_font_selection_new ##### -->
<para>
Creates a new #GtkFontSelection.
</para>
@Returns: a new #GtkFontSelection.
<!-- ##### FUNCTION gtk_font_selection_get_font ##### -->
<para>
Gets the currently-selected font.
</para>
@fontsel: a #GtkFontSelection.
@Returns: the currently-selected font, or NULL if no font is selected.
<!-- ##### FUNCTION gtk_font_selection_get_font_name ##### -->
<para>
Gets the currently-selected font name.
</para>
@fontsel: a #GtkFontSelection.
@Returns:
<!-- ##### FUNCTION gtk_font_selection_set_font_name ##### -->
<para>
Sets the currently-selected font.
</para>
@fontsel: a #GtkFontSelection.
@fontname: a fontname.
@Returns: %TRUE if the font was found.
<!-- ##### FUNCTION gtk_font_selection_get_preview_text ##### -->
<para>
Gets the text displayed in the preview area.
</para>
@fontsel: a #GtkFontSelection.
@Returns: the text displayed in the preview area. This string is
owned by the widget and should not be modified or freed.
<!-- ##### FUNCTION gtk_font_selection_set_preview_text ##### -->
<para>
Sets the text displayed in the preview area.
</para>
@fontsel: a #GtkFontSelection.
@text: the text to display in the preview area.