MirAL
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 3,
6  * as 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 
25 
26 #include <mir/geometry/displacement.h>
27 #include <mir/geometry/rectangles.h>
28 #include <mir/optional_value.h>
29 #include <mir/int_wrapper.h>
30 
31 #include <memory>
32 
33 namespace mir
34 {
35 namespace scene { class Surface; struct SurfaceCreationParameters; }
36 namespace shell { struct SurfaceSpecification; }
37 }
38 
39 namespace miral
40 {
41 using namespace mir::geometry;
42 namespace detail { struct SessionsBufferStreamIdTag; }
43 typedef mir::IntWrapper<detail::SessionsBufferStreamIdTag> BufferStreamId;
44 
46 {
47 public:
48  enum class BufferUsage
49  {
50  undefined,
52  hardware,
54  software
55  };
56 
57  enum class InputReceptionMode
58  {
59  normal,
60  receives_all_input
61  };
62 
63  struct AspectRatio { unsigned width; unsigned height; };
64 
67  auto operator=(WindowSpecification const& that) -> WindowSpecification&;
68 
69  WindowSpecification(mir::shell::SurfaceSpecification const& spec);
70  WindowSpecification(mir::scene::SurfaceCreationParameters const& params);
71  void update(mir::scene::SurfaceCreationParameters& params) const;
72 
74 
75  auto top_left() const -> mir::optional_value<Point> const&;
76  auto size() const -> mir::optional_value<Size> const&;
77  auto name() const -> mir::optional_value<std::string> const&;
78  auto output_id() const -> mir::optional_value<int> const&;
79  auto type() const -> mir::optional_value<MirSurfaceType> const&;
80  auto state() const -> mir::optional_value<MirSurfaceState> const&;
81  auto preferred_orientation() const -> mir::optional_value<MirOrientationMode> const&;
82  auto aux_rect() const -> mir::optional_value<Rectangle> const&;
83  auto placement_hints() const -> mir::optional_value<MirPlacementHints> const&;
84  auto window_placement_gravity() const -> mir::optional_value<MirPlacementGravity> const&;
85  auto aux_rect_placement_gravity() const -> mir::optional_value<MirPlacementGravity> const&;
86  auto aux_rect_placement_offset() const -> mir::optional_value<Displacement> const&;
87  auto min_width() const -> mir::optional_value<Width> const&;
88  auto min_height() const -> mir::optional_value<Height> const&;
89  auto max_width() const -> mir::optional_value<Width> const&;
90  auto max_height() const -> mir::optional_value<Height> const&;
91  auto width_inc() const -> mir::optional_value<DeltaX> const&;
92  auto height_inc() const -> mir::optional_value<DeltaY> const&;
93  auto min_aspect() const -> mir::optional_value<AspectRatio> const&;
94  auto max_aspect() const -> mir::optional_value<AspectRatio> const&;
95 
96  auto parent() const -> mir::optional_value<std::weak_ptr<mir::scene::Surface>> const&;
97  auto input_shape() const -> mir::optional_value<std::vector<Rectangle>> const&;
98  auto input_mode() const -> mir::optional_value<InputReceptionMode> const&;
99  auto shell_chrome() const -> mir::optional_value<MirShellChrome> const&;
100  auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
101  auto userdata() const -> mir::optional_value<std::shared_ptr<void>> const&;
102 
103  auto top_left() -> mir::optional_value<Point>&;
104  auto size() -> mir::optional_value<Size>&;
105  auto name() -> mir::optional_value<std::string>&;
106  auto output_id() -> mir::optional_value<int>&;
107  auto type() -> mir::optional_value<MirSurfaceType>&;
108  auto state() -> mir::optional_value<MirSurfaceState>&;
109  auto preferred_orientation() -> mir::optional_value<MirOrientationMode>&;
110  auto aux_rect() -> mir::optional_value<Rectangle>&;
111  auto placement_hints() -> mir::optional_value<MirPlacementHints>&;
112  auto window_placement_gravity() -> mir::optional_value<MirPlacementGravity>&;
113  auto aux_rect_placement_gravity() -> mir::optional_value<MirPlacementGravity>&;
114  auto aux_rect_placement_offset() -> mir::optional_value<Displacement>&;
115  auto min_width() -> mir::optional_value<Width>&;
116  auto min_height() -> mir::optional_value<Height>&;
117  auto max_width() -> mir::optional_value<Width>&;
118  auto max_height() -> mir::optional_value<Height>&;
119  auto width_inc() -> mir::optional_value<DeltaX>&;
120  auto height_inc() -> mir::optional_value<DeltaY>&;
121  auto min_aspect() -> mir::optional_value<AspectRatio>&;
122  auto max_aspect() -> mir::optional_value<AspectRatio>&;
123  auto parent() -> mir::optional_value<std::weak_ptr<mir::scene::Surface>>&;
124  auto input_shape() -> mir::optional_value<std::vector<Rectangle>>&;
125  auto input_mode() -> mir::optional_value<InputReceptionMode>&;
126  auto shell_chrome() -> mir::optional_value<MirShellChrome>&;
127  auto confine_pointer() -> mir::optional_value<MirPointerConfinementState>&;
128  auto userdata() -> mir::optional_value<std::shared_ptr<void>>&;
129 
130 private:
131  struct Self;
132  std::unique_ptr<Self> self;
133 };
134 }
135 
136 #endif //MIRAL_WINDOW_SPECIFICATION_H
Definition: active_outputs.h:25
Definition: window_specification.h:63
Definition: window_specification.h:45
unsigned width
Definition: window_specification.h:63
BufferUsage
Definition: window_specification.h:48
InputReceptionMode
Definition: window_specification.h:57
Mir Abstraction Layer.
Definition: active_outputs.h:27
mir::IntWrapper< detail::SessionsBufferStreamIdTag > BufferStreamId
Definition: window_specification.h:43

Copyright © 2016 Canonical Ltd.
Generated on Wed Nov 30 08:45:30 UTC 2016