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
17#ifndef MIRAL_WINDOW_SPECIFICATION_H
18#define MIRAL_WINDOW_SPECIFICATION_H
19
20#include <mir_toolkit/common.h>
21
24#include <mir/optional_value.h>
25#include <mir/int_wrapper.h>
26
27#include <memory>
28
29namespace mir
30{
31namespace scene { class Surface; }
32namespace shell { struct SurfaceSpecification; }
33}
34
35namespace miral
36{
37using namespace mir::geometry;
38namespace detail { struct SessionsBufferStreamIdTag; }
40
42{
43public:
45 {
46 normal,
47 receives_all_input
48 };
49
50 struct AspectRatio { unsigned width; unsigned height; };
51
55
56 WindowSpecification(mir::shell::SurfaceSpecification const& spec);
57
59
60 auto top_left() const -> mir::optional_value<Point> const&;
61 auto size() const -> mir::optional_value<Size> const&;
62 auto name() const -> mir::optional_value<std::string> const&;
63 auto output_id() const -> mir::optional_value<int> const&;
64 auto type() const -> mir::optional_value<MirWindowType> const&;
65 auto state() const -> mir::optional_value<MirWindowState> const&;
67 auto aux_rect() const -> mir::optional_value<Rectangle> const&;
72 auto min_width() const -> mir::optional_value<Width> const&;
73 auto min_height() const -> mir::optional_value<Height> const&;
74 auto max_width() const -> mir::optional_value<Width> const&;
75 auto max_height() const -> mir::optional_value<Height> const&;
76 auto width_inc() const -> mir::optional_value<DeltaX> const&;
77 auto height_inc() const -> mir::optional_value<DeltaY> const&;
78 auto min_aspect() const -> mir::optional_value<AspectRatio> const&;
79 auto max_aspect() const -> mir::optional_value<AspectRatio> const&;
80
81 auto parent() const -> mir::optional_value<std::weak_ptr<mir::scene::Surface>> const&;
82 auto input_shape() const -> mir::optional_value<std::vector<Rectangle>> const&;
86 auto userdata() const -> mir::optional_value<std::shared_ptr<void>> const&;
87
94 auto name() -> mir::optional_value<std::string>&;
95 auto output_id() -> mir::optional_value<int>&;
106
118
119 auto parent() -> mir::optional_value<std::weak_ptr<mir::scene::Surface>>&;
124 auto userdata() -> mir::optional_value<std::shared_ptr<void>>&;
125
128 auto depth_layer() const -> mir::optional_value<MirDepthLayer> const&;
131
140
146 auto exclusive_rect() const -> mir::optional_value<mir::optional_value<mir::geometry::Rectangle>> const&;
149
153 auto application_id() const -> mir::optional_value<std::string> const&;
154 auto application_id() -> mir::optional_value<std::string>&;
156
160 auto server_side_decorated() const -> mir::optional_value<bool> const&;
163
167 auto focus_mode() const -> mir::optional_value<MirFocusMode> const&;
170
171private:
172 friend auto make_surface_spec(WindowSpecification const& miral_spec) -> mir::shell::SurfaceSpecification;
173 struct Self;
174 std::unique_ptr<Self> self;
175};
176}
177
178#endif //MIRAL_WINDOW_SPECIFICATION_H
Definition: int_wrapper.h:26
Definition: dimensions.h:34
Definition: optional_value.h:27
Definition: window_specification.h:42
auto placement_hints() const -> mir::optional_value< MirPlacementHints > const &
auto name() const -> mir::optional_value< std::string > const &
InputReceptionMode
Definition: window_specification.h:45
auto min_aspect() const -> mir::optional_value< AspectRatio > const &
auto max_aspect() const -> mir::optional_value< AspectRatio > const &
auto server_side_decorated() const -> mir::optional_value< bool > const &
If this window should have server-side decorations provided by Mir Currently, Mir only respects this ...
auto preferred_orientation() const -> mir::optional_value< MirOrientationMode > const &
auto depth_layer() const -> mir::optional_value< MirDepthLayer > const &
The depth layer of a child window is updated with the depth layer of its parent, but can be overridde...
auto attached_edges() const -> mir::optional_value< MirPlacementGravity > const &
The set of window eges that are attched to edges of the output If attached to perpendicular edges,...
auto max_width() const -> mir::optional_value< Width > const &
auto min_height() const -> mir::optional_value< Height > const &
auto height_inc() const -> mir::optional_value< DeltaY > const &
auto parent() const -> mir::optional_value< std::weak_ptr< mir::scene::Surface > > const &
WindowSpecification(WindowSpecification const &that)
auto input_shape() const -> mir::optional_value< std::vector< Rectangle > > const &
WindowSpecification(mir::shell::SurfaceSpecification const &spec)
auto shell_chrome() const -> mir::optional_value< MirShellChrome > const &
auto width_inc() const -> mir::optional_value< DeltaX > const &
auto window_placement_gravity() const -> mir::optional_value< MirPlacementGravity > const &
auto confine_pointer() const -> mir::optional_value< MirPointerConfinementState > const &
auto focus_mode() const -> mir::optional_value< MirFocusMode > const &
How the window should gain and lose focus.
auto input_mode() const -> mir::optional_value< InputReceptionMode > const &
auto size() const -> mir::optional_value< Size > const &
auto operator=(WindowSpecification const &that) -> WindowSpecification &
auto type() const -> mir::optional_value< MirWindowType > const &
auto top_left() const -> mir::optional_value< Point > const &
auto aux_rect_placement_gravity() const -> mir::optional_value< MirPlacementGravity > const &
auto max_height() const -> mir::optional_value< Height > const &
auto application_id() const -> mir::optional_value< std::string > const &
The D-bus service name and basename of the app's .desktop file See http://standards....
auto min_width() const -> mir::optional_value< Width > const &
friend auto make_surface_spec(WindowSpecification const &miral_spec) -> mir::shell::SurfaceSpecification
auto exclusive_rect() const -> mir::optional_value< mir::optional_value< mir::geometry::Rectangle > > const &
The area over which the window should not be occluded Only meaningful for windows attached to an edge...
auto output_id() const -> mir::optional_value< int > const &
auto userdata() const -> mir::optional_value< std::shared_ptr< void > > const &
auto aux_rect() const -> mir::optional_value< Rectangle > const &
auto state() const -> mir::optional_value< MirWindowState > const &
auto aux_rect_placement_offset() const -> mir::optional_value< Displacement > const &
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
MirPlacementHints
Positioning hints for aligning a window relative to a rectangle.
Definition: common.h:291
MirDepthLayer
Depth layer controls Z ordering of surfaces.
Definition: common.h:410
MirOrientationMode
Definition: common.h:209
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
Definition: dimensions.h:29
Definition: splash_session.h:22
Mir Abstraction Layer.
Definition: floating_window_manager.h:29
mir::IntWrapper< detail::SessionsBufferStreamIdTag > BufferStreamId
Definition: window_specification.h:39
STL namespace.
Definition: displacement.h:30
Definition: point.h:30
Definition: rectangle.h:31
Definition: size.h:30
Definition: window_specification.h:50
unsigned height
Definition: window_specification.h:50
unsigned width
Definition: window_specification.h:50

Copyright © 2012-2022 Canonical Ltd.
Generated on Thu Jul 21 23:32:06 UTC 2022
This documentation is licensed under the GPL version 2 or 3.