Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
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.
Synopsis
- newtype FontChooser = FontChooser (ManagedPtr FontChooser)
- noFontChooser :: Maybe FontChooser
- class (GObject o, IsDescendantOf FontChooser o) => IsFontChooser o
- toFontChooser :: (MonadIO m, IsFontChooser o) => o -> m FontChooser
- fontChooserGetFont :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m (Maybe Text)
- fontChooserGetFontDesc :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m (Maybe FontDescription)
- fontChooserGetFontFace :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m (Maybe FontFace)
- fontChooserGetFontFamily :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m (Maybe FontFamily)
- fontChooserGetFontFeatures :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m Text
- fontChooserGetFontMap :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m (Maybe FontMap)
- fontChooserGetFontSize :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m Int32
- fontChooserGetLanguage :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m Text
- fontChooserGetLevel :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m [FontChooserLevel]
- fontChooserGetPreviewText :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m Text
- fontChooserGetShowPreviewEntry :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> m Bool
- fontChooserSetFilterFunc :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> Maybe FontFilterFunc -> m ()
- fontChooserSetFont :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> Text -> m ()
- fontChooserSetFontDesc :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> FontDescription -> m ()
- fontChooserSetFontMap :: (HasCallStack, MonadIO m, IsFontChooser a, IsFontMap b) => a -> Maybe b -> m ()
- fontChooserSetLanguage :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> Text -> m ()
- fontChooserSetLevel :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> [FontChooserLevel] -> m ()
- fontChooserSetPreviewText :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> Text -> m ()
- fontChooserSetShowPreviewEntry :: (HasCallStack, MonadIO m, IsFontChooser a) => a -> Bool -> m ()
- constructFontChooserFont :: IsFontChooser o => Text -> IO (GValueConstruct o)
- getFontChooserFont :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)
- setFontChooserFont :: (MonadIO m, IsFontChooser o) => o -> Text -> m ()
- constructFontChooserFontDesc :: IsFontChooser o => FontDescription -> IO (GValueConstruct o)
- getFontChooserFontDesc :: (MonadIO m, IsFontChooser o) => o -> m (Maybe FontDescription)
- setFontChooserFontDesc :: (MonadIO m, IsFontChooser o) => o -> FontDescription -> m ()
- getFontChooserFontFeatures :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)
- constructFontChooserLanguage :: IsFontChooser o => Text -> IO (GValueConstruct o)
- getFontChooserLanguage :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)
- setFontChooserLanguage :: (MonadIO m, IsFontChooser o) => o -> Text -> m ()
- constructFontChooserLevel :: IsFontChooser o => [FontChooserLevel] -> IO (GValueConstruct o)
- getFontChooserLevel :: (MonadIO m, IsFontChooser o) => o -> m [FontChooserLevel]
- setFontChooserLevel :: (MonadIO m, IsFontChooser o) => o -> [FontChooserLevel] -> m ()
- constructFontChooserPreviewText :: IsFontChooser o => Text -> IO (GValueConstruct o)
- getFontChooserPreviewText :: (MonadIO m, IsFontChooser o) => o -> m (Maybe Text)
- setFontChooserPreviewText :: (MonadIO m, IsFontChooser o) => o -> Text -> m ()
- constructFontChooserShowPreviewEntry :: IsFontChooser o => Bool -> IO (GValueConstruct o)
- getFontChooserShowPreviewEntry :: (MonadIO m, IsFontChooser o) => o -> m Bool
- setFontChooserShowPreviewEntry :: (MonadIO m, IsFontChooser o) => o -> Bool -> m ()
- type C_FontChooserFontActivatedCallback = Ptr () -> CString -> Ptr () -> IO ()
- type FontChooserFontActivatedCallback = Text -> IO ()
- afterFontChooserFontActivated :: (IsFontChooser a, MonadIO m) => a -> FontChooserFontActivatedCallback -> m SignalHandlerId
- genClosure_FontChooserFontActivated :: MonadIO m => FontChooserFontActivatedCallback -> m (GClosure C_FontChooserFontActivatedCallback)
- mk_FontChooserFontActivatedCallback :: C_FontChooserFontActivatedCallback -> IO (FunPtr C_FontChooserFontActivatedCallback)
- noFontChooserFontActivatedCallback :: Maybe FontChooserFontActivatedCallback
- onFontChooserFontActivated :: (IsFontChooser a, MonadIO m) => a -> FontChooserFontActivatedCallback -> m SignalHandlerId
- wrap_FontChooserFontActivatedCallback :: FontChooserFontActivatedCallback -> C_FontChooserFontActivatedCallback
Exported types
newtype FontChooser Source #
Memory-managed wrapper type.
Instances
Eq FontChooser Source # | |
Defined in GI.Gtk.Interfaces.FontChooser (==) :: FontChooser -> FontChooser -> Bool # (/=) :: FontChooser -> FontChooser -> Bool # | |
IsGValue FontChooser Source # | Convert |
Defined in GI.Gtk.Interfaces.FontChooser toGValue :: FontChooser -> IO GValue # fromGValue :: GValue -> IO FontChooser # | |
GObject FontChooser Source # | |
Defined in GI.Gtk.Interfaces.FontChooser gobjectType :: IO GType # | |
HasParentTypes FontChooser Source # | |
Defined in GI.Gtk.Interfaces.FontChooser | |
type ParentTypes FontChooser Source # | |
Defined in GI.Gtk.Interfaces.FontChooser |
noFontChooser :: Maybe FontChooser Source #
A convenience alias for Nothing
:: Maybe
FontChooser
.
class (GObject o, IsDescendantOf FontChooser o) => IsFontChooser o Source #
Type class for types which can be safely cast to FontChooser
, for instance with toFontChooser
.
Instances
(GObject o, IsDescendantOf FontChooser o) => IsFontChooser o Source # | |
Defined in GI.Gtk.Interfaces.FontChooser |
toFontChooser :: (MonadIO m, IsFontChooser o) => o -> m FontChooser Source #
Cast to FontChooser
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
getFont
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m (Maybe Text) | Returns: A string with the name
of the current font, or |
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 Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m (Maybe FontDescription) | Returns: A |
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 Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m (Maybe FontFace) | Returns: A |
getFontFamily
fontChooserGetFontFamily Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m (Maybe FontFamily) | Returns: A |
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 Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m Text | Returns: the currently selected font features |
Gets the currently-selected font features.
Since: 3.24
getFontMap
fontChooserGetFontMap Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m (Maybe FontMap) |
Gets the custom font map of this font chooser widget,
or Nothing
if it does not have one.
Since: 3.18
getFontSize
fontChooserGetFontSize Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m Text | Returns: the currently selected language |
Gets the language that is used for font features.
Since: 3.24
getLevel
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m [FontChooserLevel] | Returns: the current granularity level |
Returns the current level of granularity for selecting fonts.
Since: 3.24
getPreviewText
fontChooserGetPreviewText Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m Text | Returns: the text displayed in the preview area |
Gets the text displayed in the preview area.
Since: 3.2
getShowPreviewEntry
fontChooserGetShowPreviewEntry Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the preview entry is shown or not.
Since: 3.2
setFilterFunc
fontChooserSetFilterFunc Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> Maybe FontFilterFunc |
|
-> m () |
Adds a filter function that decides which fonts to display in the font chooser.
Since: 3.2
setFont
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the currently-selected font.
Since: 3.2
setFontDesc
fontChooserSetFontDesc Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> FontDescription |
|
-> m () |
Sets the currently-selected font from fontDesc
.
Since: 3.2
setFontMap
fontChooserSetFontMap Source #
:: (HasCallStack, MonadIO m, IsFontChooser a, IsFontMap b) | |
=> a |
|
-> Maybe b |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the language to use for font features.
Since: 3.24
setLevel
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> [FontChooserLevel] |
|
-> m () |
Sets the desired level of granularity for selecting fonts.
Since: 3.24
setPreviewText
fontChooserSetPreviewText Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> Text |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsFontChooser a) | |
=> a |
|
-> Bool |
|
-> 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) Source #
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) Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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) Source #
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) Source #
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) Source #
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 () Source #
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) Source #
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] Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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 () Source #
Type for the callback on the (unwrapped) C side.
type FontChooserFontActivatedCallback Source #
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 Source #
Connect a signal handler for the fontActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
fontChooser #fontActivated callback
genClosure_FontChooserFontActivated :: MonadIO m => FontChooserFontActivatedCallback -> m (GClosure C_FontChooserFontActivatedCallback) Source #
Wrap the callback into a GClosure
.
mk_FontChooserFontActivatedCallback :: C_FontChooserFontActivatedCallback -> IO (FunPtr C_FontChooserFontActivatedCallback) Source #
Generate a function pointer callable from C code, from a C_FontChooserFontActivatedCallback
.
noFontChooserFontActivatedCallback :: Maybe FontChooserFontActivatedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
FontChooserFontActivatedCallback
onFontChooserFontActivated :: (IsFontChooser a, MonadIO m) => a -> FontChooserFontActivatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the fontActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
fontChooser #fontActivated callback