Mir
window_specification.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_SPECIFICATION_H
20 #define MIRAL_WINDOW_SPECIFICATION_H
21 
22 #include <mir_toolkit/common.h>
23 
26 #include <mir/optional_value.h>
27 #include <mir/int_wrapper.h>
28 
29 #include <memory>
30 
31 namespace mir
32 {
33 namespace scene { class Surface; }
34 namespace shell { struct SurfaceSpecification; }
35 }
36 
37 namespace miral
38 {
39 using namespace mir::geometry;
40 namespace detail { struct SessionsBufferStreamIdTag; }
42 
44 {
45 public:
46  enum class InputReceptionMode
47  {
48  normal,
49  receives_all_input
50  };
51 
52  struct AspectRatio { unsigned width; unsigned height; };
53 
57 
58  WindowSpecification(mir::shell::SurfaceSpecification const& spec);
59 
61 
62  auto top_left() const -> mir::optional_value<Point> const&;
63  auto size() const -> mir::optional_value<Size> const&;
64  auto name() const -> mir::optional_value<std::string> const&;
65  auto output_id() const -> mir::optional_value<int> const&;
66  auto type() const -> mir::optional_value<MirWindowType> const&;
67  auto state() const -> mir::optional_value<MirWindowState> const&;
68  auto preferred_orientation() const -> mir::optional_value<MirOrientationMode> const&;
69  auto aux_rect() const -> mir::optional_value<Rectangle> const&;
70  auto placement_hints() const -> mir::optional_value<MirPlacementHints> const&;
71  auto window_placement_gravity() const -> mir::optional_value<MirPlacementGravity> const&;
72  auto aux_rect_placement_gravity() const -> mir::optional_value<MirPlacementGravity> const&;
73  auto aux_rect_placement_offset() const -> mir::optional_value<Displacement> const&;
74  auto min_width() const -> mir::optional_value<Width> const&;
75  auto min_height() const -> mir::optional_value<Height> const&;
76  auto max_width() const -> mir::optional_value<Width> const&;
77  auto max_height() const -> mir::optional_value<Height> const&;
78  auto width_inc() const -> mir::optional_value<DeltaX> const&;
79  auto height_inc() const -> mir::optional_value<DeltaY> const&;
80  auto min_aspect() const -> mir::optional_value<AspectRatio> const&;
81  auto max_aspect() const -> mir::optional_value<AspectRatio> const&;
82 
83  auto parent() const -> mir::optional_value<std::weak_ptr<mir::scene::Surface>> const&;
84  auto input_shape() const -> mir::optional_value<std::vector<Rectangle>> const&;
85  auto input_mode() const -> mir::optional_value<InputReceptionMode> const&;
86  auto shell_chrome() const -> mir::optional_value<MirShellChrome> const&;
87  auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
88  auto userdata() const -> mir::optional_value<std::shared_ptr<void>> const&;
89 
90  auto top_left() -> mir::optional_value<Point>&;
95  auto size() -> mir::optional_value<Size>&;
96  auto name() -> mir::optional_value<std::string>&;
97  auto output_id() -> mir::optional_value<int>&;
98  auto type() -> mir::optional_value<MirWindowType>&;
99  auto state() -> mir::optional_value<MirWindowState>&;
100  auto preferred_orientation() -> mir::optional_value<MirOrientationMode>&;
103  auto aux_rect() -> mir::optional_value<Rectangle>&;
104  auto placement_hints() -> mir::optional_value<MirPlacementHints>&;
105  auto window_placement_gravity() -> mir::optional_value<MirPlacementGravity>&;
106  auto aux_rect_placement_gravity() -> mir::optional_value<MirPlacementGravity>&;
107  auto aux_rect_placement_offset() -> mir::optional_value<Displacement>&;
108 
111  auto min_width() -> mir::optional_value<Width>&;
112  auto min_height() -> mir::optional_value<Height>&;
113  auto max_width() -> mir::optional_value<Width>&;
114  auto max_height() -> mir::optional_value<Height>&;
115  auto width_inc() -> mir::optional_value<DeltaX>&;
116  auto height_inc() -> mir::optional_value<DeltaY>&;
117  auto min_aspect() -> mir::optional_value<AspectRatio>&;
118  auto max_aspect() -> mir::optional_value<AspectRatio>&;
120 
121  auto parent() -> mir::optional_value<std::weak_ptr<mir::scene::Surface>>&;
122  auto input_shape() -> mir::optional_value<std::vector<Rectangle>>&;
123  auto input_mode() -> mir::optional_value<InputReceptionMode>&;
124  auto shell_chrome() -> mir::optional_value<MirShellChrome>&;
125  auto confine_pointer() -> mir::optional_value<MirPointerConfinementState>&;
126  auto userdata() -> mir::optional_value<std::shared_ptr<void>>&;
127 
130  auto depth_layer() const -> mir::optional_value<MirDepthLayer> const&;
131  auto depth_layer() -> mir::optional_value<MirDepthLayer>&;
133 
139  auto attached_edges() const -> mir::optional_value<MirPlacementGravity> const&;
140  auto attached_edges() -> mir::optional_value<MirPlacementGravity>&;
142 
148  auto exclusive_rect() const -> mir::optional_value<mir::optional_value<mir::geometry::Rectangle>> const&;
149  auto exclusive_rect() -> mir::optional_value<mir::optional_value<mir::geometry::Rectangle>>&;
151 
155  auto application_id() const -> mir::optional_value<std::string> const&;
156  auto application_id() -> mir::optional_value<std::string>&;
158 
162  auto server_side_decorated() const -> mir::optional_value<bool> const&;
163  auto server_side_decorated() -> mir::optional_value<bool>&;
165 
169  auto focus_mode() const -> mir::optional_value<MirFocusMode> const&;
170  auto focus_mode() -> mir::optional_value<MirFocusMode>&;
172 
173 private:
174  friend auto make_surface_spec(WindowSpecification const& miral_spec) -> mir::shell::SurfaceSpecification;
175  struct Self;
176  std::unique_ptr<Self> self;
177 };
178 }
179 
180 #endif //MIRAL_WINDOW_SPECIFICATION_H
Definition: int_wrapper.h:28
Definition: dimensions.h:36
Definition: window_specification.h:44
InputReceptionMode
Definition: window_specification.h:47
WindowSpecification(WindowSpecification const &that)
WindowSpecification(mir::shell::SurfaceSpecification const &spec)
auto operator=(WindowSpecification const &that) -> WindowSpecification &
auto top_left() const -> mir::optional_value< Point > const &
MirFocusMode
Focus mode controls how a surface gains and loses focus.
Definition: common.h:425
MirPointerConfinementState
Pointer Confinement.
Definition: common.h:387
MirWindowType
Definition: common.h:58
MirShellChrome
Shell chrome.
Definition: common.h:378
MirWindowState
Definition: common.h:73
MirPlacementGravity
Reference point for aligning a surface relative to a rectangle.
Definition: common.h:238
MirPlacementHints
Positioning hints for aligning a window relative to a rectangle.
Definition: common.h:293
MirDepthLayer
Depth layer controls Z ordering of surfaces.
Definition: common.h:412
MirOrientationMode
Definition: common.h:211
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
Definition: dimensions.h:31
Definition: splash_session.h:24
Mir Abstraction Layer.
Definition: floating_window_manager.h:31
mir::IntWrapper< detail::SessionsBufferStreamIdTag > BufferStreamId
Definition: window_specification.h:41
Definition: displacement.h:32
Definition: point.h:32
Definition: rectangle.h:34
Definition: size.h:32
Definition: window_specification.h:52
unsigned height
Definition: window_specification.h:52

Copyright © 2012-2022 Canonical Ltd.
Generated on Fri Feb 25 18:01:37 UTC 2022
This documentation is licensed under the GPL version 2 or 3.