class Gtk::FontDialog

Overview

Asynchronous API to present a font chooser dialog.

Gtk::FontDialog collects the arguments that are needed to present the dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with the Gtk::FontDialog#choose_font function or its variants.

See Gtk::FontDialogButton for a convenient control that uses Gtk::FontDialog and presents the results.

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/font_dialog.cr

Constructors

Class Method Summary

Instance Method Summary

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 : self #

Creates a new Gtk::FontDialog object.


def self.new(*, filter : Gtk::Filter | Nil = nil, font_map : Pango::FontMap | Nil = nil, language : Pango::Language | Nil = nil, modal : Bool | Nil = nil, title : String | 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 choose_face(parent : Gtk::Window | Nil, initial_value : Pango::FontFace | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

Presents a font chooser dialog to the user.

The font chooser dialog will be set up for selecting a font face.

A font face represents a font family and style, but no specific font size.


def choose_face_finish(result : Gio::AsyncResult) : Pango::FontFace | Nil #

Finishes the Gtk::FontDialog#choose_face call.


def choose_family(parent : Gtk::Window | Nil, initial_value : Pango::FontFamily | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

Presents a font chooser dialog to the user.

The font chooser dialog will be set up for selecting a font family.


def choose_family_finish(result : Gio::AsyncResult) : Pango::FontFamily | Nil #

Finishes the Gtk::FontDialog#choose_family call.

This function never returns an error. If the operation is not finished successfully, the value passed as initial_value to Gtk::FontDialog#choose_family is returned.


def choose_font(parent : Gtk::Window | Nil, initial_value : Pango::FontDescription | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

Presents a font chooser dialog to the user.

The font chooser dialog will be set up for selecting a font.

If you want to let the user select font features as well, use Gtk::FontDialog#choose_font_and_features instead.


def choose_font_and_features(parent : Gtk::Window | Nil, initial_value : Pango::FontDescription | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

Presents a font chooser dialog to the user.

The font chooser dialog will be set up for selecting a font and specify features for the selected font.

Font features affect how the font is rendered, for example enabling glyph variants or ligatures.


def choose_font_and_features_finish(result : Gio::AsyncResult, font_desc : Pango::FontDescription, font_features : String, language : Pango::Language) : Bool #

Finishes the Gtk::FontDialog#choose_font_and_features call.

The selected font and features are returned in font_desc and font_features.


def choose_font_finish(result : Gio::AsyncResult) : Pango::FontDescription | Nil #

Finishes the Gtk::FontDialog#choose_font call.


def filter : Gtk::Filter | Nil #

Returns the filter that decides which fonts to display in the font chooser dialog.


def filter=(filter : Gtk::Filter | Nil) : Nil #

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

The filter must be able to handle both Pango::FontFamily and Pango::FontFace objects.


def font_map : Pango::FontMap | Nil #

Returns the fontmap from which fonts are selected, or NULL for the default fontmap.


def font_map=(fontmap : Pango::FontMap | Nil) : Nil #

Sets the fontmap from which fonts are selected.

If fontmap is NULL, the default fontmap is used.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def language : Pango::Language | Nil #

Returns the language for which font features are applied.


def language=(language : Pango::Language) : Nil #

Sets the language for which font features are applied.


def language=(value : Pango::Language | Nil) : Pango::Language | Nil #

def modal : Bool #

Returns whether the font chooser dialog blocks interaction with the parent window while it is presented.


def modal=(modal : Bool) : Nil #

Sets whether the font chooser dialog blocks interaction with the parent window while it is presented.


def modal? : Bool #

def title : String #

Returns the title that will be shown on the font chooser dialog.


def title=(title : String) : Nil #

Sets the title that will be shown on the font chooser dialog.


def title=(value : Nil) : Nil #

Set #title property to nil.


def title? : String | Nil #

Same as #title, but can return nil.