summaryrefslogtreecommitdiff
path: root/include/test/uiobject.hxx
blob: c33bd4380790a1d9797260a5efb3fa9b46c9adc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#include <rtl/ustring.hxx>
#include <map>
#include <memory>

#include <vcl/window.hxx>
#include <test/testdllapi.hxx>

enum class UIObjectType
{
    WINDOW,
    DIALOG,
    UNKNOWN
};

typedef std::map<const OUString, OUString> StringMap;

/**
 * This class wraps a UI object like vcl::Window and provides
 * an interface for the UI testing.
 *
 * This class should only have virtual methods.
 */
class UITEST_DLLPUBLIC UIObject
{
public:

    virtual ~UIObject();

    /**
     * returns the state of the wrapped UI object
     */
    virtual StringMap get_state();

    /**
     * executes an action on the wrapped UI object,
     * possibly with some additional parameters
     */
    virtual void execute(const OUString& rAction,
            const StringMap& rParameters);

    virtual UIObjectType getType() const;

    virtual std::unique_ptr<UIObject> get_child(const OUString& rID);
};

class WindowUIObject : public UIObject
{
    VclPtr<vcl::Window> mxWindow;

public:

    WindowUIObject(VclPtr<vcl::Window> xWindow);

    virtual StringMap get_state() override;

    virtual void execute(const OUString& rAction,
            const StringMap& rParameters) override;

    virtual UIObjectType getType() const override;

    virtual std::unique_ptr<UIObject> get_child(const OUString& rID);
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */