gdk4/org.gtkkn.bindings.gdk/Surface

Surface

open class Surface(pointer: <Error class: unknown class><<Error class: unknown class>>)

A GdkSurface is a rectangular region on the screen.

It’s a low-level object, used to implement high-level objects such as ../gtk4/class.Window.html.

The surfaces you see in practice are either iface@Gdk.Toplevel or iface@Gdk.Popup, 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.

Skipped during bindings generation

method create_similar_surface: Return type cairo.Surface is unsupported
parameter x: x: Out parameter is not supported
parameter region: cairo.Region
parameter region: cairo.Region
method translate_coordinates: In/Out parameter is not supported
signal render: Signal render is ignored

Constructors

Surface

constructor(parent: Surface, autohide: Boolean)

Create a new popup surface.

constructor(display: Display)

Creates a new toplevel surface.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

cursor

open var cursor: Cursor?

The mouse pointer for the GdkSurface.

display

open val display: Display

The GdkDisplay connection of the surface.

frameClock

open val frameClock: FrameClock

The GdkFrameClock of the surface.

gdkSurfacePointer

val gdkSurfacePointer: <Error class: unknown class><<Error class: unknown class>>

height

open val height: <Error class: unknown class>

The height of the surface, in pixels.

mapped

open val mapped: Boolean

Whether the surface is mapped.

scale

open val scale: <Error class: unknown class>

The scale of the surface.

scaleFactor

open val scaleFactor: <Error class: unknown class>

The scale factor of the surface.

width

open val width: <Error class: unknown class>

The width of the surface in pixels.

Functions

beep

open fun beep()

Emits a short beep associated to @surface.

connectEnterMonitor

fun connectEnterMonitor(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (monitor: Monitor) -> Unit): <Error class: unknown class>

Emitted when @surface starts being present on the monitor.

connectEvent

fun connectEvent(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (event: Event) -> Boolean): <Error class: unknown class>

Emitted when GDK receives an input event for @surface.

connectLayout

fun connectLayout(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted when the size of @surface is changed, or when relayout should be performed.

connectLeaveMonitor

fun connectLeaveMonitor(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (monitor: Monitor) -> Unit): <Error class: unknown class>

Emitted when @surface stops being present on the monitor.

createCairoContext

open fun createCairoContext(): CairoContext

Creates a new GdkCairoContext for rendering on @surface.

createGlContext