Interface toplevel - cl-cffi-gtk4 API documentation

Package: gdk

Interface gdk:toplevel

Superclasses

gdk:surface, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

capabilities

The capabilities property of type gdk:toplevel-capabilities (Read)
The capabilities that are available for this toplevel.
Default value: 0

decorated

The decorated property of type :boolean (Read / Write)
Whether the toplevel is decorated.
Default value: false

deletable

The deletable property of type :boolean (Read / Write)
Whether the toplevel is deletable.
Default value: false

fullscreen-mode

The fullscreen-mode property of type gdk:fullscreen-mode (Read / Write)
The fullscreen mode of the toplevel.
Default value: :on-current-monitor

gravity

The gravity property of type gdk:gravity (Read / Write)
The gravity to use when resizing a surface programmatically. Gravity describes which point of the surface we want to keep fixed (meaning that the surface will grow in the opposite direction). For example, a gravity of :north-east means that we want to fix top right corner of the surface. This property is just a hint that may affect the result when negotiating toplevel sizes with the windowing system. It does not affect interactive resizes started with the gdk:toplevel-begin-resize function. Since 4.20
Default value: :north-east

icon-list

The icon-list property of type :pointer (Read / Write)
The list of icon textures.

The modal property of type :boolean (Read / Write)
Whether the toplevel is modal.
Default value: false

shortcuts-inhibited

The shortcuts-inhibited property of type :boolean (Read / Write)
Whether keyboard shortcuts are inhibited.
Default value: false

startup-id

The startup-id property of type :string (Read / Write)
The startup ID of the surface.
Default value: nil

state

The state property of type gdk:toplevel-state (Read)
The state of the toplevel.
Default value: :none

title

The title property of type :string (Read / Write)
The title of the surface.
Default value: nil

transient-for

The transient-for property of type gdk:surface (Read / Write)
The transient parent of the surface.

Details

The gdk:toplevel object is a freestanding toplevel surface. The gdk:toplevel interface provides useful APIs for interacting with the windowing system, such as controlling maximization and size of the surface, setting icons and transient parents for dialogs.

Signal Details

The "compute-size" signal

lambda (toplevel size)    :run-last

toplevel: The gdk:toplevel object.
size: The gdk:toplevel-size instance.

Compute the desired size of the toplevel, given the information passed via the gdk:toplevel-size instance. It will normally be emitted during or after the gdk:toplevel-present function, depending on the configuration received by the windowing system. It may also be emitted at any other point in time, in response to the windowing system spontaneously changing the configuration. It is the responsibility of the toplevel user to handle this signal. Failing to do so will result in an arbitrary size being used as a result.