Struct gdk4::Surface

#[repr(transparent)]
pub struct Surface { /* private fields */ }

A Surface is a rectangular region on the screen.

It’s a low-level object, used to implement high-level objects such as Gtk::Window or Gtk::Dialog in GTK.

The surfaces you see in practice are either Toplevel or 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.

This is an Abstract Base Class, you cannot instantiate it.

Properties

cursor

The mouse pointer for the Surface.

Readable | Writeable

display

The Display connection of the surface.

Readable | Writeable | Construct Only

frame-clock

The FrameClock of the surface.

Readable | Writeable | Construct Only

height

The height of the surface, in pixels.

Readable

mapped

Whether the surface is mapped.

Readable

scale

The scale of the surface.

Readable

scale-factor

The scale factor of the surface.

The scale factor is the next larger integer, compared to scale.

Readable

width

The width of the surface in pixels.

Readable

Signals

enter-monitor

Emitted when @surface starts being present on the monitor.

event

Emitted when GDK receives an input event for @surface.

layout

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

Surface size is reported in ”application pixels”, not ”device pixels” (see gdk_surface_get_scale_factor()).

leave-monitor

Emitted when @surface stops being present on the monitor.

render

Emitted when part of the surface needs to be redrawn.

Implements

SurfaceExt, SurfaceExtManual

Implementations

impl Surface

pub const NONE: Option<&'static Surface> = None

pub fn new_popup(parent: &impl IsA<Surface>, autohide: bool) -> Surface

Create a new popup surface.

The surface will be attached to @parent and can be positioned relative to it using PopupExt::present().

parent

the parent surface to attach the surface to

autohide

whether to hide the surface on outside clicks

Returns

a new Surface

pub fn new_toplevel(display: &impl IsA<Display>) -> Surface

Creates a new toplevel surface.

display

the display to create the surface on

Returns

the new Surface

Trait Implementations

impl Clone for Surface

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Surface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Surface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Surface

type ParamSpec = ParamSpecObject

type SetValue = Surface

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Surface>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Surface

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Surface

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Surface

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Surface

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Surface

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Surface

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Surface

impl IsA<Surface> for DragSurface

impl IsA<Surface> for Popup

impl IsA<Surface> for Toplevel