Mir
|
#include <window_specification.h>
Classes | |
struct | AspectRatio |
Public Types | |
enum | BufferUsage { BufferUsage::undefined, BufferUsage::hardware, BufferUsage::software } |
enum | InputReceptionMode { InputReceptionMode::normal, InputReceptionMode::receives_all_input } |
Public Member Functions | |
WindowSpecification () | |
WindowSpecification (WindowSpecification const &that) | |
auto | operator= (WindowSpecification const &that) -> WindowSpecification & |
WindowSpecification (mir::shell::SurfaceSpecification const &spec) | |
WindowSpecification (mir::scene::SurfaceCreationParameters const ¶ms) | |
void | update (mir::scene::SurfaceCreationParameters ¶ms) const |
~WindowSpecification () | |
auto | top_left () const -> mir::optional_value< Point > const & |
auto | size () const -> mir::optional_value< Size > const & |
auto | name () const -> mir::optional_value< std::string > const & |
auto | output_id () const -> mir::optional_value< int > const & |
auto | type () const -> mir::optional_value< MirWindowType > const & |
auto | state () const -> mir::optional_value< MirWindowState > const & |
auto | preferred_orientation () const -> mir::optional_value< MirOrientationMode > const & |
auto | aux_rect () const -> mir::optional_value< Rectangle > const & |
auto | placement_hints () const -> mir::optional_value< MirPlacementHints > const & |
auto | window_placement_gravity () const -> mir::optional_value< MirPlacementGravity > const & |
auto | aux_rect_placement_gravity () const -> mir::optional_value< MirPlacementGravity > const & |
auto | aux_rect_placement_offset () const -> mir::optional_value< Displacement > const & |
auto | min_width () const -> mir::optional_value< Width > const & |
auto | min_height () const -> mir::optional_value< Height > const & |
auto | max_width () const -> mir::optional_value< Width > const & |
auto | max_height () const -> mir::optional_value< Height > const & |
auto | width_inc () const -> mir::optional_value< DeltaX > const & |
auto | height_inc () const -> mir::optional_value< DeltaY > const & |
auto | min_aspect () const -> mir::optional_value< AspectRatio > const & |
auto | max_aspect () const -> mir::optional_value< AspectRatio > const & |
auto | parent () const -> mir::optional_value< std::weak_ptr< mir::scene::Surface >> const & |
auto | input_shape () const -> mir::optional_value< std::vector< Rectangle >> const & |
auto | input_mode () const -> mir::optional_value< InputReceptionMode > const & |
auto | shell_chrome () const -> mir::optional_value< MirShellChrome > const & |
auto | confine_pointer () const -> mir::optional_value< MirPointerConfinementState > const & |
auto | userdata () const -> mir::optional_value< std::shared_ptr< void >> const & |
auto | top_left () -> mir::optional_value< Point > & |
auto | size () -> mir::optional_value< Size > & |
auto | name () -> mir::optional_value< std::string > & |
auto | output_id () -> mir::optional_value< int > & |
auto | type () -> mir::optional_value< MirWindowType > & |
auto | state () -> mir::optional_value< MirWindowState > & |
auto | preferred_orientation () -> mir::optional_value< MirOrientationMode > & |
auto | aux_rect () -> mir::optional_value< Rectangle > & |
Relative to window's surface's CONTENT offset and size (not equal to the top_left and size exposed by this interface if server-side decorations are in use) More... | |
auto | placement_hints () -> mir::optional_value< MirPlacementHints > & |
auto | window_placement_gravity () -> mir::optional_value< MirPlacementGravity > & |
auto | aux_rect_placement_gravity () -> mir::optional_value< MirPlacementGravity > & |
auto | aux_rect_placement_offset () -> mir::optional_value< Displacement > & |
auto | min_width () -> mir::optional_value< Width > & |
auto | min_height () -> mir::optional_value< Height > & |
auto | max_width () -> mir::optional_value< Width > & |
auto | max_height () -> mir::optional_value< Height > & |
auto | width_inc () -> mir::optional_value< DeltaX > & |
auto | height_inc () -> mir::optional_value< DeltaY > & |
auto | min_aspect () -> mir::optional_value< AspectRatio > & |
auto | max_aspect () -> mir::optional_value< AspectRatio > & |
auto | parent () -> mir::optional_value< std::weak_ptr< mir::scene::Surface >> & |
auto | input_shape () -> mir::optional_value< std::vector< Rectangle >> & |
auto | input_mode () -> mir::optional_value< InputReceptionMode > & |
auto | shell_chrome () -> mir::optional_value< MirShellChrome > & |
auto | confine_pointer () -> mir::optional_value< MirPointerConfinementState > & |
auto | userdata () -> mir::optional_value< std::shared_ptr< void >> & |
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 overridden. More... | |
auto | depth_layer () -> mir::optional_value< MirDepthLayer > & |
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, it is attached to the corner where the two edges intersect If attached to oposite edges (eg left and right), it is stretched across the output in that direction If all edges are specified, it takes up the entire output. More... | |
auto | attached_edges () -> mir::optional_value< MirPlacementGravity > & |
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 If the outer optional is unset (the default), the window's exclusive rect is not changed by this spec If the outer optional is set but the inner is not, the window's exclusive rect is cleared. More... | |
auto | exclusive_rect () -> mir::optional_value< mir::optional_value< mir::geometry::Rectangle >> & |
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.freedesktop.org/desktop-entry-spec/. More... | |
auto | application_id () -> mir::optional_value< std::string > & |
|
strong |
|
strong |
miral::WindowSpecification::WindowSpecification | ( | ) |
miral::WindowSpecification::WindowSpecification | ( | WindowSpecification const & | that | ) |
miral::WindowSpecification::WindowSpecification | ( | mir::shell::SurfaceSpecification const & | spec | ) |
miral::WindowSpecification::WindowSpecification | ( | mir::scene::SurfaceCreationParameters const & | params | ) |
miral::WindowSpecification::~WindowSpecification | ( | ) |
auto miral::WindowSpecification::application_id | ( | ) | -> mir::optional_value< std::string > & |
auto miral::WindowSpecification::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.freedesktop.org/desktop-entry-spec/.
auto miral::WindowSpecification::attached_edges | ( | ) | -> mir::optional_value< MirPlacementGravity > & |
auto miral::WindowSpecification::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, it is attached to the corner where the two edges intersect If attached to oposite edges (eg left and right), it is stretched across the output in that direction If all edges are specified, it takes up the entire output.
auto miral::WindowSpecification::aux_rect | ( | ) | -> mir::optional_value< Rectangle > & |
Relative to window's surface's CONTENT offset and size (not equal to the top_left and size exposed by this interface if server-side decorations are in use)
auto miral::WindowSpecification::aux_rect | ( | ) | const -> mir::optional_value< Rectangle > const & |
auto miral::WindowSpecification::aux_rect_placement_gravity | ( | ) | -> mir::optional_value< MirPlacementGravity > & |
auto miral::WindowSpecification::aux_rect_placement_gravity | ( | ) | const -> mir::optional_value< MirPlacementGravity > const & |
auto miral::WindowSpecification::aux_rect_placement_offset | ( | ) | -> mir::optional_value< Displacement > & |
auto miral::WindowSpecification::aux_rect_placement_offset | ( | ) | const -> mir::optional_value< Displacement > const & |
auto miral::WindowSpecification::confine_pointer | ( | ) | -> mir::optional_value< MirPointerConfinementState > & |
auto miral::WindowSpecification::confine_pointer | ( | ) | const -> mir::optional_value< MirPointerConfinementState > const & |
auto miral::WindowSpecification::depth_layer | ( | ) | -> mir::optional_value< MirDepthLayer > & |
auto miral::WindowSpecification::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 overridden.
auto miral::WindowSpecification::exclusive_rect | ( | ) | -> mir::optional_value< mir::optional_value< mir::geometry::Rectangle >> & |
auto miral::WindowSpecification::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 If the outer optional is unset (the default), the window's exclusive rect is not changed by this spec If the outer optional is set but the inner is not, the window's exclusive rect is cleared.
auto miral::WindowSpecification::height_inc | ( | ) | -> mir::optional_value< DeltaY > & |
auto miral::WindowSpecification::height_inc | ( | ) | const -> mir::optional_value< DeltaY > const & |
auto miral::WindowSpecification::input_mode | ( | ) | -> mir::optional_value< InputReceptionMode > & |
auto miral::WindowSpecification::input_mode | ( | ) | const -> mir::optional_value< InputReceptionMode > const & |
auto miral::WindowSpecification::input_shape | ( | ) | -> mir::optional_value< std::vector< Rectangle >> & |
auto miral::WindowSpecification::input_shape | ( | ) | const -> mir::optional_value< std::vector< Rectangle >> const & |
auto miral::WindowSpecification::max_aspect | ( | ) | -> mir::optional_value< AspectRatio > & |
auto miral::WindowSpecification::max_aspect | ( | ) | const -> mir::optional_value< AspectRatio > const & |
auto miral::WindowSpecification::max_height | ( | ) | -> mir::optional_value< Height > & |
auto miral::WindowSpecification::max_height | ( | ) | const -> mir::optional_value< Height > const & |
auto miral::WindowSpecification::max_width | ( | ) | -> mir::optional_value< Width > & |
auto miral::WindowSpecification::max_width | ( | ) | const -> mir::optional_value< Width > const & |
auto miral::WindowSpecification::min_aspect | ( | ) | -> mir::optional_value< AspectRatio > & |
auto miral::WindowSpecification::min_aspect | ( | ) | const -> mir::optional_value< AspectRatio > const & |
auto miral::WindowSpecification::min_height | ( | ) | -> mir::optional_value< Height > & |
auto miral::WindowSpecification::min_height | ( | ) | const -> mir::optional_value< Height > const & |
auto miral::WindowSpecification::min_width | ( | ) | -> mir::optional_value< Width > & |
auto miral::WindowSpecification::min_width | ( | ) | const -> mir::optional_value< Width > const & |
auto miral::WindowSpecification::name | ( | ) | -> mir::optional_value< std::string > & |
auto miral::WindowSpecification::name | ( | ) | const -> mir::optional_value< std::string > const & |
auto miral::WindowSpecification::operator= | ( | WindowSpecification const & | that | ) | -> WindowSpecification & |
auto miral::WindowSpecification::output_id | ( | ) | -> mir::optional_value< int > & |
auto miral::WindowSpecification::output_id | ( | ) | const -> mir::optional_value< int > const & |
auto miral::WindowSpecification::parent | ( | ) | -> mir::optional_value< std::weak_ptr< mir::scene::Surface >> & |
auto miral::WindowSpecification::parent | ( | ) | const -> mir::optional_value< std::weak_ptr< mir::scene::Surface >> const & |
auto miral::WindowSpecification::placement_hints | ( | ) | -> mir::optional_value< MirPlacementHints > & |
auto miral::WindowSpecification::placement_hints | ( | ) | const -> mir::optional_value< MirPlacementHints > const & |
auto miral::WindowSpecification::preferred_orientation | ( | ) | -> mir::optional_value< MirOrientationMode > & |
auto miral::WindowSpecification::preferred_orientation | ( | ) | const -> mir::optional_value< MirOrientationMode > const & |
auto miral::WindowSpecification::shell_chrome | ( | ) | -> mir::optional_value< MirShellChrome > & |
auto miral::WindowSpecification::shell_chrome | ( | ) | const -> mir::optional_value< MirShellChrome > const & |
auto miral::WindowSpecification::size | ( | ) | -> mir::optional_value< Size > & |
auto miral::WindowSpecification::size | ( | ) | const -> mir::optional_value< Size > const & |
auto miral::WindowSpecification::state | ( | ) | -> mir::optional_value< MirWindowState > & |
auto miral::WindowSpecification::state | ( | ) | const -> mir::optional_value< MirWindowState > const & |
auto miral::WindowSpecification::top_left | ( | ) | -> mir::optional_value< Point > & |
auto miral::WindowSpecification::top_left | ( | ) | const -> mir::optional_value< Point > const & |
auto miral::WindowSpecification::type | ( | ) | -> mir::optional_value< MirWindowType > & |
auto miral::WindowSpecification::type | ( | ) | const -> mir::optional_value< MirWindowType > const & |
void miral::WindowSpecification::update | ( | mir::scene::SurfaceCreationParameters & | params | ) | const |
auto miral::WindowSpecification::userdata | ( | ) | -> mir::optional_value< std::shared_ptr< void >> & |
auto miral::WindowSpecification::userdata | ( | ) | const -> mir::optional_value< std::shared_ptr< void >> const & |
auto miral::WindowSpecification::width_inc | ( | ) | -> mir::optional_value< DeltaX > & |
auto miral::WindowSpecification::width_inc | ( | ) | const -> mir::optional_value< DeltaX > const & |
auto miral::WindowSpecification::window_placement_gravity | ( | ) | -> mir::optional_value< MirPlacementGravity > & |
auto miral::WindowSpecification::window_placement_gravity | ( | ) | const -> mir::optional_value< MirPlacementGravity > const & |
Copyright © 2012-2020
Canonical Ltd.
Generated on Mon Jun 29 21:51:46 UTC 2020
This documentation is licensed under the GPL version 2 or 3.