Gnome User Interface Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GnomeFontPicker

## Name

GnomeFontPicker -- Button that displays current font; click to select new font.

## Synopsis

    #include <gnome.h>

    struct      GnomeFontPicker;
    enum        GnomeFontPickerMode;
    GtkWidget*  gnome_font_picker_new           (void);
    void        gnome_font_picker_set_title     (GnomeFontPicker *gfp,
                                                 const gchar *title);
    GnomeFontPickerMode gnome_font_picker_get_mode
                                                (GnomeFontPicker *gfp);
    void        gnome_font_picker_set_mode      (GnomeFontPicker *gfp,
                                                 GnomeFontPickerMode mode);
    void        gnome_font_picker_fi_set_use_font_in_label
                                                (GnomeFontPicker *gfp,
                                                 gboolean use_font_in_label,
                                                 gint size);
    void        gnome_font_picker_fi_set_show_size
                                                (GnomeFontPicker *gfp,
                                                 gboolean show_size);
    void        gnome_font_picker_uw_set_widget (GnomeFontPicker *gfp,
                                                 GtkWidget *widget);
    gchar*      gnome_font_picker_get_font_name (GnomeFontPicker *gfp);
    GdkFont*    gnome_font_picker_get_font      (GnomeFontPicker *gfp);
    gboolean    gnome_font_picker_set_font_name (GnomeFontPicker *gfp,
                                                 const gchar *fontname);
    gchar*      gnome_font_picker_get_preview_text
                                                (GnomeFontPicker *gfp);
    void        gnome_font_picker_set_preview_text
                                                (GnomeFontPicker *gfp,
                                                 const gchar *text);

## Object Hierarchy

      GtkObject
       +----GtkWidget
             +----GtkContainer
                   +----GtkBin
                         +----GtkButton
                               +----GnomeFontPicker

## Description

## Details

### struct GnomeFontPicker

    struct GnomeFontPicker;

### enum GnomeFontPickerMode

    typedef enum {
        GNOME_FONT_PICKER_MODE_PIXMAP,
        GNOME_FONT_PICKER_MODE_FONT_INFO,
        GNOME_FONT_PICKER_MODE_USER_WIDGET,
        GNOME_FONT_PICKER_MODE_UNKNOWN
    } GnomeFontPickerMode;

### gnome_font_picker_new ()

    GtkWidget*  gnome_font_picker_new           (void);

Create new font picker widget.

Returns : | Pointer to new font picker widget.

### gnome_font_picker_set_title ()

    void        gnome_font_picker_set_title     (GnomeFontPicker *gfp,
                                                 const gchar *title);

Sets the title for the font selection dialog.

`gfp` : | Pointer to GNOME font picker widget.
`title` : | String containing font selection dialog title.

### gnome_font_picker_get_mode ()

    GnomeFontPickerMode gnome_font_picker_get_mode
                                                (GnomeFontPicker *gfp);

Returns current font picker button mode (or what to show). Possible values include `GNOME_FONT_PICKER_MODE_PIXMAP`, `GNOME_FONT_PICKER_MODE_FONT_INFO`, and `GNOME_FONT_PICKER_MODE_USER_WIDGET`.

`gfp` : | Pointer to GNOME font picker widget.
Returns : | Button mode currently set in font picker widget, or `GNOME_FONT_PICKER_MODE_UNKNOWN` on error.

### gnome_font_picker_set_mode ()

    void        gnome_font_picker_set_mode      (GnomeFontPicker *gfp,
                                                 GnomeFontPickerMode mode);

Set value of subsequent font picker button mode (or what to show).

`gfp` : | Pointer to GNOME font picker widget.
`mode` : | Value of subsequent font picker button mode (or what to show)

### gnome_font_picker_fi_set_use_font_in_label ()

    void        gnome_font_picker_fi_set_use_font_in_label
                                                (GnomeFontPicker *gfp,
                                                 gboolean use_font_in_label,
                                                 gint size);

If `use_font_in_label` is `TRUE`, font name will be written using font chosen by user and using `size` passed to this function. This only applies if current button mode is `GNOME_FONT_PICKER_MODE_FONT_INFO`.

`gfp` : | Pointer to GNOME font picker widget.
`use_font_in_label` : | If `TRUE`, font name will be written using font chosen.
`size` : | Display font using this point size.

### gnome_font_picker_fi_set_show_size ()

    void        gnome_font_picker_fi_set_show_size
                                                (GnomeFontPicker *gfp,
                                                 gboolean show_size);

If `show_size` is `TRUE`, font size will be displayed along with font chosen by user. This only applies if current button mode is `GNOME_FONT_PICKER_MODE_FONT_INFO`.

`gfp` : | Pointer to GNOME font picker widget.
`show_size` : | `TRUE` if font size should be displayed in dialog.

### gnome_font_picker_uw_set_widget ()

    void        gnome_font_picker_uw_set_widget (GnomeFontPicker *gfp,
                                                 GtkWidget *widget);

Set the user-supplied `widget` as the inside of the font picker. This only applies with GNOME_FONT_PICKER_MODE_USER_WIDGET.

`gfp` : | Pointer to GNOME font picker widget.
`widget` : | User widget to display for inside of font picker.

### gnome_font_picker_get_font_name ()

    gchar*      gnome_font_picker_get_font_name (GnomeFontPicker *gfp);

Retrieve name of font from font selection dialog.

`gfp` : | Pointer to GNOME font picker widget.
Returns : | Pointer to an internal copy of the font name.

### gnome_font_picker_get_font ()

    GdkFont*    gnome_font_picker_get_font      (GnomeFontPicker *gfp);

Retrieve font info from font selection dialog.

`gfp` : | Pointer to GNOME font picker widget.
Returns : | Return value of gtk_font_selection_dialog_get_font, or `NULL` if font dialog is not being displayed.

### gnome_font_picker_set_font_name ()

    gboolean    gnome_font_picker_set_font_name (GnomeFontPicker *gfp,
                                                 const gchar *fontname);

Set or update currently-displayed font in font picker dialog.

`gfp` : | Pointer to GNOME font picker widget.
`fontname` : | Name of font to display in font selection dialog
Returns : | Return value of gtk_font_selection_dialog_set_font_name if the font selection dialog exists, otherwise `FALSE`.

### gnome_font_picker_get_preview_text ()

    gchar*      gnome_font_picker_get_preview_text
                                                (GnomeFontPicker *gfp);

Retrieve preview text from font selection dialog if available.

`gfp` : | Pointer to GNOME font picker widget.
Returns : | Reference to internal copy of preview text string, or `NULL` if no font dialog is being displayed.

### gnome_font_picker_set_preview_text ()

    void        gnome_font_picker_set_preview_text
                                                (GnomeFontPicker *gfp,
                                                 const gchar *text);

Set preview text in font picker, and in font selection dialog if one is being displayed.

`gfp` : | Pointer to GNOME font picker widget.
`text` : | New preview text

<<< Previous Page | Home | Up | Next Page >>>
GnomeFileEntry | GnomeFontSelector