Package org.gnome.gdk

Class ToplevelSize

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gdk.ToplevelSize

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class ToplevelSize
extends ProxyInstance

The GdkToplevelSize struct contains information that is useful to compute the size of a toplevel.

Constructor Summary

Constructors

Constructor	Description
ToplevelSize(MemorySegment address)	Create a ToplevelSize proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	getBounds(Out<Integer> boundsWidth, Out<Integer> boundsHeight)	Retrieves the bounds the toplevel is placed within.
static Type	getType()	Get the GType of the ToplevelSize class
void	setMinSize(int minWidth, int minHeight)	Sets the minimum size of the toplevel.
void	setShadowWidth(int left, int right, int top, int bottom)	Sets the shadows size of the toplevel.
void	setSize(int width, int height)	Sets the size the toplevel prefers to be resized to.

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

ToplevelSize

public ToplevelSize(MemorySegment address)

Create a ToplevelSize proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the ToplevelSize class

Returns:

the GType

getBounds

public void getBounds(Out<Integer> boundsWidth,
 Out<Integer> boundsHeight)

Retrieves the bounds the toplevel is placed within.

The bounds represent the largest size a toplevel may have while still being able to fit within some type of boundary. Depending on the backend, this may be equivalent to the dimensions of the work area or the monitor on which the window is being presented on, or something else that limits the way a toplevel can be presented.

Parameters:

boundsWidth - return location for width

boundsHeight - return location for height

setMinSize

public void setMinSize(int minWidth,
 int minHeight)

Sets the minimum size of the toplevel.

The minimum size corresponds to the limitations the toplevel can be shrunk to, without resulting in incorrect painting. A user of a GdkToplevel should calculate these given both the existing size, and the bounds retrieved from the GdkToplevelSize object.

The minimum size should be within the bounds (see getBounds(io.github.jwharm.javagi.base.Out<java.lang.Integer>, io.github.jwharm.javagi.base.Out<java.lang.Integer>)).

Parameters:

minWidth - the minimum width

minHeight - the minimum height

setShadowWidth

public void setShadowWidth(int left,
 int right,
 int top,
 int bottom)

Sets the shadows size of the toplevel.

The shadow width corresponds to the part of the computed surface size that would consist of the shadow margin surrounding the window, would there be any.

Shadow width should only be set if org.gnome.gtk.Display#supportsShadowWidth is true.

Parameters:

left - width of the left part of the shadow

right - width of the right part of the shadow

top - height of the top part of the shadow

bottom - height of the bottom part of the shadow

setSize

public void setSize(int width,
 int height)

Sets the size the toplevel prefers to be resized to.

The size should be within the bounds (see getBounds(io.github.jwharm.javagi.base.Out<java.lang.Integer>, io.github.jwharm.javagi.base.Out<java.lang.Integer>)). The set size should be considered as a hint, and should not be assumed to be respected by the windowing system, or backend.

Parameters:

width - the width

height - the height