Package org.gnome.gtk

Class CellAreaContext

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.CellAreaContext

All Implemented Interfaces:

Proxy

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

Deprecated.

This object will be removed in GTK 5

Stores geometrical information for a series of rows in a GtkCellArea

The GtkCellAreaContext object is created by a given GtkCellArea implementation via its GtkCellAreaClass.create_context() virtual method and is used to store cell sizes and alignments for a series of GtkTreeModel rows that are requested and rendered in the same context.

GtkCellLayout widgets can create any number of contexts in which to request and render groups of data rows. However, it’s important that the same context which was used to request sizes for a given GtkTreeModel row also be used for the same row when calling other GtkCellArea APIs such as gtk_cell_area_render() and gtk_cell_area_event().

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	allocate(int width, int height)	Deprecated. This object will be removed in GTK 5
protected CellAreaContext	asParent()	Deprecated. Returns this instance as if it were its parent type.
static CellAreaContext.Builder<? extends CellAreaContext.Builder>	builder()	Deprecated. A CellAreaContext.Builder object constructs a CellAreaContext with the specified properties.
void	getAllocation(@Nullable Out<Integer> width, @Nullable Out<Integer> height)	Deprecated. This object will be removed in GTK 5
CellArea	getArea()	Deprecated. This object will be removed in GTK 5
static MemoryLayout	getMemoryLayout()	Deprecated. The memory layout of the native struct.
void	getPreferredHeight(@Nullable Out<Integer> minimumHeight, @Nullable Out<Integer> naturalHeight)	Deprecated. This object will be removed in GTK 5
void	getPreferredHeightForWidth(int width, @Nullable Out<Integer> minimumHeight, @Nullable Out<Integer> naturalHeight)	Deprecated. This object will be removed in GTK 5
void	getPreferredWidth(@Nullable Out<Integer> minimumWidth, @Nullable Out<Integer> naturalWidth)	Deprecated. This object will be removed in GTK 5
void	getPreferredWidthForHeight(int height, @Nullable Out<Integer> minimumWidth, @Nullable Out<Integer> naturalWidth)	Deprecated. This object will be removed in GTK 5
static @Nullable Type	getType()	Deprecated. Get the GType of the CellAreaContext class
void	pushPreferredHeight(int minimumHeight, int naturalHeight)	Deprecated. This object will be removed in GTK 5
void	pushPreferredWidth(int minimumWidth, int naturalWidth)	Deprecated. This object will be removed in GTK 5
void	reset()	Deprecated. This object will be removed in GTK 5

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

Constructor Details

CellAreaContext

public CellAreaContext(MemorySegment address)

Deprecated.

Create a CellAreaContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

CellAreaContext

public CellAreaContext()

Deprecated.

Creates a new CellAreaContext.

Method Details

getType

public static @Nullable Type getType()

Deprecated.

Get the GType of the CellAreaContext class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

Deprecated.

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected CellAreaContext asParent()

Deprecated.

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

allocate

@Deprecated
public void allocate(int width,
 int height)

Deprecated.

This object will be removed in GTK 5

Allocates a width and/or a height for all rows which are to be rendered with context.

Usually allocation is performed only horizontally or sometimes vertically since a group of rows are usually rendered side by side vertically or horizontally and share either the same width or the same height. Sometimes they are allocated in both horizontal and vertical orientations producing a homogeneous effect of the rows. This is generally the case for GtkTreeView when GtkTreeView:fixed-height-mode is enabled.

Parameters:

width - the allocated width for all GtkTreeModel rows rendered with context, or -1

height - the allocated height for all GtkTreeModel rows rendered with context, or -1

getAllocation

@Deprecated
public void getAllocation(@Nullable Out<Integer> width,
 @Nullable Out<Integer> height)

Deprecated.

This object will be removed in GTK 5

Fetches the current allocation size for context.

If the context was not allocated in width or height, or if the context was recently reset with gtk_cell_area_context_reset(), the returned value will be -1.

Parameters:

width - location to store the allocated width

height - location to store the allocated height

getArea

@Deprecated
public CellArea getArea()

Deprecated.

This object will be removed in GTK 5

Fetches the GtkCellArea this this CellAreaContext was created by.

This is generally unneeded by layouting widgets; however, it is important for the context implementation itself to fetch information about the area it is being used for.

For instance at GtkCellAreaContextClass.allocate() time it’s important to know details about any cell spacing that the GtkCellArea is configured with in order to compute a proper allocation.

Returns:

the GtkCellArea this context was created by.

getPreferredHeight

@Deprecated
public void getPreferredHeight(@Nullable Out<Integer> minimumHeight,
 @Nullable Out<Integer> naturalHeight)

Deprecated.

This object will be removed in GTK 5

Gets the accumulative preferred height for all rows which have been requested with this context.

After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a GtkCellArea, the returned values are 0.

Parameters:

minimumHeight - location to store the minimum height

naturalHeight - location to store the natural height

getPreferredHeightForWidth

@Deprecated
public void getPreferredHeightForWidth(int width,
 @Nullable Out<Integer> minimumHeight,
 @Nullable Out<Integer> naturalHeight)

Deprecated.

This object will be removed in GTK 5

Gets the accumulative preferred height for width for all rows which have been requested for the same said width with this context.

After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a GtkCellArea, the returned values are -1.

Parameters:

width - a proposed width for allocation

minimumHeight - location to store the minimum height

naturalHeight - location to store the natural height

getPreferredWidth

@Deprecated
public void getPreferredWidth(@Nullable Out<Integer> minimumWidth,
 @Nullable Out<Integer> naturalWidth)

Deprecated.

This object will be removed in GTK 5

Gets the accumulative preferred width for all rows which have been requested with this context.

After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a GtkCellArea, the returned values are 0.

Parameters:

minimumWidth - location to store the minimum width

naturalWidth - location to store the natural width

getPreferredWidthForHeight

@Deprecated
public void getPreferredWidthForHeight(int height,
 @Nullable Out<Integer> minimumWidth,
 @Nullable Out<Integer> naturalWidth)

Deprecated.

This object will be removed in GTK 5

Gets the accumulative preferred width for height for all rows which have been requested for the same said height with this context.

After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a GtkCellArea, the returned values are -1.

Parameters:

height - a proposed height for allocation

minimumWidth - location to store the minimum width

naturalWidth - location to store the natural width

pushPreferredHeight

@Deprecated
public void pushPreferredHeight(int minimumHeight,
 int naturalHeight)

Deprecated.

This object will be removed in GTK 5

Causes the minimum and/or natural height to grow if the new proposed sizes exceed the current minimum and natural height.

This is used by GtkCellAreaContext implementations during the request process over a series of GtkTreeModel rows to progressively push the requested height over a series of gtk_cell_area_get_preferred_height() requests.

Parameters:

minimumHeight - the proposed new minimum height for this CellAreaContext

naturalHeight - the proposed new natural height for this CellAreaContext

pushPreferredWidth

@Deprecated
public void pushPreferredWidth(int minimumWidth,
 int naturalWidth)

Deprecated.

This object will be removed in GTK 5

Causes the minimum and/or natural width to grow if the new proposed sizes exceed the current minimum and natural width.

This is used by GtkCellAreaContext implementations during the request process over a series of GtkTreeModel rows to progressively push the requested width over a series of gtk_cell_area_get_preferred_width() requests.

Parameters:

minimumWidth - the proposed new minimum width for this CellAreaContext

naturalWidth - the proposed new natural width for this CellAreaContext

reset

@Deprecated
public void reset()

Deprecated.

This object will be removed in GTK 5

Resets any previously cached request and allocation data.

When underlying GtkTreeModel data changes its important to reset the context if the content size is allowed to shrink. If the content size is only allowed to grow (this is usually an option for views rendering large data stores as a measure of optimization), then only the row that changed or was inserted needs to be (re)requested with gtk_cell_area_get_preferred_width().

When the new overall size of the context requires that the allocated size changes (or whenever this allocation changes at all), the variable row sizes need to be re-requested for every row.

For instance, if the rows are displayed all with the same width from top to bottom then a change in the allocated width necessitates a recalculation of all the displayed row heights using gtk_cell_area_get_preferred_height_for_width().

builder

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

Deprecated.

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

Returns:

the builder object