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
31namespace mir
32{
33namespace scene { class Surface; struct SurfaceCreationParameters; }
34namespace shell { struct SurfaceSpecification; }
35}
36
37namespace miral
38{
39using namespace mir::geometry;
40namespace detail { struct SessionsBufferStreamIdTag; }
42
44{
45public:
46 enum class BufferUsage
47 {
48 undefined,
50 hardware,
52 software
53 };
54
56 {
57 normal,
58 receives_all_input
59 };
60
61 struct AspectRatio { unsigned width; unsigned height; };
62
66
67 WindowSpecification(mir::shell::SurfaceSpecification const& spec);
68 WindowSpecification(mir::scene::SurfaceCreationParameters const& params);
69 void update(mir::scene::SurfaceCreationParameters& params) const;
70
72
73 auto top_left() const -> mir::optional_value<Point> const&;
74 auto size() const -> mir::optional_value<Size> const&;
75 auto name() const -> mir::optional_value<std::string> const&;
76 auto output_id() const -> mir::optional_value<int> const&;
77 auto type() const -> mir::optional_value<MirWindowType> const&;
78 auto state() const -> mir::optional_value<MirWindowState> const&;
80 auto aux_rect() const -> mir::optional_value<Rectangle> const&;
85 auto min_width() const -> mir::optional_value<Width> const&;
86 auto min_height() const -> mir::optional_value<Height> const&;
87 auto max_width() const -> mir::optional_value<Width> const&;
88 auto max_height() const -> mir::optional_value<Height> const&;
89 auto width_inc() const -> mir::optional_value<DeltaX> const&;
90 auto height_inc() const -> mir::optional_value<DeltaY> const&;
91 auto min_aspect() const -> mir::optional_value<AspectRatio> const&;
92 auto max_aspect() const -> mir::optional_value<AspectRatio> const&;
93
94 auto parent() const -> mir::optional_value<std::weak_ptr<mir::scene::Surface>> const&;
95 auto input_shape() const -> mir::optional_value<std::vector<Rectangle>> const&;
99 auto userdata() const -> mir::optional_value<std::shared_ptr<void>> const&;
100
103 auto name() -> mir::optional_value<std::string>&;
104 auto output_id() -> mir::optional_value<int>&;
123 auto parent() -> mir::optional_value<std::weak_ptr<mir::scene::Surface>>&;
128 auto userdata() -> mir::optional_value<std::shared_ptr<void>>&;
129
132 auto depth_layer() const -> mir::optional_value<MirDepthLayer> const&;
135
144
150 auto exclusive_rect() const -> mir::optional_value<mir::optional_value<mir::geometry::Rectangle>> const&;
153
157 auto application_id() const -> mir::optional_value<std::string> const&;
158 auto application_id() -> mir::optional_value<std::string>&;
160
161private:
162 struct Self;
163 std::unique_ptr<Self> self;
164};
165}
166
167#endif //MIRAL_WINDOW_SPECIFICATION_H
Definition: int_wrapper.h:28
Definition: optional_value.h:29
Definition: window_specification.h:44
auto placement_hints() const -> mir::optional_value< MirPlacementHints > const &
auto name() const -> mir::optional_value< std::string > const &
void update(mir::scene::SurfaceCreationParameters &params) const
InputReceptionMode
Definition: window_specification.h:56
auto min_aspect() const -> mir::optional_value< AspectRatio > const &
auto max_aspect() const -> mir::optional_value< AspectRatio > const &
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::scene::SurfaceCreationParameters const &params)
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 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 &
BufferUsage
Definition: window_specification.h:47
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 &
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 &
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
MirPlacementHints
Positioning hints for aligning a window relative to a rectangle.
Definition: common.h:373
MirDepthLayer
Depth layer controls Z ordering of surfaces.
Definition: common.h:494
MirOrientationMode
Definition: common.h:291
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:29
mir::IntWrapper< detail::SessionsBufferStreamIdTag > BufferStreamId
Definition: window_specification.h:41
STL namespace.
Definition: displacement.h:34
Definition: point.h:31
Definition: rectangle.h:34
Definition: size.h:32
Definition: window_specification.h:61
unsigned height
Definition: window_specification.h:61
unsigned width
Definition: window_specification.h:61

Copyright © 2012-2022 Canonical Ltd.
Generated on Sat 3 Dec 14:36:51 UTC 2022
This documentation is licensed under the GPL version 2 or 3.