Class WidgetPaintable

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.WidgetPaintable

All Implemented Interfaces:

Paintable, Proxy

@Generated("org.javagi.JavaGI")
public class WidgetPaintable
extends GObject
implements Paintable

A GdkPaintable that displays the contents of a widget.

GtkWidgetPaintable will also take care of the widget not being in a state where it can be drawn (like when it isn't shown) and just draw nothing or where it does not have a size (like when it is hidden) and report no size in that case.

Of course, GtkWidgetPaintable allows you to monitor widgets for size changes by emitting the Gdk.Paintable::invalidate-size signal whenever the size of the widget changes as well as for visual changes by emitting the Gdk.Paintable::invalidate-contents signal whenever the widget changes.

You can use a GtkWidgetPaintable everywhere a GdkPaintable is allowed, including using it on a GtkPicture (or one of its parents) that it was set on itself via gtk_picture_set_paintable(). The paintable will take care of recursion when this happens. If you do this however, ensure that the Gtk.Picture:can-shrink property is set to true or you might end up with an infinitely growing widget.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Paintable

Paintable.InvalidateContentsCallback, Paintable.InvalidateSizeCallback, Paintable.Paintable$Impl, Paintable.PaintableInterface

Constructor Summary

Constructors

Constructor	Description
WidgetPaintable()	Create a new WidgetPaintable.
WidgetPaintable(MemorySegment address)	Create a WidgetPaintable instance for the provided memory address.
WidgetPaintable(@Nullable Widget widget)	Creates a new widget paintable observing the given widget.

Method Summary

Modifier and Type	Method	Description
protected WidgetPaintable	asParent()	Return this instance as if it were its parent type.
static WidgetPaintable.Builder<? extends WidgetPaintable.Builder>	builder()	A WidgetPaintable.Builder object constructs a WidgetPaintable with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the WidgetPaintable class.
@Nullable Widget	getWidget()	Returns the widget that is observed or null if none.
void	setWidget(@Nullable Widget widget)	Sets the widget that should be observed.

Methods inherited from class 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Methods inherited from interface Paintable

computeConcreteSize, emitInvalidateContents, emitInvalidateSize, getCurrentImage, getFlags, getIntrinsicAspectRatio, getIntrinsicHeight, getIntrinsicWidth, invalidateContents, invalidateSize, onInvalidateContents, onInvalidateSize, snapshot

Methods inherited from interface Proxy

handle

Constructor Details

WidgetPaintable

public WidgetPaintable(MemorySegment address)

Create a WidgetPaintable instance for the provided memory address.

Parameters:

address - the memory address of the native object

WidgetPaintable

public WidgetPaintable(@Nullable Widget widget)

Creates a new widget paintable observing the given widget.

Parameters:

widget - a GtkWidget

WidgetPaintable

public WidgetPaintable()

Create a new WidgetPaintable.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the WidgetPaintable class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected WidgetPaintable asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

getWidget

public @Nullable Widget getWidget()

Returns the widget that is observed or null if none.

Returns:

the observed widget.

setWidget

public void setWidget(@Nullable Widget widget)

Sets the widget that should be observed.

Parameters:

widget - the widget to observe

builder

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

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

Returns:

the builder object