UIObject Class Reference

This class wraps a UI object like vcl::Window and provides an interface for the UI testing. More...

#include <uiobject.hxx>

Inheritance diagram for UIObject:

Public Member Functions
	UIObject ()=default
virtual	~UIObject ()
virtual StringMap	get_state ()
	Returns the state of the wrapped UI object as a string key value map. More...
virtual void	execute (const OUString &rAction, const StringMap &rParameters)
	Executes an action on the wrapped UI object, possibly with some additional parameters. More...
virtual OUString	get_type () const
	Returns the type of the UIObject. More...
virtual std::unique_ptr< UIObject >	get_child (const OUString &rID)
	Returns the child of the current UIObject with the corresponding id. More...
virtual std::set< OUString >	get_children () const
	Returns a set containing all descendants of the object. More...
virtual OUString	dumpState () const
	Currently an internal method to dump the state of the current UIObject as represented by get_state(). More...
virtual OUString	dumpHierarchy () const
	Currently an internal method to dump the parent-child relationship starting from the current top focus window. More...
virtual OUString	get_action (VclEventId nEvent) const
	Gets the corresponding Action string for the event. More...

Private Member Functions
	UIObject (UIObject const &)=delete
UIObject &	operator= (UIObject const &)=delete

Detailed Description

This class wraps a UI object like vcl::Window and provides an interface for the UI testing.

This class should only have virtual methods.

Definition at line 55 of file uiobject.hxx.

Constructor & Destructor Documentation

UIObject() [1/2]

UIObject::UIObject ( UIObject const &  )

privatedelete

UIObject() [2/2]

UIObject::UIObject ( )

default

~UIObject()

UIObject::~UIObject ( )

virtual

Definition at line 50 of file uitest/uiobject.cxx.

Member Function Documentation

dumpHierarchy()

OUString UIObject::dumpHierarchy ( ) const

virtual

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.

Reimplemented in WindowUIObject.

Definition at line 88 of file uitest/uiobject.cxx.

dumpState()

OUString UIObject::dumpState ( ) const

virtual

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.

Reimplemented in WindowUIObject.

Definition at line 83 of file uitest/uiobject.cxx.

execute()

void UIObject::execute ( const OUString &  rAction, const StringMap &  rParameters  )

virtual

Executes an action on the wrapped UI object, possibly with some additional parameters.

Reimplemented in FormattedFieldUIObject, MetricFieldUIObject, WindowUIObject, ButtonUIObject, EditUIObject, MultiLineEditUIObject, ExpanderUIObject, CheckBoxUIObject, RadioButtonUIObject, TabPageUIObject, ListBoxUIObject, ComboBoxUIObject, SpinUIObject, SpinFieldUIObject, TabControlUIObject, VerticalTabControlUIObject, TreeListUIObject, TreeListEntryUIObject, ToolBoxUIObject, MenuButtonUIObject, DrawingAreaUIObject, and RoadmapWizardUIObject.

Definition at line 61 of file uitest/uiobject.cxx.

get_action()

OUString UIObject::get_action ( VclEventId  nEvent ) const

virtual

Gets the corresponding Action string for the event.

Reimplemented in WindowUIObject, ButtonUIObject, EditUIObject, CheckBoxUIObject, RadioButtonUIObject, ListBoxUIObject, ComboBoxUIObject, SpinUIObject, SpinFieldUIObject, TabControlUIObject, and ToolBoxUIObject.

Definition at line 93 of file uitest/uiobject.cxx.

get_child()

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

virtual

Returns the child of the current UIObject with the corresponding id.

If no object with that id is being found returns a nullptr.

Reimplemented in WindowUIObject, TreeListUIObject, and TreeListEntryUIObject.

Definition at line 73 of file uitest/uiobject.cxx.

get_children()

std::set< OUString > UIObject::get_children ( ) const

virtual

Returns a set containing all descendants of the object.

Reimplemented in WindowUIObject, TreeListUIObject, and TreeListEntryUIObject.

Definition at line 78 of file uitest/uiobject.cxx.

get_state()

StringMap UIObject::get_state ( )

virtual

Returns the state of the wrapped UI object as a string key value map.

Reimplemented in FormattedFieldUIObject, MetricFieldUIObject, WindowUIObject, ButtonUIObject, DialogUIObject, EditUIObject, MultiLineEditUIObject, ExpanderUIObject, CheckBoxUIObject, RadioButtonUIObject, TabPageUIObject, ListBoxUIObject, ComboBoxUIObject, SpinUIObject, SpinFieldUIObject, TabControlUIObject, VerticalTabControlUIObject, TreeListUIObject, TreeListEntryUIObject, IconViewUIObject, ToolBoxUIObject, MenuButtonUIObject, and RoadmapWizardUIObject.

Definition at line 54 of file uitest/uiobject.cxx.

References aMap.

get_type()

OUString UIObject::get_type ( ) const

virtual

Returns the type of the UIObject.

Additional information might be available through UIObject::get_state().

Reimplemented in WindowUIObject, and TreeListEntryUIObject.

Definition at line 68 of file uitest/uiobject.cxx.

operator=()

UIObject & UIObject::operator= ( UIObject const &  )

privatedelete

---

The documentation for this class was generated from the following files:

• uiobject.hxx
• uitest/uiobject.cxx