Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
declarative_placement_strategy.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2014 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: Robert Carr <robert.carr@canonical.com>
17  */
18 
19 #ifndef MIR_TEST_FRAMEWORK_DECLARATIVE_PLACEMENT_STRATEGY_H_
20 #define MIR_TEST_FRAMEWORK_DECLARATIVE_PLACEMENT_STRATEGY_H_
21 
23 #include "mir/geometry/rectangle.h"
24 #include "mir/scene/depth_id.h"
25 
26 #include <memory>
27 #include <map>
28 #include <string>
29 
30 namespace mir_test_framework
31 {
32 typedef std::map<std::string, mir::geometry::Rectangle> SurfaceGeometries;
33 typedef std::map<std::string, mir::scene::DepthId> SurfaceDepths;
34 
40 {
41  public:
42  // Placement requests will be passed through to default strategy, and then overriden if the surface appears
43  // in the geometry or depth map. This allows for the convenience of leaving some surfaces geometries unspecified
44  // and receiving the default behavior.
45  DeclarativePlacementStrategy(std::shared_ptr<mir::shell::PlacementStrategy> const& default_strategy,
46  SurfaceGeometries const& positions_by_name, SurfaceDepths const& depths_by_name);
47 
48  virtual ~DeclarativePlacementStrategy() = default;
49 
51 
52 protected:
55 
56 private:
57  std::shared_ptr<mir::shell::PlacementStrategy> const default_strategy;
58 
59  SurfaceGeometries surface_geometries_by_name;
60  SurfaceDepths surface_depths_by_name;
61 };
62 }
63 
64 #endif // MIR_TEST_FRAMEWORK_DECLARATIVE_PLACEMENT_STRATEGY_H_
std::map< std::string, mir::geometry::Rectangle > SurfaceGeometries
Definition: declarative_placement_strategy.h:32
DeclarativePlacementStrategy & operator=(const DeclarativePlacementStrategy &)=delete
Definition: surface_creation_parameters.h:38
DeclarativePlacementStrategy(std::shared_ptr< mir::shell::PlacementStrategy > const &default_strategy, SurfaceGeometries const &positions_by_name, SurfaceDepths const &depths_by_name)
Definition: session.h:33
mir::shell::SurfaceCreationParameters place(mir::shell::Session const &session, mir::shell::SurfaceCreationParameters const &request_parameters) override
DeclarativePlacementStrategy is a test utility server component for specifying a static list of surfa...
Definition: declarative_placement_strategy.h:39
Definition: placement_strategy.h:30
std::map< std::string, mir::scene::DepthId > SurfaceDepths
Definition: declarative_placement_strategy.h:33

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Apr 11 21:14:53 UTC 2014