Gjsify LogoGjsify Logo

The GdkToplevelLayout struct contains information that is necessary to present a sovereign window on screen.

The GdkToplevelLayout struct is necessary for using [methodGdk.Toplevel.present].

Toplevel surfaces are sovereign windows that can be presented to the user in various states (maximized, on all workspaces, etc).

record

Hierarchy

  • ToplevelLayout

Index

Constructors

  • Create a toplevel layout description.

    Used together with gdk_toplevel_present() to describe how a toplevel surface should be placed and behave on-screen.

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

    Returns ToplevelLayout

Properties

name: string

Methods

  • Check whether layout and other has identical layout properties.

    Parameters

    Returns boolean

  • getFullscreen(): [boolean, boolean]
  • If the layout specifies whether to the toplevel should go fullscreen, the value pointed to by fullscreen is set to %TRUE if it should go fullscreen, or %FALSE, if it should go unfullscreen.

    Returns [boolean, boolean]

  • getMaximized(): [boolean, boolean]
  • If the layout specifies whether to the toplevel should go maximized, the value pointed to by maximized is set to %TRUE if it should go fullscreen, or %FALSE, if it should go unmaximized.

    Returns [boolean, boolean]

  • getResizable(): boolean
  • Returns whether the layout should allow the user to resize the surface.

    Returns boolean

  • setFullscreen(fullscreen: boolean, monitor: Gdk.Monitor): void
  • Sets whether the layout should cause the surface to be fullscreen when presented.

    Parameters

    • fullscreen: boolean

      %TRUE to fullscreen the surface

    • monitor: Gdk.Monitor

      the monitor to fullscreen on

    Returns void

  • setMaximized(maximized: boolean): void
  • Sets whether the layout should cause the surface to be maximized when presented.

    Parameters

    • maximized: boolean

      %TRUE to maximize

    Returns void

  • setResizable(resizable: boolean): void
  • Sets whether the layout should allow the user to resize the surface after it has been presented.

    Parameters

    • resizable: boolean

      %TRUE to allow resizing

    Returns void

  • unref(): void
  • Create a toplevel layout description.

    Used together with gdk_toplevel_present() to describe how a toplevel surface should be placed and behave on-screen.

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

    Returns ToplevelLayout

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method