LibreOffice Module vcl (master)  1
Public Member Functions | Private Member Functions | List of all members
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:
[legend]

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< UIObjectget_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
 
UIObjectoperator= (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 41 of file uiobject.hxx.

Constructor & Destructor Documentation

UIObject::UIObject ( UIObject const &  )
privatedelete
UIObject::UIObject ( )
default
UIObject::~UIObject ( )
virtual

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

Member Function Documentation

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 71 of file uitest/uiobject.cxx.

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 66 of file uitest/uiobject.cxx.

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 TreeListEntryUIObject, TreeListUIObject, TabControlUIObject, SpinFieldUIObject, SpinUIObject, ComboBoxUIObject, ListBoxUIObject, TabPageUIObject, RadioButtonUIObject, CheckBoxUIObject, MultiLineEditUIObject, EditUIObject, ButtonUIObject, and WindowUIObject.

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

OUString UIObject::get_action ( VclEventId  nEvent) const
virtual
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 TreeListEntryUIObject, TreeListUIObject, and WindowUIObject.

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

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

Returns a set containing all descendants of the object.

Reimplemented in TreeListEntryUIObject, TreeListUIObject, and WindowUIObject.

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

StringMap UIObject::get_state ( )
virtual
OUString UIObject::get_type ( ) const
virtual

Returns the type of the UIObject.

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

Reimplemented in TreeListEntryUIObject, and WindowUIObject.

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

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

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