Package org.gnome.gtk

Class FontDialog

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.FontDialog

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class FontDialog
extends GObject

Asynchronous API to present a font chooser dialog.

GtkFontDialog 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 chooseFont(org.gnome.gtk.Window, org.gnome.pango.FontDescription, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) function or its variants.

See FontDialogButton for a convenient control that uses GtkFontDialog and presents the results.

Since:

4.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FontDialog.Builder<B extends FontDialog.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	FontDialog.FontDialogClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
FontDialog()	Creates a new FontDialog.
FontDialog(MemorySegment address)	Create a FontDialog proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected FontDialog	asParent()	Returns this instance as if it were its parent type.
static FontDialog.Builder<? extends FontDialog.Builder>	builder()	A FontDialog.Builder object constructs a FontDialog with the specified properties.
void	chooseFace(@Nullable Window parent, @Nullable FontFace initialValue, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents a font chooser dialog to the user.
FontFace	chooseFaceFinish(AsyncResult result)	Finishes the chooseFace(org.gnome.gtk.Window, org.gnome.pango.FontFace, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.
void	chooseFamily(@Nullable Window parent, @Nullable FontFamily initialValue, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents a font chooser dialog to the user.
FontFamily	chooseFamilyFinish(AsyncResult result)	Finishes the chooseFamily(org.gnome.gtk.Window, org.gnome.pango.FontFamily, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.
void	chooseFont(@Nullable Window parent, @Nullable FontDescription initialValue, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents a font chooser dialog to the user.
void	chooseFontAndFeatures(@Nullable Window parent, @Nullable FontDescription initialValue, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents a font chooser dialog to the user.
FontDescription	chooseFontFinish(AsyncResult result)	Finishes the chooseFont(org.gnome.gtk.Window, org.gnome.pango.FontDescription, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.
@Nullable Filter	getFilter()	Returns the filter that decides which fonts to display in the font chooser dialog.
@Nullable FontMap	getFontMap()	Returns the fontmap from which fonts are selected, or NULL for the default fontmap.
@Nullable Language	getLanguage()	Returns the language for which font features are applied.
boolean	getModal()	Returns whether the font chooser dialog blocks interaction with the parent window while it is presented.
String	getTitle()	Returns the title that will be shown on the font chooser dialog.
static @Nullable Type	getType()	Get the GType of the FontDialog class
void	setFilter(@Nullable Filter filter)	Adds a filter that decides which fonts to display in the font chooser dialog.
void	setFontMap(@Nullable FontMap fontmap)	Sets the fontmap from which fonts are selected.
void	setLanguage(Language language)	Sets the language for which font features are applied.
void	setModal(boolean modal)	Sets whether the font chooser dialog blocks interaction with the parent window while it is presented.
void	setTitle(String title)	Sets the title that will be shown on the font chooser dialog.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FontDialog

public FontDialog(MemorySegment address)

Create a FontDialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FontDialog

public FontDialog()

Creates a new FontDialog.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FontDialog class

Returns:

the GType

asParent

protected FontDialog asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

chooseFace

public void chooseFace(@Nullable Window parent,
 @Nullable FontFace initialValue,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

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.

Parameters:

parent - the parent window

initialValue - the initial value

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

chooseFaceFinish

public FontFace chooseFaceFinish(AsyncResult result)
                          throws GErrorException

Finishes the chooseFace(org.gnome.gtk.Window, org.gnome.pango.FontFace, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the selected FontFace

Throws:

GErrorException - see GError

Since:

4.10

chooseFamily

public void chooseFamily(@Nullable Window parent,
 @Nullable FontFamily initialValue,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Presents a font chooser dialog to the user.

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

Parameters:

parent - the parent window

initialValue - the initial value

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

chooseFamilyFinish

public FontFamily chooseFamilyFinish(AsyncResult result)
                              throws GErrorException

Finishes the chooseFamily(org.gnome.gtk.Window, org.gnome.pango.FontFamily, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the selected FontFamily

Throws:

GErrorException - see GError

Since:

4.10

chooseFont

public void chooseFont(@Nullable Window parent,
 @Nullable FontDescription initialValue,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

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 chooseFontAndFeatures(org.gnome.gtk.Window, org.gnome.pango.FontDescription, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) instead.

Parameters:

parent - the parent window

initialValue - the font to select initially

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

chooseFontAndFeatures

public void chooseFontAndFeatures(@Nullable Window parent,
 @Nullable FontDescription initialValue,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

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.

Parameters:

parent - the parent window

initialValue - the font to select initially

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

chooseFontFinish

public FontDescription chooseFontFinish(AsyncResult result)
                                 throws GErrorException

Finishes the chooseFont(org.gnome.gtk.Window, org.gnome.pango.FontDescription, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

a Pango.FontDescription describing the selected font

Throws:

GErrorException - see GError

Since:

4.10

getFilter

public @Nullable Filter getFilter()

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

Returns:

the filter

Since:

4.10

getFontMap

public @Nullable FontMap getFontMap()

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

Returns:

the fontmap

Since:

4.10

getLanguage

public @Nullable Language getLanguage()

Returns the language for which font features are applied.

Returns:

the language for font features

Since:

4.10

getModal

public boolean getModal()

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

Returns:

true if the font chooser dialog is modal

Since:

4.10

getTitle

public String getTitle()

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

Returns:

the title

Since:

4.10

setFilter

public void setFilter(@Nullable Filter filter)

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

The filter must be able to handle both PangoFontFamily and PangoFontFace objects.

Parameters:

filter - the filter

Since:

4.10

setFontMap

public void setFontMap(@Nullable FontMap fontmap)

Sets the fontmap from which fonts are selected.

If fontmap is NULL, the default fontmap is used.

Parameters:

fontmap - the fontmap

Since:

4.10

setLanguage

public void setLanguage(Language language)

Sets the language for which font features are applied.

Parameters:

language - the language for font features

Since:

4.10

setModal

public void setModal(boolean modal)

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

Parameters:

modal - the new value

Since:

4.10

setTitle

public void setTitle(String title)

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

Parameters:

title - the new title

Since:

4.10

builder

public static FontDialog.Builder<? extends FontDialog.Builder> builder()

A FontDialog.Builder object constructs a FontDialog with the specified properties. Use the various set...() methods to set properties, and finish construction with FontDialog.Builder.build().

Returns:

the builder object