Mir
Loading...
Searching...
No Matches
window_info.h
Go to the documentation of this file.
1/*
2 * Copyright © 2016-2020 Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 or 3 as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#ifndef MIRAL_WINDOW_INFO_H
18#define MIRAL_WINDOW_INFO_H
19
20#include "miral/window.h"
22
24#include <mir/optional_value.h>
25
26#include <algorithm>
27
28namespace miral
29{
31{
33
37 explicit WindowInfo(WindowInfo const& that);
39
40 bool can_be_active() const;
41
42 bool can_morph_to(MirWindowType new_type) const;
43
44 bool must_have_parent() const;
45
47
48 bool is_visible() const;
49
51
52 void constrain_resize(mir::geometry::Point& requested_pos, mir::geometry::Size& requested_size) const;
53
54 auto window() const -> Window&;
55
56 auto name() const -> std::string;
57
58 auto type() const -> MirWindowType;
59
60 auto state() const -> MirWindowState;
61
62 auto restore_rect() const -> mir::geometry::Rectangle;
63
64 auto parent() const -> Window;
65
66 auto children() const -> std::vector <Window> const&;
67
72 auto min_width() const -> mir::geometry::Width;
73 auto min_height() const -> mir::geometry::Height;
74 auto max_width() const -> mir::geometry::Width;
75 auto max_height() const -> mir::geometry::Height;
77
82 auto width_inc() const -> mir::geometry::DeltaX;
83 auto height_inc() const -> mir::geometry::DeltaY;
85
90 auto min_aspect() const -> AspectRatio;
91 auto max_aspect() const -> AspectRatio;
93
94 bool has_output_id() const;
95 auto output_id() const -> int;
96
98
100
102
104 auto userdata() const -> std::shared_ptr<void>;
105 void userdata(std::shared_ptr<void> userdata);
106
107 void swap(WindowInfo& rhs) { std::swap(self, rhs.self); }
108
109 auto depth_layer() const -> MirDepthLayer;
110
114
117 auto exclusive_rect() const -> mir::optional_value<mir::geometry::Rectangle>;
118
120 auto clip_area() const -> mir::optional_value<mir::geometry::Rectangle>;
121 void clip_area(mir::optional_value<mir::geometry::Rectangle> const& area);
122
127 auto application_id() const -> std::string;
129
132 auto focus_mode() const -> MirFocusMode;
133
134private:
135 friend class BasicWindowManager;
136 void name(std::string const& name);
137 void type(MirWindowType type);
139 void restore_rect(mir::geometry::Rectangle const& restore_rect);
140 void parent(Window const& parent);
141 void add_child(Window const& child);
142 void remove_child(Window const& child);
143 void min_width(mir::geometry::Width min_width);
144 void min_height(mir::geometry::Height min_height);
145 void max_width(mir::geometry::Width max_width);
146 void max_height(mir::geometry::Height max_height);
147 void width_inc(mir::geometry::DeltaX width_inc);
148 void height_inc(mir::geometry::DeltaY height_inc);
151 void output_id(mir::optional_value<int> output_id);
154 void shell_chrome(MirShellChrome chrome);
157 void exclusive_rect(mir::optional_value<mir::geometry::Rectangle> const& rect);
158 void application_id(std::string const& application_id);
160
161 struct Self;
162 std::unique_ptr<Self> self;
163};
164}
165
166namespace std
167{
168template<> inline void swap(miral::WindowInfo& lhs, miral::WindowInfo& rhs) { lhs.swap(rhs); }
169}
170
171#endif //MIRAL_WINDOW_INFO_H
Definition: dimensions.h:34
Handle class to manage a Mir surface. It may be null (e.g. default initialized)
Definition: window.h:36
Definition: window_specification.h:42
MirFocusMode
Focus mode controls how a surface gains and loses focus.
Definition: common.h:423
MirPointerConfinementState
Pointer Confinement.
Definition: common.h:385
MirWindowType
Definition: common.h:56
MirShellChrome
Shell chrome.
Definition: common.h:376
MirWindowState
Definition: common.h:71
MirPlacementGravity
Reference point for aligning a surface relative to a rectangle.
Definition: common.h:236
MirDepthLayer
Depth layer controls Z ordering of surfaces.
Definition: common.h:410
MirOrientationMode
Definition: common.h:209
Definition: splash_session.h:22
Mir Abstraction Layer.
Definition: floating_window_manager.h:29
STL namespace.
void swap(miral::WindowInfo &lhs, miral::WindowInfo &rhs)
Definition: window_info.h:168
Definition: point.h:30
Definition: rectangle.h:31
Definition: size.h:30
Definition: window_info.h:31
auto min_height() const -> mir::geometry::Height
auto name() const -> std::string
bool can_be_active() const
auto type() const -> MirWindowType
static bool needs_titlebar(MirWindowType type)
auto depth_layer() const -> MirDepthLayer
void swap(WindowInfo &rhs)
Definition: window_info.h:107
auto height_inc() const -> mir::geometry::DeltaY
auto shell_chrome() const -> MirShellChrome
bool can_morph_to(MirWindowType new_type) const
auto userdata() const -> std::shared_ptr< void >
This can be used by client code to store window manager specific information.
bool must_not_have_parent() const
auto confine_pointer() const -> MirPointerConfinementState
bool has_output_id() const
auto output_id() const -> int
auto state() const -> MirWindowState
auto parent() const -> Window
auto max_width() const -> mir::geometry::Width
auto restore_rect() const -> mir::geometry::Rectangle
auto width_inc() const -> mir::geometry::DeltaX
These control the size increments of the window. This is used in cases like a terminal that can only ...
auto clip_area() const -> mir::optional_value< mir::geometry::Rectangle >
Mir will not render anything outside this rectangle.
auto min_width() const -> mir::geometry::Width
These constrain the sizes a window may be resized to (both interactively and pragmatically)....
auto window() const -> Window &
void constrain_resize(mir::geometry::Point &requested_pos, mir::geometry::Size &requested_size) const
WindowInfo(WindowInfo const &that)
auto children() const -> std::vector< Window > const &
friend class BasicWindowManager
Definition: window_info.h:135
WindowInfo & operator=(WindowInfo const &that)
auto min_aspect() const -> AspectRatio
These constrain the possible aspect ratio of the window. Current Wayland protocols to not support thi...
auto focus_mode() const -> MirFocusMode
How the window should gain and lose focus.
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 mea...
auto max_aspect() const -> AspectRatio
bool is_visible() const
WindowInfo(Window const &window, WindowSpecification const &params)
bool must_have_parent() const
auto max_height() const -> mir::geometry::Height
auto attached_edges() const -> MirPlacementGravity
Get the edges of the output that the window is attached to (only meaningful for windows in state mir_...
auto application_id() const -> std::string
The D-bus service name and basename of the app's .desktop file See http://standards....
auto preferred_orientation() const -> MirOrientationMode
Definition: window_specification.h:50

Copyright © 2012-2022 Canonical Ltd.
Generated on Tue Nov 8 21:37:30 UTC 2022
This documentation is licensed under the GPL version 2 or 3.