GtkFontSelectionDialog

GtkFontSelectionDialog — A dialog box for selecting fonts

Synopsis


#include <gtk/gtk.h>

                    GtkFontSelectionDialog;
GtkWidget*          gtk_font_selection_dialog_new       (const gchar *title);
GdkFont*            gtk_font_selection_dialog_get_font  (GtkFontSelectionDialog *fsd);
gchar*              gtk_font_selection_dialog_get_font_name
                                                        (GtkFontSelectionDialog *fsd);
gboolean            gtk_font_selection_dialog_set_font_name
                                                        (GtkFontSelectionDialog *fsd,
                                                         const gchar *fontname);
const gchar*        gtk_font_selection_dialog_get_preview_text
                                                        (GtkFontSelectionDialog *fsd);
void                gtk_font_selection_dialog_set_preview_text
                                                        (GtkFontSelectionDialog *fsd,
                                                         const gchar *text);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----GtkFontSelectionDialog

Implemented Interfaces

GtkFontSelectionDialog implements AtkImplementorIface and GtkBuildable.

Description

The GtkFontSelectionDialog widget is a dialog box for selecting a font.

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

To get the selected font use gtk_font_selection_dialog_get_font_name().

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

GtkFontSelectionDialog as GtkBuildable

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".

Details

GtkFontSelectionDialog

typedef struct {
  GtkWidget *ok_button;
  GtkWidget *apply_button;
  GtkWidget *cancel_button;
} GtkFontSelectionDialog;
GtkWidget *ok_button; The OK button of the dialog
GtkWidget *apply_button; The Apply button of the dialog. This button is hidden by default but you can show/hide it
GtkWidget *cancel_button; The Cancel button of the dialog

gtk_font_selection_dialog_new ()

GtkWidget*          gtk_font_selection_dialog_new       (const gchar *title);

Creates a new GtkFontSelectionDialog.

title : the title of the dialog box.
Returns : a new GtkFontSelectionDialog.

gtk_font_selection_dialog_get_font ()

GdkFont*            gtk_font_selection_dialog_get_font  (GtkFontSelectionDialog *fsd);

Warning

gtk_font_selection_dialog_get_font is deprecated and should not be used in newly-written code.

Gets the currently-selected font.

fsd : a GtkFontSelectionDialog.
Returns : the currently-selected font, or NULL if no font is selected.

gtk_font_selection_dialog_get_font_name ()

gchar*              gtk_font_selection_dialog_get_font_name
                                                        (GtkFontSelectionDialog *fsd);

Gets the currently-selected font name. Note that this can be a different string than what you set with gtk_font_selection_dialog_set_font_name(), as the font selection widget may normalize font names and thus return a string with a different structure. For example, "Helvetica Italic Bold 12" could be normalized to "Helvetica Bold Italic 12". Use pango_font_description_equal() if you want to compare two font descriptions.

fsd : a GtkFontSelectionDialog
Returns : A string with the name of the current font, or NULL if no font is selected. You must free this string with g_free().

gtk_font_selection_dialog_set_font_name ()

gboolean            gtk_font_selection_dialog_set_font_name
                                                        (GtkFontSelectionDialog *fsd,
                                                         const gchar *fontname);

Sets the currently-selected font.

fsd : a GtkFontSelectionDialog.
fontname : a fontname.
Returns : TRUE if the font was found.

gtk_font_selection_dialog_get_preview_text ()

const gchar*        gtk_font_selection_dialog_get_preview_text
                                                        (GtkFontSelectionDialog *fsd);

Gets the text displayed in the preview area.

fsd : a GtkFontSelectionDialog.
Returns : the text displayed in the preview area. This string is owned by the widget and should not be modified or freed.

gtk_font_selection_dialog_set_preview_text ()

void                gtk_font_selection_dialog_set_preview_text
                                                        (GtkFontSelectionDialog *fsd,
                                                         const gchar *text);

Sets the text displayed in the preview area.

fsd : a GtkFontSelectionDialog.
text : the text to display in the preview area.

See Also

GtkFontSelection, GtkDialog

the underlying widget for selecting fonts.

the parent class of GtkFontSelectionDialog

Generated by GTK-Doc V1.10