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)
WindowInfo &	operator= (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.
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).
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).
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).
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).
auto	clip_area () const -> mir::optional_value< mir::geometry::Rectangle >
	Mir will not render anything outside this rectangle.
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/.
void	application_id (std::string const &application_id)

Static Public Member Functions
static bool	needs_titlebar (MirWindowType type)

Member Typedef Documentation

AspectRatio

using miral::WindowInfo::AspectRatio = WindowSpecification::AspectRatio

Constructor & Destructor Documentation

WindowInfo() [1/3]

miral::WindowInfo::WindowInfo

(

)

WindowInfo() [2/3]

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

~WindowInfo()

miral::WindowInfo::~WindowInfo

(

)

WindowInfo() [3/3]

miral::WindowInfo::WindowInfo ( WindowInfo const & that )

explicit

Member Function Documentation

add_child()

void miral::WindowInfo::add_child

(

Window const &

child

)

application_id() [1/2]

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

application_id() [2/2]

void miral::WindowInfo::application_id

(

std::string const &

application_id

)

attached_edges() [1/2]

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

attached_edges() [2/2]

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

can_be_active()

bool miral::WindowInfo::can_be_active

(

)

const

can_morph_to()

bool miral::WindowInfo::can_morph_to

(

MirWindowType

new_type

)

const

children()

auto miral::WindowInfo::children

(

)

const->std::vector< Window >const &

clip_area() [1/2]

auto miral::WindowInfo::clip_area

(

)

const->mir::optional_value< mir::geometry::Rectangle >

Mir will not render anything outside this rectangle.

clip_area() [2/2]

void miral::WindowInfo::clip_area

(

mir::optional_value< mir::geometry::Rectangle > const &

area

)

confine_pointer() [1/2]

auto miral::WindowInfo::confine_pointer

(

)

const->MirPointerConfinementState

confine_pointer() [2/2]

void miral::WindowInfo::confine_pointer

(

MirPointerConfinementState

confinement

)

constrain_resize()

void miral::WindowInfo::constrain_resize	(	mir::geometry::Point &	requested_pos,
		mir::geometry::Size &	requested_size ) const

depth_layer() [1/2]

auto miral::WindowInfo::depth_layer

(

)

const->MirDepthLayer

depth_layer() [2/2]

void miral::WindowInfo::depth_layer

(

MirDepthLayer

depth_layer

)

exclusive_rect() [1/2]

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

exclusive_rect() [2/2]

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

has_output_id()

bool miral::WindowInfo::has_output_id

(

)

const

height_inc() [1/2]

auto miral::WindowInfo::height_inc

(

)

const->mir::geometry::DeltaY

height_inc() [2/2]

void miral::WindowInfo::height_inc

(

mir::geometry::DeltaY

height_inc

)

is_visible()

bool miral::WindowInfo::is_visible

(

)

const

max_aspect() [1/2]

auto miral::WindowInfo::max_aspect

(

)

const->AspectRatio

max_aspect() [2/2]

void miral::WindowInfo::max_aspect

(

AspectRatio

max_aspect

)

max_height() [1/2]

auto miral::WindowInfo::max_height

(

)

const->mir::geometry::Height

max_height() [2/2]

void miral::WindowInfo::max_height

(

mir::geometry::Height

max_height

)

max_width() [1/2]

auto miral::WindowInfo::max_width

(

)

const->mir::geometry::Width

max_width() [2/2]

void miral::WindowInfo::max_width

(

mir::geometry::Width

max_width

)

min_aspect() [1/2]

auto miral::WindowInfo::min_aspect

(

)

const->AspectRatio

min_aspect() [2/2]

void miral::WindowInfo::min_aspect

(

AspectRatio

min_aspect

)

min_height() [1/2]

auto miral::WindowInfo::min_height

(

)

const->mir::geometry::Height

min_height() [2/2]

void miral::WindowInfo::min_height

(

mir::geometry::Height

min_height

)

min_width() [1/2]

auto miral::WindowInfo::min_width

(

)

const->mir::geometry::Width

min_width() [2/2]

void miral::WindowInfo::min_width

(

mir::geometry::Width

min_width

)

must_have_parent()

bool miral::WindowInfo::must_have_parent

(

)

const

must_not_have_parent()

bool miral::WindowInfo::must_not_have_parent

(

)

const

name() [1/2]

auto miral::WindowInfo::name

(

)

const->std::string

name() [2/2]

void miral::WindowInfo::name

(

std::string const &

name

)

needs_titlebar()

bool miral::WindowInfo::needs_titlebar ( MirWindowType type )

static

operator=()

WindowInfo & miral::WindowInfo::operator=

(

WindowInfo const &

that

)

output_id() [1/2]

auto miral::WindowInfo::output_id

(

)

const->int

output_id() [2/2]

void miral::WindowInfo::output_id

(

mir::optional_value< int >

output_id

)

parent() [1/2]

auto miral::WindowInfo::parent

(

)

const->Window

parent() [2/2]

void miral::WindowInfo::parent

(

Window const &

parent

)

preferred_orientation() [1/2]

auto miral::WindowInfo::preferred_orientation

(

)

const->MirOrientationMode

preferred_orientation() [2/2]

void miral::WindowInfo::preferred_orientation

(

MirOrientationMode

preferred_orientation

)

remove_child()

void miral::WindowInfo::remove_child

(

Window const &

child

)

restore_rect() [1/2]

auto miral::WindowInfo::restore_rect

(

)

const->mir::geometry::Rectangle

restore_rect() [2/2]

void miral::WindowInfo::restore_rect

(

mir::geometry::Rectangle const &

restore_rect

)

shell_chrome() [1/2]

auto miral::WindowInfo::shell_chrome

(

)

const->MirShellChrome

shell_chrome() [2/2]

void miral::WindowInfo::shell_chrome

(

MirShellChrome

chrome

)

state() [1/2]

auto miral::WindowInfo::state

(

)

const->MirWindowState

state() [2/2]

void miral::WindowInfo::state

(

MirWindowState

state

)

swap()

void miral::WindowInfo::swap ( WindowInfo & rhs )

inline

type() [1/2]

auto miral::WindowInfo::type

(

)

const->MirWindowType

type() [2/2]

void miral::WindowInfo::type

(

MirWindowType

type

)

userdata() [1/2]

auto miral::WindowInfo::userdata

(

)

const->std::shared_ptr< void >

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

userdata() [2/2]

void miral::WindowInfo::userdata

(

std::shared_ptr< void >

userdata

)

width_inc() [1/2]

auto miral::WindowInfo::width_inc

(

)

const->mir::geometry::DeltaX

width_inc() [2/2]

void miral::WindowInfo::width_inc

(

mir::geometry::DeltaX

width_inc

)

window()

auto miral::WindowInfo::window

(

)

const->Window &

---

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

• include/miral/miral/window_info.h