LibreOffice Module vcl (master)  1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
WindowUIObject Class Reference

#include <uiobject.hxx>

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

Public Member Functions

 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 ()
 

Static Public Member Functions

static std::unique_ptr< UIObjectcreate (vcl::Window *pWindow)
 

Protected Member Functions

virtual OUString get_name () const
 

Private Attributes

VclPtr< vcl::WindowmxWindow
 

Detailed Description

Definition at line 114 of file uiobject.hxx.

Constructor & Destructor Documentation

WindowUIObject::WindowUIObject ( const VclPtr< vcl::Window > &  xWindow)

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

Referenced by create().

Member Function Documentation

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

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

References WindowUIObject().

Referenced by vcl::Window::GetUITestFactory().

OUString WindowUIObject::dumpHierarchy ( ) const
overridevirtual

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 from UIObject.

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

References VclPtr< reference_type >::get(), vcl::Window::GetUITestFactory(), and mxWindow.

OUString WindowUIObject::dumpState ( ) const
overridevirtual

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 from UIObject.

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

References vcl::append(), vcl::Window::get_id(), get_state(), vcl::Window::GetChild(), vcl::Window::GetChildCount(), vcl::Window::GetUITestFactory(), i, and mxWindow.

void WindowUIObject::execute ( const OUString &  rAction,
const StringMap rParameters 
)
overridevirtual
OUString WindowUIObject::get_action ( VclEventId  nEvent) const
overridevirtual
std::unique_ptr< UIObject > WindowUIObject::get_child ( const OUString &  rID)
overridevirtual

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

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

Reimplemented from UIObject.

Reimplemented in TreeListUIObject.

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

References VclPtr< reference_type >::get(), vcl::Window::GetUITestFactory(), and mxWindow.

std::set< OUString > WindowUIObject::get_children ( ) const
overridevirtual

Returns a set containing all descendants of the object.

Reimplemented from UIObject.

Reimplemented in TreeListUIObject.

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

References VclPtr< reference_type >::get(), vcl::Window::get_id(), and mxWindow.

OUString WindowUIObject::get_name ( ) const
protectedvirtual
StringMap WindowUIObject::get_state ( )
overridevirtual

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

Reimplemented from UIObject.

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

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

References aMap, VclPtr< reference_type >::get(), vcl::Window::get_id(), vcl::Window::GetDisplayText(), vcl::Window::GetParent(), vcl::Window::GetPosPixel(), vcl::Window::GetSizePixel(), vcl::Window::GetText(), vcl::Window::GetType(), vcl::Window::IsEnabled(), vcl::Window::IsReallyVisible(), vcl::Window::IsVisible(), mxWindow, Point, vcl::Window::RequestDoubleBuffering(), and vcl::Window::SupportsDoubleBuffering().

Referenced by dumpState(), RoadmapWizardUIObject::get_state(), ButtonUIObject::get_state(), DialogUIObject::get_state(), EditUIObject::get_state(), MultiLineEditUIObject::get_state(), CheckBoxUIObject::get_state(), RadioButtonUIObject::get_state(), TabPageUIObject::get_state(), ListBoxUIObject::get_state(), ComboBoxUIObject::get_state(), SpinUIObject::get_state(), TabControlUIObject::get_state(), VerticalTabControlUIObject::get_state(), TreeListUIObject::get_state(), ToolBoxUIObject::get_state(), and MenuButtonUIObject::get_state().

OUString WindowUIObject::get_type ( ) const
overridevirtual

Returns the type of the UIObject.

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

Reimplemented from UIObject.

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

References get_name().

Referenced by ListBoxUIObject::get_action(), and SpinUIObject::get_action().

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

Member Data Documentation

VclPtr<vcl::Window> WindowUIObject::mxWindow
private

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