]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtkfontseldlg.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtkfontseldlg.sgml
index a1df4d803817e4f02ce8c097a5c01fbbb717c8c4..6e98aa799260b5334cf42a233efd1caafa05106e 100644 (file)
@@ -2,7 +2,7 @@
 GtkFontSelectionDialog
 
 <!-- ##### SECTION Short_Description ##### -->
-a dialog box for selecting fonts.
+A dialog box for selecting fonts
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -13,45 +13,22 @@ 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().
+To get the selected font use 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>
-<para>
-Filters can be used to limit the fonts shown. There are 2 filters in the
-#GtkFontSelectionDialog - a base filter and a user filter. The base filter
-can not be changed by the user, so this can be used when the user must choose
-from the restricted set of fonts (e.g. for a terminal-type application you may
-want to force the user to select a fixed-width font). The user filter can be
-changed or reset by the user, by using the 'Reset Filter' button or changing
-the options on the 'Filter' page of the dialog.
-</para>
-
-<example>
-<title>Setting a filter to show only fixed-width fonts.</title>
-<programlisting>
-  gchar *spacings[] = { "c", "m", NULL };
-  gtk_font_selection_dialog_set_filter (GTK_FONT_SELECTION_DIALOG (fontsel),
-                                      GTK_FONT_FILTER_BASE, GTK_FONT_ALL,
-                                      NULL, NULL, NULL, NULL, spacings, NULL);
-</programlisting>
-</example>
 
+<refsect2 id="GtkFontSelectionDialog-BUILDER-UI">
+<title>GtkFontSelectionDialog as GtkBuildable</title>
 <para>
-To allow only true scalable fonts to be selected use:
+The GtkFontSelectionDialog implementation of the GtkBuildable interface
+exposes the embedded #GtkFontSelection as internal child with the
+name "font_selection". It also exposes the buttons with the names
+"ok_button", "cancel_button" and "apply_button".
 </para>
-
-<example>
-<title>Setting a filter to show only true scalable fonts.</title>
-<programlisting>
-  gtk_font_selection_dialog_set_filter (GTK_FONT_SELECTION_DIALOG (fontsel),
-                                      GTK_FONT_FILTER_BASE, GTK_FONT_SCALABLE,
-                                      NULL, NULL, NULL, NULL, NULL, NULL);
-</programlisting>
-</example>
+</refsect2>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
@@ -59,120 +36,85 @@ To allow only true scalable fonts to be selected use:
 
 <varlistentry>
 <term>#GtkFontSelection</term>
-<listitem><para>the underlying widget for selecting fonts.</para></listitem>
+<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 ##### -->
-<para>
-The #GtkFontSelectionDialog struct contains private data only, and should
-only be accessed using the functions below.
-</para>
+<!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### FUNCTION gtk_font_selection_dialog_new ##### -->
-<para>
-Creates a new #GtkFontSelectionDialog.
-</para>
+<!-- ##### SECTION Image ##### -->
+
 
-@title: the title of the dialog box.
-@Returns: a new #GtkFontSelectionDialog.
+<!-- ##### STRUCT GtkFontSelectionDialog ##### -->
 
 
-<!-- ##### FUNCTION gtk_font_selection_dialog_get_font ##### -->
+
+<!-- ##### FUNCTION gtk_font_selection_dialog_new ##### -->
 <para>
-Gets the currently-selected font.
+
 </para>
 
-@fsd: a #GtkFontSelectionDialog.
-@Returns: the currently-selected font, or NULL if no font is selected.
+@title: 
+@Returns: 
 
 
 <!-- ##### 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.
+@fsd: 
+@Returns: 
 
 
 <!-- ##### 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.
+@fsd: 
+@fontname: 
+@Returns: 
 
 
 <!-- ##### 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.
+@fsd: 
+@Returns: 
 
 
 <!-- ##### 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.
+@fsd: 
+@text: 
 
 
-<!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
+<!-- ##### FUNCTION gtk_font_selection_dialog_get_cancel_button ##### -->
 <para>
-Sets one of the two font filters, to limit the fonts shown.
-</para>
 
-@fsd: a #GtkFontSelectionDialog.
-@filter_type: which of the two font filters to set, either
-#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
-can be changed by the user, but the base filter is permanent.
-@font_type: the types of font to be shown. This is a bitwise combination of
-#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
-or #GTK_FONT_ALL to show all three font types.
-@foundries: a NULL-terminated array of strings containing foundry names which
-will be shown, or NULL to show all foundries.
-@weights: a NULL-terminated array of strings containing weight names which
-will be shown, or NULL to show all weights.
-@slants: a NULL-terminated array of strings containing slant names which
-will be shown, or NULL to show all slants.
-@setwidths: a NULL-terminated array of strings containing setwidth names which
-will be shown, or NULL to show all setwidths.
-@spacings: a NULL-terminated array of strings containing spacings which
-will be shown, or NULL to show all spacings.
-@charsets: a NULL-terminated array of strings containing charset names which
-will be shown, or NULL to show all charsets.
-
-
-<!-- ##### ENUM GtkFontType ##### -->
-<para>
-A set of bit flags used to specify the type of fonts shown
-when calling gtk_font_selection_dialog_set_filter() or
-gtk_font_selection_set_filter().
 </para>
 
-@GTK_FONT_BITMAP: bitmap fonts.
-@GTK_FONT_SCALABLE: scalable fonts.
-@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
-@GTK_FONT_ALL: a bitwise combination of all of the above.
+@fsd: 
+@Returns: 
+
 
-<!-- ##### ENUM GtkFontFilterType ##### -->
+<!-- ##### FUNCTION gtk_font_selection_dialog_get_ok_button ##### -->
 <para>
-A set of bit flags used to specify the filter being set
-when calling gtk_font_selection_dialog_set_filter() or
-gtk_font_selection_set_filter().
+
 </para>
 
-@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
-@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
-'Filter' page of the #GtkFontSelection widget.
+@fsd: 
+@Returns: 
+