Package org.gnome.pango

Class Context

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.pango.Context

All Implemented Interfaces:

Proxy

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

A PangoContext stores global information used to control the itemization process.

The information stored by PangoContext includes the fontmap used to look up fonts, and default values such as the default language, default gravity, or default font.

To obtain a PangoContext, use FontMap.createContext().

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Context()	Creates a new PangoContext initialized to default values.
Context(MemorySegment address)	Create a Context proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Context	asParent()	Returns this instance as if it were its parent type.
static Context.Builder<? extends Context.Builder>	builder()	A Context.Builder object constructs a Context with the specified properties.
void	changed()	Forces a change in the context, which will cause any PangoLayout using this context to re-layout.
Direction	getBaseDir()	Retrieves the base direction for the context.
Gravity	getBaseGravity()	Retrieves the base gravity for the context.
FontDescription	getFontDescription()	Retrieve the default font description for the context.
FontMap	getFontMap()	Gets the PangoFontMap used to look up fonts for this context.
Gravity	getGravity()	Retrieves the gravity for the context.
GravityHint	getGravityHint()	Retrieves the gravity hint for the context.
Language	getLanguage()	Retrieves the global language tag for the context.
Matrix	getMatrix()	Gets the transformation matrix that will be applied when rendering with this context.
FontMetrics	getMetrics(@Nullable FontDescription desc, @Nullable Language language)	Get overall metric information for a particular font description.
boolean	getRoundGlyphPositions()	Returns whether font rendering with this context should round glyph positions and widths.
int	getSerial()	Returns the current serial number of this Context.
static Type	getType()	Get the GType of the Context class
void	listFamilies(Out<FontFamily[]> families)	List all families for a context.
Font	loadFont(FontDescription desc)	Loads the font in one of the fontmaps in the context that is the closest match for desc.
Fontset	loadFontset(FontDescription desc, Language language)	Load a set of fonts in the context that can be used to render a font matching desc.
void	setBaseDir(Direction direction)	Sets the base direction for the context.
void	setBaseGravity(Gravity gravity)	Sets the base gravity for the context.
void	setFontDescription(@Nullable FontDescription desc)	Set the default font description for the context
void	setFontMap(@Nullable FontMap fontMap)	Sets the font map to be searched when fonts are looked-up in this context.
void	setGravityHint(GravityHint hint)	Sets the gravity hint for the context.
void	setLanguage(@Nullable Language language)	Sets the global language tag for the context.
void	setMatrix(@Nullable Matrix matrix)	Sets the transformation matrix that will be applied when rendering with this context.
void	setRoundGlyphPositions(boolean roundPositions)	Sets whether font rendering with this context should round glyph positions and widths to integral positions, in device units.

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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

Context

public Context(MemorySegment address)

Create a Context proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Context

public Context()

Creates a new PangoContext initialized to default values.

This function is not particularly useful as it should always be followed by a setFontMap(org.gnome.pango.FontMap) call, and the function FontMap.createContext() does these two steps together and hence users are recommended to use that.

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.

Method Details

getType

public static Type getType()

Get the GType of the Context class

Returns:

the GType

asParent

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

changed

public void changed()

Forces a change in the context, which will cause any PangoLayout using this context to re-layout.

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.

getBaseDir

public Direction getBaseDir()

Retrieves the base direction for the context.

See setBaseDir(org.gnome.pango.Direction).

Returns:

the base direction for the context.

getBaseGravity

public Gravity getBaseGravity()

Retrieves the base gravity for the context.

See setBaseGravity(org.gnome.pango.Gravity).

Returns:

the base gravity for the context.

getFontDescription

public FontDescription getFontDescription()

Retrieve the default font description for the context.

Returns:

a pointer to the context's default font description. This value must not be modified or freed.

getFontMap

public FontMap getFontMap()

Gets the PangoFontMap used to look up fonts for this context.

Returns:

the font map for the. PangoContext This value is owned by Pango and should not be unreferenced.

getGravity

public Gravity getGravity()

Retrieves the gravity for the context.

This is similar to getBaseGravity(), except for when the base gravity is Gravity.AUTO for which Gravity.getForMatrix(org.gnome.pango.Matrix) is used to return the gravity from the current context matrix.

Returns:

the resolved gravity for the context.

getGravityHint

public GravityHint getGravityHint()

Retrieves the gravity hint for the context.

See setGravityHint(org.gnome.pango.GravityHint) for details.

Returns:

the gravity hint for the context.

getLanguage

public Language getLanguage()

Retrieves the global language tag for the context.

Returns:

the global language tag.

getMatrix

public Matrix getMatrix()

Gets the transformation matrix that will be applied when rendering with this context.

See setMatrix(org.gnome.pango.Matrix).

Returns:

the matrix, or null if no matrix has been set (which is the same as the identity matrix). The returned matrix is owned by Pango and must not be modified or freed.

getMetrics

public FontMetrics getMetrics(@Nullable
 @Nullable FontDescription desc,
 @Nullable
 @Nullable Language language)

Get overall metric information for a particular font description.

Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be retrieved that correspond to the script(s) used by that language.

The PangoFontDescription is interpreted in the same way as by Pango.itemize(org.gnome.pango.Context, java.lang.String, int, int, org.gnome.pango.AttrList, org.gnome.pango.AttrIterator), and the family name may be a comma separated list of names. If characters from multiple of these families would be used to render the string, then the returned fonts would be a composite of the metrics for the fonts loaded for the individual families.

Parameters:

desc - a PangoFontDescription structure. null means that the font description from the context will be used.

language - language tag used to determine which script to get the metrics for. null means that the language tag from the context will be used. If no language tag is set on the context, metrics for the default language (as determined by Language.getDefault() will be returned.

Returns:

a PangoFontMetrics object. The caller must call FontMetrics.unref() when finished using the object.

getRoundGlyphPositions

public boolean getRoundGlyphPositions()

Returns whether font rendering with this context should round glyph positions and widths.

getSerial

public int getSerial()

Returns the current serial number of this Context.

The serial number is initialized to an small number larger than zero when a new context is created and is increased whenever the context is changed using any of the setter functions, or the PangoFontMap it uses to find fonts has changed. The serial may wrap, but will never have the value 0. Since it can wrap, never compare it with "less than", always use "not equals".

This can be used to automatically detect changes to a PangoContext, and is only useful when implementing objects that need update when their PangoContext changes, like PangoLayout.

Returns:

The current serial number of this Context.

listFamilies

public void listFamilies(Out<FontFamily[]> families)

List all families for a context.

Parameters:

families - location to store a pointer to an array of PangoFontFamily. This array should be freed with g_free().

loadFont

public Font loadFont(FontDescription desc)

Loads the font in one of the fontmaps in the context that is the closest match for desc.

Parameters:

desc - a PangoFontDescription describing the font to load

Returns:

the newly allocated PangoFont that was loaded, or null if no font matched.

loadFontset

public Fontset loadFontset(FontDescription desc,
 Language language)

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

Parameters:

desc - a PangoFontDescription describing the fonts to load

language - a PangoLanguage the fonts will be used for

Returns:

the newly allocated PangoFontset loaded, or null if no font matched.

setBaseDir

public void setBaseDir(Direction direction)

Sets the base direction for the context.

The base direction is used in applying the Unicode bidirectional algorithm; if the direction is Direction.LTR or Direction.RTL, then the value will be used as the paragraph direction in the Unicode bidirectional algorithm. A value of Direction.WEAK_LTR or Direction.WEAK_RTL is used only for paragraphs that do not contain any strong characters themselves.

Parameters:

direction - the new base direction

setBaseGravity

public void setBaseGravity(Gravity gravity)

Sets the base gravity for the context.

The base gravity is used in laying vertical text out.

Parameters:

gravity - the new base gravity

setFontDescription

public void setFontDescription(@Nullable
 @Nullable FontDescription desc)

Set the default font description for the context

Parameters:

desc - the new pango font description

setFontMap

public void setFontMap(@Nullable
 @Nullable FontMap fontMap)

Sets the font map to be searched when fonts are looked-up in this context.

This is only for internal use by Pango backends, a PangoContext obtained via one of the recommended methods should already have a suitable font map.

Parameters:

fontMap - the PangoFontMap to set.

setGravityHint

public void setGravityHint(GravityHint hint)

Sets the gravity hint for the context.

The gravity hint is used in laying vertical text out, and is only relevant if gravity of the context as returned by getGravity() is set to Gravity.EAST or Gravity.WEST.

Parameters:

hint - the new gravity hint

setLanguage

public void setLanguage(@Nullable
 @Nullable Language language)

Sets the global language tag for the context.

The default language for the locale of the running process can be found using Language.getDefault().

Parameters:

language - the new language tag.

setMatrix

public void setMatrix(@Nullable
 @Nullable Matrix matrix)

Sets the transformation matrix that will be applied when rendering with this context.

Note that reported metrics are in the user space coordinates before the application of the matrix, not device-space coordinates after the application of the matrix. So, they don't scale with the matrix, though they may change slightly for different matrices, depending on how the text is fit to the pixel grid.

Parameters:

matrix - a PangoMatrix, or null to unset any existing matrix. (No matrix set is the same as setting the identity matrix.)

setRoundGlyphPositions

public void setRoundGlyphPositions(boolean roundPositions)

Sets whether font rendering with this context should round glyph positions and widths to integral positions, in device units.

This is useful when the renderer can't handle subpixel positioning of glyphs.

The default value is to round glyph positions, to remain compatible with previous Pango behavior.

Parameters:

roundPositions - whether to round glyph positions

builder

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

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