Mir
window_info.h
Go to the documentation of this file.
1/*
2 * Copyright © 2016 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 * Authored by: Alan Griffiths <alan@octopull.co.uk>
17 */
18
19#ifndef MIRAL_WINDOW_INFO_H
20#define MIRAL_WINDOW_INFO_H
21
22#include "miral/window.h"
24
26#include <mir/optional_value.h>
27
28#include <algorithm>
29
30namespace miral
31{
33{
35
39 explicit WindowInfo(WindowInfo const& that);
41
42 bool can_be_active() const;
43
44 bool can_morph_to(MirWindowType new_type) const;
45
46 bool must_have_parent() const;
47
49
50 bool is_visible() const;
51
53
54 void constrain_resize(mir::geometry::Point& requested_pos, mir::geometry::Size& requested_size) const;
55
56 auto window() const -> Window&;
57
58 auto name() const -> std::string;
59 void name(std::string const& name);
60
61 auto type() const -> MirWindowType;
63
64 auto state() const -> MirWindowState;
66
67 auto restore_rect() const -> mir::geometry::Rectangle;
68 void restore_rect(mir::geometry::Rectangle const& restore_rect);
69
70 auto parent() const -> Window;
71 void parent(Window const& parent);
72
73 auto children() const -> std::vector <Window> const&;
74 void add_child(Window const& child);
75 void remove_child(Window const& child);
76
77 auto min_width() const -> mir::geometry::Width;
78 void min_width(mir::geometry::Width min_width);
79
80 auto min_height() const -> mir::geometry::Height;
81 void min_height(mir::geometry::Height min_height);
82
83 auto max_width() const -> mir::geometry::Width;
84 void max_width(mir::geometry::Width max_width);
85
86 auto max_height() const -> mir::geometry::Height;
87 void max_height(mir::geometry::Height max_height);
88
89 auto width_inc() const -> mir::geometry::DeltaX;
90 void width_inc(mir::geometry::DeltaX width_inc);
91
92 auto height_inc() const -> mir::geometry::DeltaY;
93 void height_inc(mir::geometry::DeltaY height_inc);
94
95 auto min_aspect() const -> AspectRatio;
97
98 auto max_aspect() const -> AspectRatio;
100
101 bool has_output_id() const;
102 auto output_id() const -> int;
103 void output_id(mir::optional_value<int> output_id);
104
107
110
113
115 auto userdata() const -> std::shared_ptr<void>;
116 void userdata(std::shared_ptr<void> userdata);
117
118 void swap(WindowInfo& rhs) { std::swap(self, rhs.self); }
119
120 auto depth_layer() const -> MirDepthLayer;
122
129
132 auto exclusive_rect() const -> mir::optional_value<mir::geometry::Rectangle>;
135 void exclusive_rect(mir::optional_value<mir::geometry::Rectangle> const& rect);
136
138 auto clip_area() const -> mir::optional_value<mir::geometry::Rectangle>;
139 void clip_area(mir::optional_value<mir::geometry::Rectangle> const& area);
140
145 auto application_id() const -> std::string;
146 void application_id(std::string const& application_id);
148
149private:
150 struct Self;
151 std::unique_ptr<Self> self;
152};
153}
154
155namespace std
156{
157template<> inline void swap(miral::WindowInfo& lhs, miral::WindowInfo& rhs) { lhs.swap(rhs); }
158}
159
160#endif //MIRAL_WINDOW_INFO_H
Handle class to manage a Mir surface. It may be null (e.g. default initialized)
Definition: window.h:38
Definition: window_specification.h:44
MirPointerConfinementState
Pointer Confinement.
Definition: common.h:470
MirWindowType
Definition: common.h:110
MirShellChrome
Shell chrome.
Definition: common.h:458
MirWindowState
Definition: common.h:142
MirPlacementGravity
Reference point for aligning a surface relative to a rectangle.
Definition: common.h:318
MirDepthLayer
Depth layer controls Z ordering of surfaces.
Definition: common.h:494
MirOrientationMode
Definition: common.h:291
Definition: splash_session.h:24
Mir Abstraction Layer.
Definition: floating_window_manager.h:29
STL namespace.
void swap(miral::WindowInfo &lhs, miral::WindowInfo &rhs)
Definition: window_info.h:157
Definition: point.h:31
Definition: rectangle.h:34
Definition: size.h:32
Definition: window_info.h:33
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)
void add_child(Window const &child)
auto depth_layer() const -> MirDepthLayer
void swap(WindowInfo &rhs)
Definition: window_info.h:118
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
void remove_child(Window const &child)
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
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
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 &
WindowInfo & operator=(WindowInfo const &that)
auto min_aspect() const -> AspectRatio
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:61

Copyright © 2012-2022 Canonical Ltd.
Generated on Wed Dec 28 21:01:08 UTC 2022
This documentation is licensed under the GPL version 2 or 3.