class Pango::FontMap

Overview

A Pango::FontMap represents the set of fonts available for a particular rendering system.

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

Included Modules

Defined in:

lib/gi-crystal/src/auto/pango-1.0/font_map.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gio::ListModel

item(position : UInt32) : GObject::Object | Nil item, item_type : UInt64 item_type, items_changed(position : UInt32, removed : UInt32, added : UInt32) : Nil
items_changed(position : Int, removed : Int, added : Int) : Nil items_changed, items_changed_signal items_changed_signal, n_items : UInt32 n_items, to_unsafe to_unsafe

Constructor methods inherited from module Gio::ListModel

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gio::ListModel

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new #

Initialize a new FontMap.


def self.new(*, item_type : UInt64 | Nil = nil, n_items : UInt32 | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def add_font_file(filename : String) : Bool #

Loads a font file with one or more fonts into the Pango::FontMap.

The added fonts will take precedence over preexisting fonts with the same name.


def changed : Nil #

Forces a change in the context, which will cause any Pango::Context 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.


def create_context : Pango::Context #

Creates a Pango::Context connected to fontmap.

This is equivalent to Pango::Context.new followed by Pango::Context#font_map=.

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


def family(name : String) : Pango::FontFamily #

Gets a font family by name.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def item_type : UInt64 #

def list_families(families : Enumerable(Pango::FontFamily)) : Nil #

List all families for a fontmap.

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

Pango::FontMap also implemented the Gio::ListModel interface for enumerating families.


def list_families(*families : Pango::FontFamily) #

def load_font(context : Pango::Context, desc : Pango::FontDescription) : Pango::Font | Nil #

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


def load_fontset(context : Pango::Context, desc : Pango::FontDescription, language : Pango::Language) : Pango::Fontset | Nil #

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


def n_items : UInt32 #

def reload_font(font : Pango::Font, scale : Float64, context : Pango::Context | Nil, variations : String | Nil) : Pango::Font #

Returns a new font that is like font, except that it is scaled 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.

Note that the scaling here is meant to be linear, so this scaling can be used to render a font on a hi-dpi display without changing its optical size.


def serial : UInt32 #

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 Pango::FontMap, like in Pango::Context.