summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkfontseldlg.sgml
blob: b97ff929d8a9026cbb6f7562d249acf4b07d7f71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<!-- ##### 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.