Mir
Public Types | Public Member Functions | Static Public Member Functions | List of all members
miral::WindowInfo Struct Reference

#include <window_info.h>

Public Types

using AspectRatio = WindowSpecification::AspectRatio
 

Public Member Functions

 WindowInfo ()
 
 WindowInfo (Window const &window, WindowSpecification const &params)
 
 ~WindowInfo ()
 
 WindowInfo (WindowInfo const &that)
 
WindowInfooperator= (WindowInfo const &that)
 
bool can_be_active () const
 
bool can_morph_to (MirWindowType new_type) const
 
bool must_have_parent () const
 
bool must_not_have_parent () const
 
bool is_visible () const
 
void constrain_resize (mir::geometry::Point &requested_pos, mir::geometry::Size &requested_size) const
 
auto window () const -> Window &
 
auto name () const -> std::string
 
void name (std::string const &name)
 
auto type () const -> MirWindowType
 
void type (MirWindowType type)
 
auto state () const -> MirWindowState
 
void state (MirWindowState state)
 
auto restore_rect () const -> mir::geometry::Rectangle
 
void restore_rect (mir::geometry::Rectangle const &restore_rect)
 
auto parent () const -> Window
 
void parent (Window const &parent)
 
auto children () const -> std::vector< Window > const &
 
void add_child (Window const &child)
 
void remove_child (Window const &child)
 
auto min_width () const -> mir::geometry::Width
 
void min_width (mir::geometry::Width min_width)
 
auto min_height () const -> mir::geometry::Height
 
void min_height (mir::geometry::Height min_height)
 
auto max_width () const -> mir::geometry::Width
 
void max_width (mir::geometry::Width max_width)
 
auto max_height () const -> mir::geometry::Height
 
void max_height (mir::geometry::Height max_height)
 
auto width_inc () const -> mir::geometry::DeltaX
 
void width_inc (mir::geometry::DeltaX width_inc)
 
auto height_inc () const -> mir::geometry::DeltaY
 
void height_inc (mir::geometry::DeltaY height_inc)
 
auto min_aspect () const -> AspectRatio
 
void min_aspect (AspectRatio min_aspect)
 
auto max_aspect () const -> AspectRatio
 
void max_aspect (AspectRatio max_aspect)
 
bool has_output_id () const
 
auto output_id () const -> int
 
void output_id (mir::optional_value< int > output_id)
 
auto preferred_orientation () const -> MirOrientationMode
 
void preferred_orientation (MirOrientationMode preferred_orientation)
 
auto confine_pointer () const -> MirPointerConfinementState
 
void confine_pointer (MirPointerConfinementState confinement)
 
auto shell_chrome () const -> MirShellChrome
 
void shell_chrome (MirShellChrome chrome)
 
auto userdata () const -> std::shared_ptr< void >
 This can be used by client code to store window manager specific information. More...
 
void userdata (std::shared_ptr< void > userdata)
 
void swap (WindowInfo &rhs)
 
auto depth_layer () const -> MirDepthLayer
 
void depth_layer (MirDepthLayer depth_layer)
 
auto attached_edges () const -> MirPlacementGravity
 Get the edges of the output that the window is attached to (only meaningful for windows in state mir_window_state_attached) More...
 
void attached_edges (MirPlacementGravity edges)
 Set the edges of the output that the window should be attached to (only meaningful for windows in state mir_window_state_attached) More...
 
auto exclusive_rect () const -> mir::optional_value< mir::geometry::Rectangle >
 Mir will try to avoid occluding the area covered by this rectangle (relative to the window) (only meaningful when the window is attached to an edge) More...
 
void exclusive_rect (mir::optional_value< mir::geometry::Rectangle > const &rect)
 Set the area to keep exclusive to this window (only meaningful when the window is attached to an edge) More...
 
auto clip_area () const -> mir::optional_value< mir::geometry::Rectangle >
 Mir will not render anything outside this rectangle. More...
 
void clip_area (mir::optional_value< mir::geometry::Rectangle > const &area)
 
auto application_id () const -> std::string
 The D-bus service name and basename of the app's .desktop file See http://standards.freedesktop.org/desktop-entry-spec/. More...
 
void application_id (std::string const &application_id)
 

Static Public Member Functions

static bool needs_titlebar (MirWindowType type)
 

Member Typedef Documentation

Constructor & Destructor Documentation

miral::WindowInfo::WindowInfo ( )
miral::WindowInfo::WindowInfo ( Window const &  window,
WindowSpecification const &  params 
)
miral::WindowInfo::~WindowInfo ( )
miral::WindowInfo::WindowInfo ( WindowInfo const &  that)
explicit

Member Function Documentation

void miral::WindowInfo::add_child ( Window const &  child)
auto miral::WindowInfo::application_id ( ) const -> std::string

The D-bus service name and basename of the app's .desktop file See http://standards.freedesktop.org/desktop-entry-spec/.

Remarks
Since MirAL 2.8
void miral::WindowInfo::application_id ( std::string const &  application_id)
auto miral::WindowInfo::attached_edges ( ) const -> MirPlacementGravity

Get the edges of the output that the window is attached to (only meaningful for windows in state mir_window_state_attached)

void miral::WindowInfo::attached_edges ( MirPlacementGravity  edges)

Set the edges of the output that the window should be attached to (only meaningful for windows in state mir_window_state_attached)

bool miral::WindowInfo::can_be_active ( ) const
bool miral::WindowInfo::can_morph_to ( MirWindowType  new_type) const
auto miral::WindowInfo::children ( ) const -> std::vector< Window > const &
auto miral::WindowInfo::clip_area ( ) const -> mir::optional_value< mir::geometry::Rectangle >

Mir will not render anything outside this rectangle.

void miral::WindowInfo::clip_area ( mir::optional_value< mir::geometry::Rectangle > const &  area)
auto miral::WindowInfo::confine_pointer ( ) const -> MirPointerConfinementState
void miral::WindowInfo::confine_pointer ( MirPointerConfinementState  confinement)
void miral::WindowInfo::constrain_resize ( mir::geometry::Point requested_pos,
mir::geometry::Size requested_size 
) const
auto miral::WindowInfo::depth_layer ( ) const -> MirDepthLayer
void miral::WindowInfo::depth_layer ( MirDepthLayer  depth_layer)
auto miral::WindowInfo::exclusive_rect ( ) const -> mir::optional_value< mir::geometry::Rectangle >

Mir will try to avoid occluding the area covered by this rectangle (relative to the window) (only meaningful when the window is attached to an edge)

void miral::WindowInfo::exclusive_rect ( mir::optional_value< mir::geometry::Rectangle > const &  rect)

Set the area to keep exclusive to this window (only meaningful when the window is attached to an edge)

bool miral::WindowInfo::has_output_id ( ) const
auto miral::WindowInfo::height_inc ( ) const -> mir::geometry::DeltaY
void miral::WindowInfo::height_inc ( mir::geometry::DeltaY  height_inc)
bool miral::WindowInfo::is_visible ( ) const
auto miral::WindowInfo::max_aspect ( ) const -> AspectRatio
void miral::WindowInfo::max_aspect ( AspectRatio  max_aspect)
auto miral::WindowInfo::max_height ( ) const -> mir::geometry::Height
void miral::WindowInfo::max_height ( mir::geometry::Height  max_height)
auto miral::WindowInfo::max_width ( ) const -> mir::geometry::Width
void miral::WindowInfo::max_width ( mir::geometry::Width  max_width)
auto miral::WindowInfo::min_aspect ( ) const -> AspectRatio
void miral::WindowInfo::min_aspect ( AspectRatio  min_aspect)
auto miral::WindowInfo::min_height ( ) const -> mir::geometry::Height
void miral::WindowInfo::min_height ( mir::geometry::Height  min_height)
auto miral::WindowInfo::min_width ( ) const -> mir::geometry::Width
void miral::WindowInfo::min_width ( mir::geometry::Width  min_width)
bool miral::WindowInfo::must_have_parent ( ) const
bool miral::WindowInfo::must_not_have_parent ( ) const
auto miral::WindowInfo::name ( ) const -> std::string
void miral::WindowInfo::name ( std::string const &  name)
static bool miral::WindowInfo::needs_titlebar ( MirWindowType  type)
static
WindowInfo& miral::WindowInfo::operator= ( WindowInfo const &  that)
auto miral::WindowInfo::output_id ( ) const -> int
void miral::WindowInfo::output_id ( mir::optional_value< int >  output_id)
auto miral::WindowInfo::parent ( ) const -> Window
void miral::WindowInfo::parent ( Window const &  parent)
auto miral::WindowInfo::preferred_orientation ( ) const -> MirOrientationMode
void miral::WindowInfo::preferred_orientation ( MirOrientationMode  preferred_orientation)
void miral::WindowInfo::remove_child ( Window const &  child)
auto miral::WindowInfo::restore_rect ( ) const -> mir::geometry::Rectangle
void miral::WindowInfo::restore_rect ( mir::geometry::Rectangle const &  restore_rect)
auto miral::WindowInfo::shell_chrome ( ) const -> MirShellChrome
void miral::WindowInfo::shell_chrome ( MirShellChrome  chrome)
auto miral::WindowInfo::state ( ) const -> MirWindowState
void miral::WindowInfo::state ( MirWindowState  state)
void miral::WindowInfo::swap ( WindowInfo rhs)
inline
auto miral::WindowInfo::type ( ) const -> MirWindowType
void miral::WindowInfo::type ( MirWindowType  type)
auto miral::WindowInfo::userdata ( ) const -> std::shared_ptr< void >

This can be used by client code to store window manager specific information.

void miral::WindowInfo::userdata ( std::shared_ptr< void >  userdata)
auto miral::WindowInfo::width_inc ( ) const -> mir::geometry::DeltaX
void miral::WindowInfo::width_inc ( mir::geometry::DeltaX  width_inc)
auto miral::WindowInfo::window ( ) const -> Window &

The documentation for this struct was generated from the following file:

Copyright © 2012-2022 Canonical Ltd.
Generated on Tue Feb 1 20:51:23 UTC 2022
This documentation is licensed under the GPL version 2 or 3.