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);
GtkWidget*          gtk_font_selection_dialog_get_apply_button
                                                        (GtkFontSelectionDialog *fsd);
GtkWidget*          gtk_font_selection_dialog_get_cancel_button
                                                        (GtkFontSelectionDialog *fsd);
GtkWidget*          gtk_font_selection_dialog_get_ok_button
                                                        (GtkFontSelectionDialog *fsd);

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 *GSEAL (ok_button);
  GtkWidget *GSEAL (apply_button);
  GtkWidget *GSEAL (cancel_button);
} GtkFontSelectionDialog;

gtk_font_selection_dialog_new ()

GtkWidget*          gtk_font_selection_dialog_new       (const gchar *title);

The title is used to set the title of the GtkFontSelectionDialog returned. This GtkDialog is specifically catered with widgets for selecting a font from those installed.

Creates a new GtkFontSelectionDialog.

title : a pointer to a string
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 has been deprecated since version 2.0 and should not be used in newly-written code. Use gtk_font_selection_dialog_get_font_name() instead.

Gets the currently-selected font.

fsd : a GtkFontSelectionDialog
Returns : the GdkFont from the GtkFontSelection for the currently selected font in the dialog.

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.

Sets the currently-selected font.

fsd : a GtkFontSelectionDialog
fontname : a pointer to a string
Returns : TRUE if the font selected in fsd is now the fontname specified. FALSE otherwise.

gtk_font_selection_dialog_get_preview_text ()

const gchar*        gtk_font_selection_dialog_get_preview_text
                                                        (GtkFontSelectionDialog *fsd);

The text returned is the preview text used to show how the selected font looks.

Gets the text displayed in the preview area.

fsd : a GtkFontSelectionDialog
Returns : pointer to the preview text string. This string points to internally allocated storage in the widget and must not be freed, modified or stored.

gtk_font_selection_dialog_set_preview_text ()

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

The text is used to show how the selected font looks.

Sets the text displayed in the preview area.

fsd : a GtkFontSelectionDialog
text : a pointer to a string

gtk_font_selection_dialog_get_apply_button ()

GtkWidget*          gtk_font_selection_dialog_get_apply_button
                                                        (GtkFontSelectionDialog *fsd);

Gets the 'Apply' button.

fsd : a GtkFontSelectionDialog
Returns : the GtkWidget used in the dialog for the 'Apply' button.

Since 2.14

gtk_font_selection_dialog_get_cancel_button ()

GtkWidget*          gtk_font_selection_dialog_get_cancel_button
                                                        (GtkFontSelectionDialog *fsd);

Gets the 'Cancel' button.

fsd : a GtkFontSelectionDialog
Returns : the GtkWidget used in the dialog for the 'Cancel' button.

Since 2.14

gtk_font_selection_dialog_get_ok_button ()

GtkWidget*          gtk_font_selection_dialog_get_ok_button
                                                        (GtkFontSelectionDialog *fsd);

Gets the 'OK' button.

fsd : a GtkFontSelectionDialog
Returns : the GtkWidget used in the dialog for the 'OK' button.

Since 2.14

See Also

GtkFontSelection, GtkDialog

the underlying widget for selecting fonts.

the parent class of GtkFontSelectionDialog

Generated by GTK-Doc V1.10