← Back to branch summary

~ubuntu-branches/ubuntu/wily/mir/wily-proposed

« back to all changes in this revision

Viewing changes to include/test/mir_test_framework/declarative_placement_strategy.h

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release
  • Date: 2014-10-10 14:01:26 UTC
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: package-import@ubuntu.com-20141010140126-n1czko8na1kuz4ll
Tags: upstream-0.8.0+14.10.20141010
Import upstream version 0.8.0+14.10.20141010

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/test/mir_test_framework/declarative_placement_strategy.h
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
 
 
22
 
#include "mir/scene/placement_strategy.h"
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
 
 
35
 
/// DeclarativePlacementStrategy is a test utility server component for specifying
36
 
/// a static list of surface geometries and relative depths. Used, for example,
37
 
/// in input tests where it is necessary to set up scenarios depending on
38
 
/// multiple surfaces geometry and stacking.
39
 
class DeclarativePlacementStrategy : public mir::scene::PlacementStrategy
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::scene::PlacementStrategy> const& default_strategy,
46
 
        SurfaceGeometries const& positions_by_name, SurfaceDepths const& depths_by_name);
47
 
 
48
 
    virtual ~DeclarativePlacementStrategy() = default;
49
 
    
50
 
    mir::scene::SurfaceCreationParameters place(mir::scene::Session const& session, mir::scene::SurfaceCreationParameters const& request_parameters) override;
51
 
 
52
 
protected:
53
 
    DeclarativePlacementStrategy(const DeclarativePlacementStrategy&) = delete;
54
 
    DeclarativePlacementStrategy& operator=(const DeclarativePlacementStrategy&) = delete;
55
 
 
56
 
private:
57
 
    std::shared_ptr<mir::scene::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_