Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkfontsel.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkFontSelection
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget for selecting fonts
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkFontSelection widget lists the available fonts, styles and sizes,
  10 allowing the user to select a font.
  11 It is used in the #GtkFontSelectionDialog widget to provide a dialog box for
  12 selecting fonts.
  13 </para>
  14 <para>
  15 To set the font which is initially selected, use
  16 gtk_font_selection_set_font_name().
  17 </para>
  18 <para>
  19 To get the selected font use gtk_font_selection_get_font_name().
  20 </para>
  21 <para>
  22 To change the text which is shown in the preview area, use
  23 gtk_font_selection_set_preview_text().
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28 <variablelist>
  29
  30 <varlistentry>
  31 <term>#GtkFontSelectionDialog</term>
  32 <listitem><para>a dialog box which uses #GtkFontSelection.</para></listitem>
  33 </varlistentry>
  34
  35 </variablelist>
  36 </para>
  37
  38 <!-- ##### SECTION Stability_Level ##### -->
  39
  40
  41 <!-- ##### STRUCT GtkFontSelection ##### -->
  42 <para>
  43 The #GtkFontSelection struct contains private data only, and should
  44 only be accessed using the functions below.
  45 </para>
  46
  47
  48 <!-- ##### ARG GtkFontSelection:font ##### -->
  49 <para>
  50
  51 </para>
  52
  53 <!-- ##### ARG GtkFontSelection:font-name ##### -->
  54 <para>
  55
  56 </para>
  57
  58 <!-- ##### ARG GtkFontSelection:preview-text ##### -->
  59 <para>
  60
  61 </para>
  62
  63 <!-- ##### FUNCTION gtk_font_selection_new ##### -->
  64 <para>
  65 Creates a new #GtkFontSelection.
  66 </para>
  67
  68 @Returns: a new #GtkFontSelection.
  69
  70
  71 <!-- ##### FUNCTION gtk_font_selection_get_font ##### -->
  72 <para>
  73 Gets the currently-selected font.
  74 </para>
  75
  76 @fontsel: a #GtkFontSelection.
  77 @Returns: the currently-selected font, or NULL if no font is selected.
  78
  79
  80 <!-- ##### FUNCTION gtk_font_selection_get_font_name ##### -->
  81 <para>
  82 </para>
  83
  84 @fontsel:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION gtk_font_selection_set_font_name ##### -->
  89 <para>
  90 </para>
  91
  92 @fontsel:
  93 @fontname:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION gtk_font_selection_get_preview_text ##### -->
  98 <para>
  99 Gets the text displayed in the preview area.
 100 </para>
 101
 102 @fontsel: a #GtkFontSelection.
 103 @Returns: the text displayed in the preview area. This string is
 104  owned by the widget and should not be modified or freed.
 105
 106
 107 <!-- ##### FUNCTION gtk_font_selection_set_preview_text ##### -->
 108 <para>
 109 Sets the text displayed in the preview area.
 110 </para>
 111
 112 @fontsel: a #GtkFontSelection.
 113 @text: the text to display in the preview area.
 114
 115
 116 <!-- ##### FUNCTION gtk_font_selection_dialog_get_apply_button ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @fsd:
 122 @Returns:
 123
 124
 125 <!-- ##### FUNCTION gtk_font_selection_dialog_get_cancel_button ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @fsd:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION gtk_font_selection_dialog_get_ok_button ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @fsd:
 140 @Returns:
 141
 142
 143 <!-- ##### FUNCTION gtk_font_selection_get_face ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @fontsel:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION gtk_font_selection_get_face_entry ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @fontsel:
 158 @Returns:
 159
 160
 161 <!-- ##### FUNCTION gtk_font_selection_get_face_list ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @fontsel:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION gtk_font_selection_get_family ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @fontsel:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION gtk_font_selection_get_size ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @fontsel:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION gtk_font_selection_get_family_entry ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @fontsel:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION gtk_font_selection_get_family_list ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @fontsel:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_font_selection_get_preview_entry ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @fontsel:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION gtk_font_selection_get_size_entry ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @fontsel:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION gtk_font_selection_get_size_list ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @fontsel:
 230 @Returns:
 231
 232