Class surface - cl-cffi-gtk4 API documentation

Package: gdk

Class gdk:surface

Superclasses

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

Documented Subclasses

gdk:popup

Direct Slots

cursor

The cursor property of type gdk:cursor (Read / Write)
The mouse pointer for a surface.

display

The display property of type gdk:display (Read / Write / Construct only)
The display connection of the surface.

frame-clock

The frame-clock property of type gdk:frame-clock (Read / Write / Construct only)
The frame clock for the surface.

height

The height property of type :int (Read)
The height of the surface.
Allowed values: >= 0
Default value: 0

mapped

The mapped property of type :boolean (Read)
Whether the surface is mapped.
Default value: false

scale

The scale property of type :double (Read)
The scale of the surface.
Default value: 1.0d0

scale-factor

The scale-factor property of type :int (Read)
The scale factor of the surface.
Allowed values: >= 1
Default value: 1

width

The width property of type :int (Read)
The width of the surface.
Allowed values: >= 0
Default value: 0

Details

The gdk:surface object is a rectangular region on the screen. It is a low-level object, used to implement high-level objects such as the gtk:window or the gtk:dialog widgets in GTK.

The surfaces you see in practice are either gdk:toplevel or gdk:popup objects, and those interfaces provide much of the required API to interact with these surfaces. Other, more specialized surface types exist, but you will rarely interact with them directly.

Signal Details

The "enter-monitor" signal

lambda (surface monitor)    :run-first

surface: The gdk:surface object.
monitor: The gdk:monitor object.

Emitted when surface starts being present on the monitor.

The "event" signal

lambda (surface event)    :run-last

surface: The gdk:surface object.
event: The gdk:event instance to an input event.
Returns: True to indicate that the event has been handled.

Emitted when GDK receives an input event for surface.

The "layout" signal

lambda (surface width height)    :run-first

surface: The gdk:surface object.
width: The integer for the current width.
height: The integer for the current height.

Emitted when the size of surface is changed, or when relayout should be performed. The surface size is reported in "application pixels", not "device pixels". See the gdk:surface-scale-factor function.

The "leave-monitor" signal

lambda (surface monitor)    :run-first

surface: The gdk:surface object.
monitor: The gdk:monitor object.

Emitted when surface stops being present on the monitor.

The "render" signal

lambda (surface region)    :run-last

surface: The gdk:surface object.
region: The cairo:region-t instance that needs to be redrawn.
Returns: True to indicate that the signal has been handled.

Emitted when part of the surface needs to be redrawn.