LibreOffice Module vcl (master) 1
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ButtonUIObject Class Referencefinal

#include <uiobject.hxx>

Inheritance diagram for ButtonUIObject:
[legend]
Collaboration diagram for ButtonUIObject:
[legend]

Public Member Functions

 ButtonUIObject (const VclPtr< Button > &xButton)
 
virtual ~ButtonUIObject () override
 
virtual StringMap get_state () override
 Returns the state of the wrapped UI object as a string key value map. More...
 
virtual void execute (const OUString &rAction, const StringMap &rParameters) override
 Executes an action on the wrapped UI object, possibly with some additional parameters. More...
 
virtual OUString get_action (VclEventId nEvent) const override
 Gets the corresponding Action string for the event. More...
 
- Public Member Functions inherited from WindowUIObject
 WindowUIObject (const VclPtr< vcl::Window > &xWindow)
 
virtual StringMap get_state () override
 Returns the state of the wrapped UI object as a string key value map. More...
 
virtual void execute (const OUString &rAction, const StringMap &rParameters) override
 Executes an action on the wrapped UI object, possibly with some additional parameters. More...
 
virtual OUString get_type () const override
 Returns the type of the UIObject. More...
 
virtual std::unique_ptr< UIObjectget_child (const OUString &rID) override
 Returns the child of the current UIObject with the corresponding id. More...
 
std::unique_ptr< UIObjectget_visible_child (const OUString &rID)
 
virtual std::set< OUString > get_children () const override
 Returns a set containing all descendants of the object. More...
 
virtual OUString dumpState () const override
 Currently an internal method to dump the state of the current UIObject as represented by get_state(). More...
 
virtual OUString dumpHierarchy () const override
 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 override
 Gets the corresponding Action string for the event. More...
 
- Public Member Functions inherited from UIObject
 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...
 

Static Public Member Functions

static std::unique_ptr< UIObjectcreate (vcl::Window *pWindow)
 
- Static Public Member Functions inherited from WindowUIObject
static std::unique_ptr< UIObjectcreate (vcl::Window *pWindow)
 

Private Member Functions

virtual OUString get_name () const override
 

Private Attributes

VclPtr< ButtonmxButton
 

Additional Inherited Members

virtual OUString get_name () const
 

Detailed Description

Definition at line 154 of file uiobject.hxx.

Constructor & Destructor Documentation

◆ ButtonUIObject()

ButtonUIObject::ButtonUIObject ( const VclPtr< Button > &  xButton)

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

Referenced by create().

◆ ~ButtonUIObject()

ButtonUIObject::~ButtonUIObject ( )
overridevirtual

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

Member Function Documentation

◆ create()

std::unique_ptr< UIObject > ButtonUIObject::create ( vcl::Window pWindow)
static

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

References ButtonUIObject().

Referenced by Button::GetUITestFactory().

◆ execute()

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

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

Reimplemented from WindowUIObject.

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

References Button::Click(), WindowUIObject::execute(), VclPtr< reference_type >::get(), vcl::Window::GetStyle(), mxButton, and WB_TOGGLE.

◆ get_action()

OUString ButtonUIObject::get_action ( VclEventId  nEvent) const
overridevirtual

Gets the corresponding Action string for the event.

Reimplemented from WindowUIObject.

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

References ButtonClick, WindowUIObject::get_action(), vcl::Window::get_id(), UITestLogger::getInstance(), mxButton, and UITestLogger::setAppName().

◆ get_name()

OUString ButtonUIObject::get_name ( ) const
overrideprivatevirtual

Reimplemented from WindowUIObject.

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

◆ get_state()

StringMap ButtonUIObject::get_state ( )
overridevirtual

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

Reimplemented from WindowUIObject.

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

References aMap, WindowUIObject::get_state(), Control::GetDisplayText(), and mxButton.

Member Data Documentation

◆ mxButton

VclPtr<Button> ButtonUIObject::mxButton
private

Definition at line 156 of file uiobject.hxx.

Referenced by execute(), get_action(), and get_state().


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