GI.Gtk.Interfaces.FontChooser

FontChooser is an interface that can be implemented by widgets displaying the list of fonts. In GTK+, the main objects that implement this interface are FontChooserWidget, FontChooserDialog and FontButton. The GtkFontChooser interface has been introducted in GTK+ 3.2.

Exported types

newtype FontChooser

Memory-managed wrapper type.

Constructors

FontChooser (ManagedPtr FontChooser)

Instances

GObject FontChooser

Defined in GI.Gtk.Interfaces.FontChooser

Methods

gobjectType :: FontChooser -> IO GType

IsObject FontChooser

Defined in GI.Gtk.Interfaces.FontChooser

IsFontChooser FontChooser

Defined in GI.Gtk.Interfaces.FontChooser

noFontChooser :: Maybe FontChooser

A convenience alias for Nothing :: Maybe FontChooser.

class GObject o => IsFontChooser o

Type class for types which can be safely cast to FontChooser, for instance with toFontChooser.

Instances

(GObject a, (UnknownAncestorError FontChooser a :: Constraint)) => IsFontChooser a

Defined in GI.Gtk.Interfaces.FontChooser

IsFontChooser FontChooser

Defined in GI.Gtk.Interfaces.FontChooser

IsFontChooser FontChooserWidget

Defined in GI.Gtk.Objects.FontChooserWidget

IsFontChooser FontButton

Defined in GI.Gtk.Objects.FontButton

IsFontChooser FontChooserDialog

Defined in GI.Gtk.Objects.FontChooserDialog

toFontChooser :: (MonadIO m, IsFontChooser o) => o -> m FontChooser

Cast to FontChooser, for types for which this is known to be safe. For general casts, use castTo.

Methods

getFont

fontChooserGetFont

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m (Maybe Text)

Returns: A string with the name of the current font, or Nothing if no font is selected. You must free this string with free.

Gets the currently-selected font name.

Note that this can be a different string than what you set with fontChooserSetFont, 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 fontDescriptionEqual if you want to compare two font descriptions.

Since: 3.2

getFontDesc

fontChooserGetFontDesc

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m (Maybe FontDescription)

Returns: A FontDescription for the current font, or Nothing if no font is selected.

Gets the currently-selected font.

Note that this can be a different string than what you set with fontChooserSetFont, 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 fontDescriptionEqual if you want to compare two font descriptions.

Since: 3.2

getFontFace

fontChooserGetFontFace

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m (Maybe FontFace)

Returns: A FontFace representing the selected font group details, or Nothing. The returned object is owned by fontchooser and must not be modified or freed.

Gets the FontFace representing the selected font group details (i.e. family, slant, weight, width, etc).

If the selected font is not installed, returns Nothing.

Since: 3.2

getFontFamily

fontChooserGetFontFamily

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m (Maybe FontFamily)

Returns: A FontFamily representing the selected font family, or Nothing. The returned object is owned by fontchooser and must not be modified or freed.

Gets the FontFamily representing the selected font family. Font families are a collection of font faces.

If the selected font is not installed, returns Nothing.

Since: 3.2

getFontFeatures

fontChooserGetFontFeatures

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m Text

Returns: the currently selected font features

Gets the currently-selected font features.

Since: 3.24

getFontMap

fontChooserGetFontMap

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m (Maybe FontMap)

Returns: a FontMap, or Nothing

Gets the custom font map of this font chooser widget, or Nothing if it does not have one.

Since: 3.18

getFontSize

fontChooserGetFontSize

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m Int32

Returns: A n integer representing the selected font size, or -1 if no font size is selected.

The selected font size.

Since: 3.2

getLanguage

fontChooserGetLanguage

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m Text

Returns: the currently selected language

Gets the language that is used for font features.

Since: 3.24

getLevel

fontChooserGetLevel

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m [FontChooserLevel]

Returns: the current granularity level

Returns the current level of granularity for selecting fonts.

Since: 3.24

getPreviewText

fontChooserGetPreviewText

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m Text

Returns: the text displayed in the preview area

Gets the text displayed in the preview area.

Since: 3.2

getShowPreviewEntry

fontChooserGetShowPreviewEntry

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> m Bool

Returns: True if the preview entry is shown or False if it is hidden.

Returns whether the preview entry is shown or not.

Since: 3.2

setFilterFunc

fontChooserSetFilterFunc

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> Maybe FontFilterFunc

filter: a FontFilterFunc, or Nothing

-> m ()

Adds a filter function that decides which fonts to display in the font chooser.

Since: 3.2

setFont

fontChooserSetFont

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> Text

fontname: a font name like “Helvetica 12” or “Times Bold 18”

-> m ()

Sets the currently-selected font.

Since: 3.2

setFontDesc

fontChooserSetFontDesc

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> FontDescription

fontDesc: a FontDescription

-> m ()

Sets the currently-selected font from fontDesc.

Since: 3.2

setFontMap

fontChooserSetFontMap

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a, IsFontMap b)

=> a

fontchooser: a FontChooser

-> Maybe b

fontmap: a FontMap

-> m ()

Sets a custom font map to use for this font chooser widget. A custom font map can be used to present application-specific fonts instead of or in addition to the normal system fonts.

C code

FcConfig *config;
PangoFontMap *fontmap;

config = FcInitLoadConfigAndFonts ();
FcConfigAppFontAddFile (config, my_app_font_file);

fontmap = pango_cairo_font_map_new_for_font_type (CAIRO_FONT_TYPE_FT);
pango_fc_font_map_set_config (PANGO_FC_FONT_MAP (fontmap), config);

gtk_font_chooser_set_font_map (font_chooser, fontmap);

Note that other GTK+ widgets will only be able to use the application-specific font if it is present in the font map they use:

context = gtk_widget_get_pango_context (label);
pango_context_set_font_map (context, fontmap);

Since: 3.18

setLanguage

fontChooserSetLanguage

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> Text

language: a language

-> m ()

Sets the language to use for font features.

Since: 3.24

setLevel

fontChooserSetLevel

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> [FontChooserLevel]

level: the desired level of granularity

-> m ()

Sets the desired level of granularity for selecting fonts.

Since: 3.24

setPreviewText

fontChooserSetPreviewText

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> Text

text: the text to display in the preview area

-> m ()

Sets the text displayed in the preview area. The text is used to show how the selected font looks.

Since: 3.2

setShowPreviewEntry

fontChooserSetShowPreviewEntry

Arguments

:: (HasCallStack, MonadIO m, IsFontChooser a)

=> a

fontchooser: a FontChooser

-> Bool

showPreviewEntry: whether to show the editable preview entry or not

-> m ()

Shows or hides the editable preview entry.

Since: 3.2

Properties

font

The font description as a string, e.g. "Sans Italic 12".

constructFontChooserFont :: IsFontChooser o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “font” property. This is rarely needed directly, but it is used by new.

getFontChooserFont :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)

Get the value of the “font” property. When overloading is enabled, this is equivalent to

get fontChooser #font

setFontChooserFont :: (MonadIO m, IsFontChooser o) => o -> Text -> m ()

Set the value of the “font” property. When overloading is enabled, this is equivalent to

set fontChooser [ #font := value ]

fontDesc

The font description as a FontDescription.

constructFontChooserFontDesc :: IsFontChooser o => FontDescription -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “font-desc” property. This is rarely needed directly, but it is used by new.

getFontChooserFontDesc :: (MonadIO m, IsFontChooser o) => o -> m (Maybe FontDescription)

Get the value of the “font-desc” property. When overloading is enabled, this is equivalent to

get fontChooser #fontDesc

setFontChooserFontDesc :: (MonadIO m, IsFontChooser o) => o -> FontDescription -> m ()

Set the value of the “font-desc” property. When overloading is enabled, this is equivalent to

set fontChooser [ #fontDesc := value ]

fontFeatures

The selected font features, in a format that is compatible with CSS and with Pango attributes.

Since: 3.22.30

getFontChooserFontFeatures :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)

Get the value of the “font-features” property. When overloading is enabled, this is equivalent to

get fontChooser #fontFeatures

language

The language for which the FontChooser:font-features were selected, in a format that is compatible with CSS and with Pango attributes.

Since: 3.22.30

constructFontChooserLanguage :: IsFontChooser o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “language” property. This is rarely needed directly, but it is used by new.

getFontChooserLanguage :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)

Get the value of the “language” property. When overloading is enabled, this is equivalent to

get fontChooser #language

setFontChooserLanguage :: (MonadIO m, IsFontChooser o) => o -> Text -> m ()

Set the value of the “language” property. When overloading is enabled, this is equivalent to

set fontChooser [ #language := value ]

level

The level of granularity to offer for selecting fonts.

Since: 3.22.30

constructFontChooserLevel :: IsFontChooser o => [FontChooserLevel] -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “level” property. This is rarely needed directly, but it is used by new.

getFontChooserLevel :: (MonadIO m, IsFontChooser o) => o -> m [FontChooserLevel]

Get the value of the “level” property. When overloading is enabled, this is equivalent to

get fontChooser #level

setFontChooserLevel :: (MonadIO m, IsFontChooser o) => o -> [FontChooserLevel] -> m ()

Set the value of the “level” property. When overloading is enabled, this is equivalent to

set fontChooser [ #level := value ]

previewText

The string with which to preview the font.

constructFontChooserPreviewText :: IsFontChooser o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “preview-text” property. This is rarely needed directly, but it is used by new.

getFontChooserPreviewText :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)

Get the value of the “preview-text” property. When overloading is enabled, this is equivalent to

get fontChooser #previewText

setFontChooserPreviewText :: (MonadIO m, IsFontChooser o) => o -> Text -> m ()

Set the value of the “preview-text” property. When overloading is enabled, this is equivalent to

set fontChooser [ #previewText := value ]

showPreviewEntry

Whether to show an entry to change the preview text.

constructFontChooserShowPreviewEntry :: IsFontChooser o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-preview-entry” property. This is rarely needed directly, but it is used by new.

getFontChooserShowPreviewEntry :: (MonadIO m, IsFontChooser o) => o -> m Bool

Get the value of the “show-preview-entry” property. When overloading is enabled, this is equivalent to

get fontChooser #showPreviewEntry

setFontChooserShowPreviewEntry :: (MonadIO m, IsFontChooser o) => o -> Bool -> m ()

Set the value of the “show-preview-entry” property. When overloading is enabled, this is equivalent to

set fontChooser [ #showPreviewEntry := value ]

Signals

fontActivated

type C_FontChooserFontActivatedCallback = Ptr () -> CString -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FontChooserFontActivatedCallback

Arguments

 = Text

fontname: the font name

-> IO ()

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.

afterFontChooserFontActivated :: (IsFontChooser a, MonadIO m) => a -> FontChooserFontActivatedCallback -> m SignalHandlerId

Connect a signal handler for the “font-activated” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fontChooser #fontActivated callback

genClosure_FontChooserFontActivated :: FontChooserFontActivatedCallback -> IO Closure

Wrap the callback into a Closure.

mk_FontChooserFontActivatedCallback :: C_FontChooserFontActivatedCallback -> IO (FunPtr C_FontChooserFontActivatedCallback)

Generate a function pointer callable from C code, from a C_FontChooserFontActivatedCallback.

noFontChooserFontActivatedCallback :: Maybe FontChooserFontActivatedCallback

A convenience synonym for Nothing :: Maybe FontChooserFontActivatedCallback.

onFontChooserFontActivated :: (IsFontChooser a, MonadIO m) => a -> FontChooserFontActivatedCallback -> m SignalHandlerId

Connect a signal handler for the “font-activated” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fontChooser #fontActivated callback

wrap_FontChooserFontActivatedCallback :: FontChooserFontActivatedCallback -> C_FontChooserFontActivatedCallback

Wrap a FontChooserFontActivatedCallback into a C_FontChooserFontActivatedCallback.