/* -*- 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/.
*/
#pragma once
#include <rtl/ustring.hxx>
#include <map>
#include <memory>
#include <vcl/vclevent.hxx>
#include <vcl/vclptr.hxx>
#include <vcl/dllapi.h>
#include <vcl/window.hxx>
#include <set>
class Button;
class CheckBox;
class ComboBox;
class Dialog;
class Edit;
class IconView;
class ListBox;
class RadioButton;
class TabControl;
class TabPage;
class SvTreeListBox;
class SvTreeListEntry;
class SpinButton;
class SpinField;
class VerticalTabControl;
class VclExpander;
class VclDrawingArea;
class VclMultiLineEdit;
class MenuButton;
namespace vcl {
class Window; }
namespace weld {
class CustomWidgetController; }
typedef std::map<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
{
UIObject(UIObject
const &) =
delete;
UIObject&
operator =(UIObject
const &) =
delete;
public:
UIObject() =
default;
virtual ~UIObject();
/**
* Returns the state of the wrapped UI object as a
* string key value map.
*/
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);
/**
* Returns the type of the UIObject. Additional information might
* be available through UIObject::get_state().
*/
virtual OUString get_type()
const;
/**
* Returns the child of the current UIObject with the corresponding id.
* If no object with that id is being found returns a nullptr.
*
*/
virtual std::unique_ptr<UIObject> get_child(
const OUString& rID);
/**
* Returns a set containing all descendants of the object.
*/
virtual std::set<OUString> get_children()
const;
/**
* Currently an internal method to dump the state of the current UIObject as represented by get_state().
*
* This method should not be exposed to the outside world.
*
*/
virtual OUString dumpState()
const;
/**
* Currently an internal method to dump the parent-child relationship starting from the current top focus window.
*
* This method should not be exposed to the outside world.
*
*/
virtual OUString dumpHierarchy()
const;
/**
* Gets the corresponding Action string for the event.
*/
virtual OUString get_action(VclEventId nEvent)
const;
/**
* Does this represent the same underlying UI widget as rOther?
*/
virtual bool equals(
const UIObject& rOther)
const = 0;
};
class UITEST_DLLPUBLIC WindowUIObject :
public UIObject
{
VclPtr<vcl::Window> mxWindow;
public:
WindowUIObject(
const VclPtr<vcl::Window>& xWindow);
virtual StringMap get_state() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual OUString get_type()
const override;
virtual std::unique_ptr<UIObject> get_child(
const OUString& rID) override;
std::unique_ptr<UIObject> get_visible_child(
const OUString& rID);
virtual std::set<OUString> get_children()
const override;
virtual OUString dumpState()
const override;
virtual OUString dumpHierarchy()
const override;
virtual OUString get_action(VclEventId nEvent)
const override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual bool equals(
const UIObject& rOther)
const override;
protected:
virtual OUString get_name()
const;
};
// TODO: moggi: what about push buttons?
class ButtonUIObject final :
public WindowUIObject
{
VclPtr<Button> mxButton;
public:
ButtonUIObject(
const VclPtr<Button>& xButton);
virtual ~ButtonUIObject() override;
virtual StringMap get_state() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class DialogUIObject final :
public WindowUIObject
{
VclPtr<Dialog> mxDialog;
public:
DialogUIObject(
const VclPtr<Dialog>& xDialog);
virtual ~DialogUIObject() override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name()
const override;
};
class EditUIObject :
public WindowUIObject
{
VclPtr<Edit> mxEdit;
public:
EditUIObject(
const VclPtr<Edit>& xEdit);
virtual ~EditUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
protected:
virtual OUString get_name()
const override;
};
class MultiLineEditUIObject final :
public WindowUIObject
{
VclPtr<VclMultiLineEdit> mxEdit;
public:
MultiLineEditUIObject(
const VclPtr<VclMultiLineEdit>& xEdit);
virtual ~MultiLineEditUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name()
const override;
};
class ExpanderUIObject final :
public WindowUIObject
{
VclPtr<VclExpander> mxExpander;
public:
ExpanderUIObject(
const VclPtr<VclExpander>& xExpander);
virtual ~ExpanderUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name()
const override;
};
// TODO: moggi: maybe let it inherit from the button case
class CheckBoxUIObject final :
public WindowUIObject
{
private:
VclPtr<CheckBox> mxCheckBox;
public:
CheckBoxUIObject(
const VclPtr<CheckBox>& xCheckbox);
virtual ~CheckBoxUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class RadioButtonUIObject final :
public WindowUIObject
{
private:
VclPtr<RadioButton> mxRadioButton;
public:
RadioButtonUIObject(
const VclPtr<RadioButton>& xCheckbox);
virtual ~RadioButtonUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class TabPageUIObject final :
public WindowUIObject
{
private:
VclPtr<TabPage> mxTabPage;
public:
TabPageUIObject(
const VclPtr<TabPage>& xTabPage);
virtual ~TabPageUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name()
const override;
};
class ListBoxUIObject final :
public WindowUIObject
{
private:
VclPtr<ListBox> mxListBox;
public:
ListBoxUIObject(
const VclPtr<ListBox>& xListBox);
virtual ~ListBoxUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
// TODO: moggi: should it inherit from EditUIObject?
class ComboBoxUIObject final :
public WindowUIObject
{
private:
VclPtr<ComboBox> mxComboBox;
public:
ComboBoxUIObject(
const VclPtr<ComboBox>& xListBox);
virtual ~ComboBoxUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class SpinUIObject final :
public WindowUIObject
{
private:
VclPtr<SpinButton> mxSpinButton;
public:
SpinUIObject(
const VclPtr<SpinButton>& xSpinButton);
virtual ~SpinUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class SpinFieldUIObject :
public EditUIObject
{
VclPtr<SpinField> mxSpinField;
public:
SpinFieldUIObject(
const VclPtr<SpinField>& xEdit);
virtual ~SpinFieldUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class TabControlUIObject final :
public WindowUIObject
{
private:
VclPtr<TabControl> mxTabControl;
public:
TabControlUIObject(
const VclPtr<TabControl>& mxTabControl);
virtual ~TabControlUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual OUString get_action(VclEventId nEvent)
const override;
private:
virtual OUString get_name()
const override;
};
class VerticalTabControlUIObject final :
public WindowUIObject
{
private:
VclPtr<VerticalTabControl> mxTabControl;
public:
VerticalTabControlUIObject(
const VclPtr<VerticalTabControl>& mxTabControl);
virtual ~VerticalTabControlUIObject() override;
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name()
const override;
};
class TreeListUIObject :
public WindowUIObject
{
public:
TreeListUIObject(
const VclPtr<SvTreeListBox>& xTreeList);
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
virtual void execute(
const OUString& rAction,
const StringMap& rParameters) override;
virtual std::unique_ptr<UIObject> get_child(
const OUString& rID) override;
virtual std::set<OUString> get_children()
const override;
protected:
virtual OUString get_name()
const override;
VclPtr<SvTreeListBox> mxTreeList;
};
class TreeListEntryUIObject final :
public UIObject
{
public:
TreeListEntryUIObject(
const VclPtr<SvTreeListBox>& xTreeList, std::vector<sal_Int3
2> nTreePath);
virtual StringMap get_state() override;
virtual void execute(const OUString& rAction,
const StringMap& rParameters) override;
virtual std::unique_ptr<UIObject> get_child(const OUString& rID) override;
virtual std::set<OUString> get_children() const override;
virtual OUString get_type() const override;
virtual bool equals(const UIObject& rOther) const override;
private:
SvTreeListEntry* getEntry() const;
VclPtr<SvTreeListBox> mxTreeList;
std::vector<sal_Int32> maTreePath;
};
class IconViewUIObject final : public TreeListUIObject
{
public:
IconViewUIObject(const VclPtr<SvTreeListBox>& xIconView);
virtual StringMap get_state() override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name() const override;
};
class MenuButtonUIObject final : public WindowUIObject
{
VclPtr<MenuButton> mxMenuButton;
public:
MenuButtonUIObject(const VclPtr<MenuButton>& xMenuButton);
virtual ~MenuButtonUIObject() override;
virtual StringMap get_state() override;
virtual void execute(const OUString& rAction,
const StringMap& rParameters) override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
private:
virtual OUString get_name() const override;
};
class UITEST_DLLPUBLIC DrawingAreaUIObject : public WindowUIObject
{
private:
VclPtr<VclDrawingArea> mxDrawingArea;
protected:
weld::CustomWidgetController* mpController;
public:
DrawingAreaUIObject(const VclPtr<vcl::Window>& rDrawingArea);
virtual ~DrawingAreaUIObject() override;
virtual void execute(const OUString& rAction, const StringMap& rParameters) override;
static std::unique_ptr<UIObject> create(vcl::Window* pWindow);
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
