gtk2/docs/reference/gtk/tmpl/gtkfontseldlg.sgml
Matthias Clasen 01780084d5 Remove leftover documentation of the filter functionality that got removed
Fri Nov 21 00:09:36 2003  Matthias Clasen  <maclas@gmx.de>

	* gtk/tmpl/gtkfontsel.sgml:
	* gtk/tmpl/gtkfontseldlg.sgml: Remove leftover documentation of
	the filter functionality that got removed long ago.
2003-11-20 23:10:05 +00:00

103 lines
2.5 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()
or 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>
<!-- ##### 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>
<!-- ##### 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>
Gets the currently-selected font name.
</para>
@fsd: a #GtkFontSelectionDialog.
@Returns: the currently-selected font name, or %NULL if no font is selected.
<!-- ##### 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.