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
  27 <!-- ##### SECTION See_Also ##### -->
  28 <para>
  29 <variablelist>
  30
  31 <varlistentry>
  32 <term>#GtkFontSelectionDialog</term>
  33 <listitem><para>a dialog box which uses #GtkFontSelection.</para></listitem>
  34 </varlistentry>
  35
  36 </variablelist>
  37 </para>
  38
  39 <!-- ##### STRUCT GtkFontSelection ##### -->
  40 <para>
  41 The #GtkFontSelection struct contains private data only, and should
  42 only be accessed using the functions below.
  43 </para>
  44
  45
  46 <!-- ##### FUNCTION gtk_font_selection_new ##### -->
  47 <para>
  48 Creates a new #GtkFontSelection.
  49 </para>
  50
  51 @Returns: a new #GtkFontSelection.
  52
  53
  54 <!-- ##### FUNCTION gtk_font_selection_get_font ##### -->
  55 <para>
  56 Gets the currently-selected font.
  57 </para>
  58
  59 @fontsel: a #GtkFontSelection.
  60 @Returns: the currently-selected font, or NULL if no font is selected.
  61
  62
  63 <!-- ##### FUNCTION gtk_font_selection_get_font_name ##### -->
  64 <para>
  65 Gets the currently-selected font name.
  66 </para>
  67
  68 @fontsel: a #GtkFontSelection.
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION gtk_font_selection_set_font_name ##### -->
  73 <para>
  74 Sets the currently-selected font.
  75 </para>
  76
  77 @fontsel: a #GtkFontSelection.
  78 @fontname: a fontname.
  79 @Returns: %TRUE if the font was found.
  80
  81
  82 <!-- ##### FUNCTION gtk_font_selection_get_preview_text ##### -->
  83 <para>
  84 Gets the text displayed in the preview area.
  85 </para>
  86
  87 @fontsel: a #GtkFontSelection.
  88 @Returns: the text displayed in the preview area. This string is
  89  owned by the widget and should not be modified or freed.
  90
  91
  92 <!-- ##### FUNCTION gtk_font_selection_set_preview_text ##### -->
  93 <para>
  94 Sets the text displayed in the preview area.
  95 </para>
  96
  97 @fontsel: a #GtkFontSelection.
  98 @text: the text to display in the preview area.
  99
 100
 101 <!-- ##### ARG GtkFontSelection:font ##### -->
 102 <para>
 103
 104 </para>
 105
 106 <!-- ##### ARG GtkFontSelection:font-name ##### -->
 107 <para>
 108
 109 </para>
 110
 111 <!-- ##### ARG GtkFontSelection:preview-text ##### -->
 112 <para>
 113
 114 </para>
 115