Struct Toplevel

pub struct Toplevel { /* private fields */ }

A Toplevel is a freestanding toplevel surface.

The 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.

Properties

decorated

Whether the window manager should add decorations.

Readable | Writeable

deletable

Whether the window manager should allow to close the surface.

Readable | Writeable

fullscreen-mode

The fullscreen mode of the surface.

Readable | Writeable

icon-list

A list of textures to use as icon.

Readable | Writeable

modal

Whether the surface is modal.

Readable | Writeable

shortcuts-inhibited

Whether the surface should inhibit keyboard shortcuts.

Readable

startup-id

The startup ID of the surface.

See AppLaunchContext for more information about startup feedback.

Readable | Writeable

state

The state of the toplevel.

Readable

title

The title of the surface.

Readable | Writeable

transient-for

The transient parent of the surface.

Readable | Writeable

Surface

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

compute-size

Emitted when the size for the surface needs to be computed, when it is present.

This signal will normally be emitted during or after a call to ToplevelExt::present(), 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 of the toplevel surface.

It is the responsibility of the toplevel user to handle this signal and compute the desired size of the toplevel, given the information passed via the ToplevelSize object. Failing to do so will result in an arbitrary size being used as a result.

Surface

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

ToplevelExt, SurfaceExt, ToplevelExtManual, SurfaceExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl Toplevel

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

Trait Implementations

impl Clone for Toplevel

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Toplevel

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

Formats the value using the given formatter.

impl HasParamSpec for Toplevel

type ParamSpec = ParamSpecObject

type SetValue = Toplevel

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Toplevel

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

where H: Hasher,

Hashes the memory address of this object.

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 Toplevel

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Toplevel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Toplevel

impl IsA<Surface> for Toplevel