GI.Pango.Objects.FontMap

A PangoFontMap represents the set of fonts available for a particular rendering system.

This is a virtual object with implementations being specific to particular rendering systems.

Exported types

newtype FontMap

Memory-managed wrapper type.

Constructors

FontMap (ManagedPtr FontMap)

Instances

Eq FontMap

Defined in GI.Pango.Objects.FontMap

Methods

(==) :: FontMap -> FontMap -> Bool

(/=) :: FontMap -> FontMap -> Bool

GObject FontMap

Defined in GI.Pango.Objects.FontMap

ManagedPtrNewtype FontMap

Defined in GI.Pango.Objects.FontMap

Methods

toManagedPtr :: FontMap -> ManagedPtr FontMap

TypedObject FontMap

Defined in GI.Pango.Objects.FontMap

Methods

glibType :: IO GType

HasParentTypes FontMap

Defined in GI.Pango.Objects.FontMap

IsGValue (Maybe FontMap)

Convert FontMap to and from GValue. See toGValue and fromGValue.

Defined in GI.Pango.Objects.FontMap

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe FontMap -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe FontMap)

type ParentTypes FontMap

Defined in GI.Pango.Objects.FontMap

type ParentTypes FontMap = '[Object, ListModel]

class (GObject o, IsDescendantOf FontMap o) => IsFontMap o

Type class for types which can be safely cast to FontMap, for instance with toFontMap.

Instances

(GObject o, IsDescendantOf FontMap o) => IsFontMap o

Defined in GI.Pango.Objects.FontMap

toFontMap :: (MonadIO m, IsFontMap o) => o -> m FontMap

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

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, changed, createContext, forceFloating, freezeNotify, getv, isFloating, itemsChanged, listFamilies, loadFont, loadFontset, notify, notifyByPspec, ref, refSink, reloadFont, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getFamily, getItem, getItemType, getNItems, getProperty, getQdata, getSerial.

Setters

setData, setDataFull, setProperty.

changed

fontMapChanged

Arguments

:: (HasCallStack, MonadIO m, IsFontMap a)

=> a

fontmap: a PangoFontMap

-> m ()

Forces a change in the context, which will cause any PangoContext using this fontmap to change.

This function is only useful when implementing a new backend for Pango, something applications won't do. Backends should call this function if they have attached extra data to the context and such data is changed.

Since: 1.34

createContext

fontMapCreateContext

Arguments

:: (HasCallStack, MonadIO m, IsFontMap a)

=> a

fontmap: a PangoFontMap

-> m Context

Returns: the newly allocated PangoContext, which should be freed with objectUnref.

Creates a PangoContext connected to fontmap.

This is equivalent to contextNew followed by contextSetFontMap.

If you are using Pango as part of a higher-level system, that system may have it's own way of create a PangoContext. For instance, the GTK toolkit has, among others, gtk_widget_get_pango_context(). Use those instead.

Since: 1.22

getFamily

fontMapGetFamily

Arguments

:: (HasCallStack, MonadIO m, IsFontMap a)

=> a

fontmap: a PangoFontMap

-> Text

name: a family name

-> m FontFamily

Returns: the PangoFontFamily

Gets a font family by name.

Since: 1.46

getSerial

fontMapGetSerial

Arguments

:: (HasCallStack, MonadIO m, IsFontMap a)

=> a

fontmap: a PangoFontMap

-> m Word32

Returns: The current serial number of fontmap.

Returns the current serial number of fontmap.

The serial number is initialized to an small number larger than zero when a new fontmap is created and is increased whenever the fontmap is changed. It may wrap, but will never have the value 0. Since it can wrap, never compare it with "less than", always use "not equals".

The fontmap can only be changed using backend-specific API, like changing fontmap resolution.

This can be used to automatically detect changes to a PangoFontMap, like in PangoContext.

Since: 1.32.4

listFamilies

fontMapListFamilies

Arguments

:: (HasCallStack, MonadIO m, IsFontMap a)

=> a

fontmap: a PangoFontMap

-> m [FontFamily]

List all families for a fontmap.

Note that the returned families are not in any particular order.

PangoFontMap also implemented the ListModel interface for enumerating families.

loadFont

fontMapLoadFont

Arguments

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

=> a

fontmap: a PangoFontMap

-> b

context: the PangoContext the font will be used with

-> FontDescription

desc: a PangoFontDescription describing the font to load

-> m (Maybe Font)

Returns: the newly allocated PangoFont loaded, or Nothing if no font matched.

Load the font in the fontmap that is the closest match for desc.

loadFontset

fontMapLoadFontset

Arguments

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

=> a

fontmap: a PangoFontMap

-> b

context: the PangoContext the font will be used with

-> FontDescription

desc: a PangoFontDescription describing the font to load

-> Language

language: a PangoLanguage the fonts will be used for

-> m (Maybe Fontset)

Returns: the newly allocated PangoFontset loaded, or Nothing if no font matched.

Load a set of fonts in the fontmap that can be used to render a font matching desc.

reloadFont

fontMapReloadFont

Arguments

:: (HasCallStack, MonadIO m, IsFontMap a, IsFont b, IsContext c)

=> a

fontmap: a PangoFontMap

-> b

font: a font in fontmap

-> Double

scale: the scale factor to apply

-> Maybe c

context: a PangoContext

-> Maybe Text

variations: font variations to use

-> m Font

Returns: the modified font

Returns a new font that is like font, except that its size is multiplied by scale, its backend-dependent configuration (e.g. cairo font options) is replaced by the one in context, and its variations are replaced by variations.

Since: 1.52

Properties

itemType

The type of items contained in this list.

getFontMapItemType :: (MonadIO m, IsFontMap o) => o -> m GType

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

get fontMap #itemType

nItems

The number of items contained in this list.

getFontMapNItems :: (MonadIO m, IsFontMap o) => o -> m Word32

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

get fontMap #nItems