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()
  20 or gtk_font_selection_get_font_name().
  21 </para>
  22 <para>
  23 To change the text which is shown in the preview area, use
  24 gtk_font_selection_set_preview_text().
  25 </para>
  26 <para>
  27 Filters can be used to limit the fonts shown. There are 2 filters in the
  28 #GtkFontSelection - a base filter and a user filter. The base filter
  29 can not be changed by the user, so this can be used when the user must choose
  30 from the restricted set of fonts (e.g. for a terminal-type application you may
  31 want to force the user to select a fixed-width font). The user filter can be
  32 changed or reset by the user, by using the 'Reset Filter' button or changing
  33 the options on the 'Filter' page of the widget.
  34 </para>
  35
  36 <!-- ##### SECTION See_Also ##### -->
  37 <para>
  38 <variablelist>
  39
  40 <varlistentry>
  41 <term>#GtkFontSelectionDialog</term>
  42 <listitem><para>a dialog box which uses #GtkFontSelection.</para></listitem>
  43 </varlistentry>
  44
  45 </variablelist>
  46 </para>
  47
  48 <!-- ##### STRUCT GtkFontSelection ##### -->
  49 <para>
  50 The #GtkFontSelection struct contains private data only, and should
  51 only be accessed using the functions below.
  52 </para>
  53
  54
  55 <!-- ##### FUNCTION gtk_font_selection_new ##### -->
  56 <para>
  57 Creates a new #GtkFontSelection.
  58 </para>
  59
  60 @Returns: a new #GtkFontSelection.
  61
  62
  63 <!-- ##### FUNCTION gtk_font_selection_get_font ##### -->
  64 <para>
  65 Gets the currently-selected font.
  66 </para>
  67
  68 @fontsel: a #GtkFontSelection.
  69 @Returns: the currently-selected font, or NULL if no font is selected.
  70
  71
  72 <!-- ##### FUNCTION gtk_font_selection_get_font_name ##### -->
  73 <para>
  74 Gets the currently-selected font name.
  75 </para>
  76
  77 @fontsel: a #GtkFontSelection.
  78 @Returns:
  79
  80
  81 <!-- ##### FUNCTION gtk_font_selection_set_font_name ##### -->
  82 <para>
  83 Sets the currently-selected font.
  84 </para>
  85
  86 @fontsel: a #GtkFontSelection.
  87 @fontname: a fontname.
  88 @Returns: %TRUE if the font was found.
  89
  90
  91 <!-- ##### FUNCTION gtk_font_selection_get_preview_text ##### -->
  92 <para>
  93 Gets the text displayed in the preview area.
  94 </para>
  95
  96 @fontsel: a #GtkFontSelection.
  97 @Returns: the text displayed in the preview area. This string is
  98  owned by the widget and should not be modified or freed.
  99
 100
 101 <!-- ##### FUNCTION gtk_font_selection_set_preview_text ##### -->
 102 <para>
 103 Sets the text displayed in the preview area.
 104 </para>
 105
 106 @fontsel: a #GtkFontSelection.
 107 @text: the text to display in the preview area.
 108
 109
 110 <!-- ##### ARG GtkFontSelection:font ##### -->
 111 <para>
 112
 113 </para>
 114
 115 <!-- ##### ARG GtkFontSelection:font-name ##### -->
 116 <para>
 117
 118 </para>
 119
 120 <!-- ##### ARG GtkFontSelection:preview-text ##### -->
 121 <para>
 122
 123 </para>
 124