Top |
Functions
Properties
gchar * | font | Read / Write |
PangoFontDescription * | font-desc | Read / Write |
gchar * | preview-text | Read / Write |
gboolean | show-preview-entry | Read / Write |
Known Implementations
GtkFontChooser is implemented by GtkFontButton, GtkFontChooserDialog and GtkFontChooserWidget.
Description
GtkFontChooser is an interface that can be implemented by widgets displaying the list of fonts. In GTK+, the main objects that implement this interface are GtkFontChooserWidget, GtkFontChooserDialog and GtkFontButton.
Functions
gtk_font_chooser_get_font_family ()
PangoFontFamily *
gtk_font_chooser_get_font_family (GtkFontChooser *fontchooser
);
Gets the PangoFontFamily representing the selected font family. Font families are a collection of font faces.
If the selected font is not installed, returns NULL
.
Returns
A PangoFontFamily representing the
selected font family, or NULL
. The returned object is owned by fontchooser
and must not be modified or freed.
[transfer none]
Since 3.2
gtk_font_chooser_get_font_face ()
PangoFontFace *
gtk_font_chooser_get_font_face (GtkFontChooser *fontchooser
);
Gets the PangoFontFace representing the selected font group details (i.e. family, slant, weight, width, etc).
If the selected font is not installed, returns NULL
.
Returns
A PangoFontFace representing the
selected font group details, or NULL
. The returned object is owned by
fontchooser
and must not be modified or freed.
[transfer none]
Since 3.2
gtk_font_chooser_get_font_size ()
gint
gtk_font_chooser_get_font_size (GtkFontChooser *fontchooser
);
The selected font size.
Since 3.2
gtk_font_chooser_get_font ()
gchar *
gtk_font_chooser_get_font (GtkFontChooser *fontchooser
);
Gets the currently-selected font name.
Note that this can be a different string than what you set with
gtk_font_chooser_set_font()
, as the font chooser 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.
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()
.
[transfer full][allow-none]
Since 3.2
gtk_font_chooser_set_font ()
void gtk_font_chooser_set_font (GtkFontChooser *fontchooser
,const gchar *fontname
);
Sets the currently-selected font.
Since 3.2
gtk_font_chooser_get_font_desc ()
PangoFontDescription *
gtk_font_chooser_get_font_desc (GtkFontChooser *fontchooser
);
Gets the currently-selected font.
Note that this can be a different string than what you set with
gtk_font_chooser_set_font()
, as the font chooser 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.
Returns
A PangoFontDescription for the
current font, or NULL
if no font is selected.
[transfer full][allow-none]
Since 3.2
gtk_font_chooser_set_font_desc ()
void gtk_font_chooser_set_font_desc (GtkFontChooser *fontchooser
,const PangoFontDescription *font_desc
);
Sets the currently-selected font from font_desc
.
Since 3.2
gtk_font_chooser_get_preview_text ()
gchar *
gtk_font_chooser_get_preview_text (GtkFontChooser *fontchooser
);
Gets the text displayed in the preview area.
Since 3.2
gtk_font_chooser_set_preview_text ()
void gtk_font_chooser_set_preview_text (GtkFontChooser *fontchooser
,const gchar *text
);
Sets the text displayed in the preview area.
The text
is used to show how the selected font looks.
Since 3.2
gtk_font_chooser_get_show_preview_entry ()
gboolean
gtk_font_chooser_get_show_preview_entry
(GtkFontChooser *fontchooser
);
Returns whether the preview entry is shown or not.
Since 3.2
gtk_font_chooser_set_show_preview_entry ()
void gtk_font_chooser_set_show_preview_entry (GtkFontChooser *fontchooser
,gboolean show_preview_entry
);
Shows or hides the editable preview entry.
Since 3.2
GtkFontFilterFunc ()
gboolean (*GtkFontFilterFunc) (const PangoFontFamily *family
,const PangoFontFace *face
,gpointer data
);
The type of function that is used for deciding what fonts get
shown in a GtkFontChooser. See gtk_font_chooser_set_filter_func()
.
Parameters
family |
||
face |
a PangoFontFace belonging to |
|
data |
user data passed to |
[closure] |
gtk_font_chooser_set_filter_func ()
void gtk_font_chooser_set_filter_func (GtkFontChooser *fontchooser
,GtkFontFilterFunc filter
,gpointer user_data
,GDestroyNotify destroy
);
Adds a filter function that decides which fonts to display in the font chooser.
Parameters
fontchooser |
||
filter |
a GtkFontFilterFunc, or |
[allow-none] |
user_data |
data to pass to |
|
destroy |
function to call to free |
Since 3.2
Property Details
The “font”
property
“font” gchar *
The font description as a string, e.g. "Sans Italic 12".
Flags: Read / Write
Default value: "Sans 10"
The “font-desc”
property
“font-desc” PangoFontDescription *
The font description as a PangoFontDescription.
Flags: Read / Write
The “preview-text”
property
“preview-text” gchar *
The string with which to preview the font.
Flags: Read / Write
Default value: "The quick brown fox jumps over the lazy dog."
The “show-preview-entry”
property
“show-preview-entry” gboolean
Whether to show an entry to change the preview text.
Flags: Read / Write
Default value: TRUE
Signal Details
The “font-activated”
signal
void user_function (GtkFontChooser *self, gchar *fontname, gpointer user_data)
Emitted when a font is activated. This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.
Parameters
self |
the object which received the signal |
|
fontname |
the font name |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First