Package org.gnome.gtk

Class Inscription

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.Inscription

All Implemented Interfaces:

Accessible, AccessibleText, Buildable, ConstraintTarget, Proxy

@Generated("io.github.jwharm.JavaGI")
public class Inscription
extends Widget
implements Accessible, AccessibleText, Buildable, ConstraintTarget

Shows text in a predefined area.

You likely want to use GtkLabel instead as this widget is intended only for a small subset of use cases. The main scenario envisaged is inside lists such as GtkColumnView.

While a GtkLabel sizes itself depending on the text that is displayed, GtkInscription is given a size and inscribes the given text into that space as well as it can.

Users of this widget should take care to plan behaviour for the common case where the text doesn't fit exactly in the allocated space.

CSS nodes
GtkInscription has a single CSS node with the name label.

Since:

4.8

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.AccessibleText

AccessibleText.AccessibleText$Impl, AccessibleText.AccessibleTextInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
Inscription()	Creates a new Inscription.
Inscription(@Nullable String text)	Creates a new GtkInscription with the given text.
Inscription(MemorySegment address)	Create a Inscription proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Inscription	asParent()	Returns this instance as if it were its parent type.
static Inscription.Builder<? extends Inscription.Builder>	builder()	A Inscription.Builder object constructs a Inscription with the specified properties.
@Nullable AttrList	getAttributes()	Gets the inscription's attribute list.
int	getMinChars()	Gets the min-chars of the inscription.
int	getMinLines()	Gets the min-lines of the inscription.
int	getNatChars()	Gets the nat-chars of the inscription.
int	getNatLines()	Gets the nat-lines of the inscription.
@Nullable String	getText()	Gets the text that is displayed.
InscriptionOverflow	getTextOverflow()	Gets the inscription's overflow method.
static @Nullable Type	getType()	Get the GType of the Inscription class
WrapMode	getWrapMode()	Returns line wrap mode used by the inscription.
float	getXalign()	Gets the xalign of the inscription.
float	getYalign()	Gets the yalign of the inscription.
void	setAttributes(@Nullable AttrList attrs)	Apply attributes to the inscription text.
void	setMarkup(@Nullable String markup)	Utility function to set the text and attributes to be displayed.
void	setMinChars(int minChars)	Sets the min-chars of the inscription.
void	setMinLines(int minLines)	Sets the min-lines of the inscription.
void	setNatChars(int natChars)	Sets the nat-chars of the inscription.
void	setNatLines(int natLines)	Sets the nat-lines of the inscription.
void	setText(@Nullable String text)	Sets the text to be displayed.
void	setTextOverflow(InscriptionOverflow overflow)	Sets what to do when the text doesn't fit.
void	setWrapMode(WrapMode wrapMode)	Controls how line wrapping is done.
void	setXalign(float xalign)	Sets the xalign of the inscription.
void	setYalign(float yalign)	Sets the yalign of the inscription.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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, 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 org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.AccessibleText

updateCaretPosition, updateContents, updateSelectionBound

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

Inscription

public Inscription(MemorySegment address)

Create a Inscription proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Inscription

public Inscription(@Nullable String text)

Creates a new GtkInscription with the given text.

Parameters:

text - The text to display.

Since:

4.8

Inscription

public Inscription()

Creates a new Inscription.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Inscription class

Returns:

the GType

asParent

protected Inscription 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 Widget

getAttributes

public @Nullable AttrList getAttributes()

Gets the inscription's attribute list.

Returns:

the attribute list

Since:

4.8

getMinChars

public int getMinChars()

Gets the min-chars of the inscription.

See the Gtk.Inscription:min-chars property.

Returns:

the min-chars property

Since:

4.8

getMinLines

public int getMinLines()

Gets the min-lines of the inscription.

See the Gtk.Inscription:min-lines property.

Returns:

the min-lines property

Since:

4.8

getNatChars

public int getNatChars()

Gets the nat-chars of the inscription.

See the Gtk.Inscription:nat-chars property.

Returns:

the nat-chars property

Since:

4.8

getNatLines

public int getNatLines()

Gets the nat-lines of the inscription.

See the Gtk.Inscription:nat-lines property.

Returns:

the nat-lines property

Since:

4.8

getText

public @Nullable String getText()

Gets the text that is displayed.

Returns:

The displayed text

Since:

4.8

getTextOverflow

public InscriptionOverflow getTextOverflow()

Gets the inscription's overflow method.

Returns:

the overflow method

Since:

4.8

getWrapMode

public WrapMode getWrapMode()

Returns line wrap mode used by the inscription.

See setWrapMode(org.gnome.pango.WrapMode).

Returns:

the line wrap mode

Since:

4.8

getXalign

public float getXalign()

Gets the xalign of the inscription.

See the Gtk.Inscription:xalign property.

Returns:

the xalign property

Since:

4.8

getYalign

public float getYalign()

Gets the yalign of the inscription.

See the Gtk.Inscription:yalign property.

Returns:

the yalign property

Since:

4.8

setAttributes

public void setAttributes(@Nullable AttrList attrs)

Apply attributes to the inscription text.

These attributes will not be evaluated for sizing the inscription.

Parameters:

attrs - a Pango.AttrList

Since:

4.8

setMarkup

public void setMarkup(@Nullable String markup)

Utility function to set the text and attributes to be displayed.

See the Gtk.Inscription:markup property.

Parameters:

markup - The markup to display

Since:

4.8

setMinChars

public void setMinChars(int minChars)

Sets the min-chars of the inscription.

See the Gtk.Inscription:min-chars property.

Parameters:

minChars - the minimum number of characters that should fit, approximately

Since:

4.8

setMinLines

public void setMinLines(int minLines)

Sets the min-lines of the inscription.

See the Gtk.Inscription:min-lines property.

Parameters:

minLines - the minimum number of lines that should fit, approximately

Since:

4.8

setNatChars

public void setNatChars(int natChars)

Sets the nat-chars of the inscription.

See the Gtk.Inscription:nat-chars property.

Parameters:

natChars - the number of characters that should ideally fit, approximately

Since:

4.8

setNatLines

public void setNatLines(int natLines)

Sets the nat-lines of the inscription.

See the Gtk.Inscription:nat-lines property.

Parameters:

natLines - the number of lines that should ideally fit

Since:

4.8

setText

public void setText(@Nullable String text)

Sets the text to be displayed.

Parameters:

text - The text to display

Since:

4.8

setTextOverflow

public void setTextOverflow(InscriptionOverflow overflow)

Sets what to do when the text doesn't fit.

Parameters:

overflow - the overflow method to use

Since:

4.8

setWrapMode

public void setWrapMode(WrapMode wrapMode)

Controls how line wrapping is done.

Parameters:

wrapMode - the line wrapping mode

Since:

4.8

setXalign

public void setXalign(float xalign)

Sets the xalign of the inscription.

See the Gtk.Inscription:xalign property.

Parameters:

xalign - the new xalign value, between 0 and 1

Since:

4.8

setYalign

public void setYalign(float yalign)

Sets the yalign of the inscription.

See the Gtk.Inscription:yalign property.

Parameters:

yalign - the new yalign value, between 0 and 1

Since:

4.8

builder

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

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

Returns:

the builder object