gtk2/docs/reference/gtk/tmpl/gtkfontseldlg.sgml
Matthias Clasen e5ce8697ea Document GtkBuilder UI definitions
svn path=/trunk/; revision=18332
2007-07-01 23:38:07 +00:00

114 lines
2.8 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkFontSelectionDialog
<!-- ##### SECTION Short_Description ##### -->
A dialog box for selecting fonts
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkFontSelectionDialog widget is a dialog box for selecting a font.
</para>
<para>
To set the font which is initially selected, use
gtk_font_selection_dialog_set_font_name().
</para>
<para>
To get the selected font use gtk_font_selection_dialog_get_font_name().
</para>
<para>
To change the text which is shown in the preview area, use
gtk_font_selection_dialog_set_preview_text().
</para>
<refsect2 id="GtkFontSelectionDialog-BUILDER-UI">
<title>GtkFontSelectionDialog as GtkBuildable</title>
<para>
The GtkFontSelectionDialog implementation of the GtkBuildable interface
exposes the embedded #GtkFontSelection as internal child with the
name "font_selection". It also exposes the buttons with the names
"ok_button", "cancel_button" and "apply_button".
</para>
</refsect2>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkFontSelection</term>
<listitem><para>the underlying widget for selecting
fonts.</para></listitem>
<term>#GtkDialog</term>
<listitem><para>the parent class of GtkFontSelectionDialog</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkFontSelectionDialog ##### -->
@ok_button: The OK button of the dialog
@apply_button: The Apply button of the dialog. This button is hidden
by default but you can show/hide it
@cancel_button: The Cancel button of the dialog
<!-- ##### FUNCTION gtk_font_selection_dialog_new ##### -->
<para>
Creates a new #GtkFontSelectionDialog.
</para>
@title: the title of the dialog box.
@Returns: a new #GtkFontSelectionDialog.
<!-- ##### FUNCTION gtk_font_selection_dialog_get_font ##### -->
<para>
Gets the currently-selected font.
</para>
@fsd: a #GtkFontSelectionDialog.
@Returns: the currently-selected font, or %NULL if no font is selected.
<!-- ##### FUNCTION gtk_font_selection_dialog_get_font_name ##### -->
<para>
</para>
@fsd:
@Returns:
<!-- ##### FUNCTION gtk_font_selection_dialog_set_font_name ##### -->
<para>
Sets the currently-selected font.
</para>
@fsd: a #GtkFontSelectionDialog.
@fontname: a fontname.
@Returns: %TRUE if the font was found.
<!-- ##### FUNCTION gtk_font_selection_dialog_get_preview_text ##### -->
<para>
Gets the text displayed in the preview area.
</para>
@fsd: a #GtkFontSelectionDialog.
@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_dialog_set_preview_text ##### -->
<para>
Sets the text displayed in the preview area.
</para>
@fsd: a #GtkFontSelectionDialog.
@text: the text to display in the preview area.