GTK+ Reference Manual
<<< Previous PageHomeUpNext Page >>>

GtkFontSelection

Name

GtkFontSelection -- a widget for selecting fonts.

Synopsis


#include <gtk/gtk.h>


struct      GtkFontSelection;
GtkWidget*  gtk_font_selection_new          (void);
GdkFont*    gtk_font_selection_get_font     (GtkFontSelection *fontsel);
gchar*      gtk_font_selection_get_font_name
                                            (GtkFontSelection *fontsel);
gboolean    gtk_font_selection_set_font_name
                                            (GtkFontSelection *fontsel,
                                             const gchar *fontname);
gchar*      gtk_font_selection_get_preview_text
                                            (GtkFontSelection *fontsel);
void        gtk_font_selection_set_preview_text
                                            (GtkFontSelection *fontsel,
                                             const gchar *text);
void        gtk_font_selection_set_filter   (GtkFontSelection *fontsel,
                                             GtkFontFilterType filter_type,
                                             GtkFontType font_type,
                                             gchar **foundries,
                                             gchar **weights,
                                             gchar **slants,
                                             gchar **setwidths,
                                             gchar **spacings,
                                             gchar **charsets);

Object Hierarchy


  GtkObject
   +----GtkWidget
         +----GtkContainer
               +----GtkNotebook
                     +----GtkFontSelection

Description

The GtkFontSelection widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the GtkFontSelectionDialog widget to provide a dialog box for selecting fonts.

To set the font which is initially selected, use gtk_font_selection_set_font_name().

To get the selected font use gtk_font_selection_get_font() or gtk_font_selection_get_font_name().

To change the text which is shown in the preview area, use gtk_font_selection_set_preview_text().

Filters can be used to limit the fonts shown. There are 2 filters in the GtkFontSelection - 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 widget.

Details

struct GtkFontSelection

struct GtkFontSelection;

The GtkFontSelection struct contains private data only, and should only be accessed using the functions below.

gtk_font_selection_new ()

GtkWidget*  gtk_font_selection_new          (void);

Creates a new GtkFontSelection.

Returns :a new GtkFontSelection.

gtk_font_selection_get_font ()

GdkFont*    gtk_font_selection_get_font     (GtkFontSelection *fontsel);

Gets the currently-selected font.

fontsel :a GtkFontSelection.
Returns :the currently-selected font, or NULL if no font is selected.

gtk_font_selection_get_font_name ()

gchar*      gtk_font_selection_get_font_name
                                            (GtkFontSelection *fontsel);

Gets the currently-selected font name.

fontsel :a GtkFontSelection.
Returns : 

gtk_font_selection_set_font_name ()

gboolean    gtk_font_selection_set_font_name
                                            (GtkFontSelection *fontsel,
                                             const gchar *fontname);

Sets the currently-selected font.

fontsel :a GtkFontSelection.
fontname :a fontname.
Returns :TRUE if the font was found.

gtk_font_selection_get_preview_text ()

gchar*      gtk_font_selection_get_preview_text
                                            (GtkFontSelection *fontsel);

Gets the text displayed in the preview area.

fontsel :a GtkFontSelection.
Returns :the text displayed in the preview area.

gtk_font_selection_set_preview_text ()

void        gtk_font_selection_set_preview_text
                                            (GtkFontSelection *fontsel,
                                             const gchar *text);

Sets the text displayed in the preview area.

fontsel :a GtkFontSelection.
text :the text to display in the preview area.

gtk_font_selection_set_filter ()

void        gtk_font_selection_set_filter   (GtkFontSelection *fontsel,
                                             GtkFontFilterType filter_type,
                                             GtkFontType font_type,
                                             gchar **foundries,
                                             gchar **weights,
                                             gchar **slants,
                                             gchar **setwidths,
                                             gchar **spacings,
                                             gchar **charsets);

Sets one of the two font filters, to limit the fonts shown.

fontsel :a GtkFontSelection.
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.

See Also

GtkFontSelectionDialog

a dialog box which uses GtkFontSelection.



<<< Previous PageHomeUpNext Page >>>
GtkFixedGtkFontSelectionDialog