Package org.gnome.pango

Class FontFamily

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.pango.FontFamily

All Implemented Interfaces:

Iterable<FontFace>, Collection<FontFace>, List<FontFace>, SequencedCollection<FontFace>, ListModel<FontFace>, Proxy, ListModelJavaList<FontFace>

Direct Known Subclasses:

FontFamily.FontFamily$Impl

@Generated("io.github.jwharm.JavaGI")
public abstract class FontFamily
extends GObject
implements ListModel<FontFace>

A PangoFontFamily is used to represent a family of related font faces.

The font faces in a family share a common design, but differ in slant, weight, width or other aspects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FontFamily.Builder<B extends FontFamily.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	FontFamily.FontFamily$Impl	The FontFamily$Impl type represents a native instance of the abstract FontFamily class.
static class	FontFamily.FontFamilyClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.ListModel

ListModel.ItemsChangedCallback, ListModel.ListModel$Impl, ListModel.ListModelInterface

Nested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaList

ListModelJavaList.SubList<E extends @Nullable GObject,List extends ListModelJavaList<E>>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected FontFamily	asParent()	Returns this instance as if it were its parent type.
@Nullable FontFace	getFace(@Nullable String name)	Gets the PangoFontFace of this FontFamily with the given name.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getName()	Gets the name of the family.
static @Nullable Type	getType()	Get the GType of the FontFamily class
boolean	isMonospace()	A monospace font is a font designed for text display where the the characters form a regular grid.
boolean	isVariable()	A variable font is a font which has axes that can be modified to produce different faces.
void	listFaces(@Nullable Out<FontFace[]> faces)	Lists the different font faces that make up family.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, builder, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, 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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.gnome.gio.ListModel

emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChanged

Methods inherited from interface org.javagi.gio.ListModelJavaList

add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

FontFamily

public FontFamily(MemorySegment address)

Create a FontFamily proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FontFamily

public FontFamily()

Creates a new FontFamily.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FontFamily class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected FontFamily 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

getFace

public @Nullable FontFace getFace(@Nullable String name)

Gets the PangoFontFace of this FontFamily with the given name.

Parameters:

name - the name of a face. If the name is null, the family's default face (fontconfig calls it "Regular") will be returned.

Returns:

the PangoFontFace, or null if no face with the given name exists.

Since:

1.46

getName

public String getName()

Gets the name of the family.

The name is unique among all fonts for the font backend and can be used in a PangoFontDescription to specify that a face from this family is desired.

Returns:

the name of the family. This string is owned by the family object and must not be modified or freed.

isMonospace

public boolean isMonospace()

A monospace font is a font designed for text display where the the characters form a regular grid.

For Western languages this would mean that the advance width of all characters are the same, but this categorization also includes Asian fonts which include double-width characters: characters that occupy two grid cells. g_unichar_iswide() returns a result that indicates whether a character is typically double-width in a monospace font.

The best way to find out the grid-cell size is to call FontMetrics.getApproximateDigitWidth(), since the results of FontMetrics.getApproximateCharWidth() may be affected by double-width characters.

Returns:

true if the family is monospace.

Since:

1.4

isVariable

public boolean isVariable()

A variable font is a font which has axes that can be modified to produce different faces.

Such axes are also known as _variations_; see FontDescription.setVariations(java.lang.String) for more information.

Returns:

true if the family is variable

Since:

1.44

listFaces

public void listFaces(@Nullable Out<FontFace[]> faces)

Lists the different font faces that make up family.

The faces in a family share a common design, but differ in slant, weight, width and other aspects.

Note that the returned faces are not in any particular order, and multiple faces may have the same name or characteristics.

PangoFontFamily also implemented the ListModel interface for enumerating faces.

Parameters:

faces - location to store an array of pointers to PangoFontFace objects, or null. This array should be freed with g_free() when it is no longer needed.