.. _program_listing_file_include_miral_miral_window_specification.h:

Program Listing for File window_specification.h
===============================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_miral_miral_window_specification.h>` (``include/miral/miral/window_specification.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*
    * Copyright © Canonical Ltd.
    *
    * This program is free software: you can redistribute it and/or modify it
    * under the terms of the GNU General Public License version 2 or 3 as
    * published by the Free Software Foundation.
    *
    * This program is distributed in the hope that it will be useful,
    * but WITHOUT ANY WARRANTY; without even the implied warranty of
    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    * GNU General Public License for more details.
    *
    * You should have received a copy of the GNU General Public License
    * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    */
   
   #ifndef MIRAL_WINDOW_SPECIFICATION_H
   #define MIRAL_WINDOW_SPECIFICATION_H
   
   #include <mir_toolkit/common.h>
   
   #include <mir/geometry/displacement.h>
   #include <mir/geometry/rectangles.h>
   #include <mir/optional_value.h>
   #include <mir/int_wrapper.h>
   
   #include <memory>
   
   namespace mir
   {
   namespace scene { class Surface; }
   namespace shell { struct SurfaceSpecification; }
   }
   
   namespace miral
   {
   using namespace mir::geometry;
   namespace detail { struct SessionsBufferStreamIdTag; }
   typedef mir::IntWrapper<detail::SessionsBufferStreamIdTag> BufferStreamId;
   
   class WindowSpecification
   {
   public:
       enum class InputReceptionMode
       {
           normal,
           receives_all_input
       };
   
       struct AspectRatio { unsigned width; unsigned height; };
   
       WindowSpecification();
       WindowSpecification(WindowSpecification const& that);
       auto operator=(WindowSpecification const& that) -> WindowSpecification&;
   
       WindowSpecification(mir::shell::SurfaceSpecification const& spec);
   
       ~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>&;
       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&;
       auto depth_layer() -> mir::optional_value<MirDepthLayer>&;
   
       auto attached_edges() const -> mir::optional_value<MirPlacementGravity> const&;
       auto attached_edges() -> mir::optional_value<MirPlacementGravity>&;
   
       auto exclusive_rect() const -> mir::optional_value<mir::optional_value<mir::geometry::Rectangle>> const&;
       auto exclusive_rect() -> mir::optional_value<mir::optional_value<mir::geometry::Rectangle>>&;
   
       auto ignore_exclusion_zones() const -> mir::optional_value<bool> const&;
       auto ignore_exclusion_zones() -> mir::optional_value<bool>&;
   
       auto application_id() const -> mir::optional_value<std::string> const&;
       auto application_id() -> mir::optional_value<std::string>&;
   
       auto server_side_decorated() const -> mir::optional_value<bool> const&;
       auto server_side_decorated() -> mir::optional_value<bool>&;
   
       auto focus_mode() const -> mir::optional_value<MirFocusMode> const&;
       auto focus_mode() -> mir::optional_value<MirFocusMode>&;
   
       auto visible_on_lock_screen() const -> mir::optional_value<bool> const&;
       auto visible_on_lock_screen() -> mir::optional_value<bool>&;
   
   private:
       friend auto make_surface_spec(WindowSpecification const& miral_spec) -> mir::shell::SurfaceSpecification;
       struct Self;
       std::unique_ptr<Self> self;
   };
   }
   
   #endif //MIRAL_WINDOW_SPECIFICATION_H