#include <uiobject.hxx>

Inheritance diagram for WindowUIObject:

Collaboration diagram for WindowUIObject:

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< UIObject >	get_child (const OUString &rID) override
	Returns the child of the current UIObject with the corresponding id. More...

std::unique_ptr< UIObject >	get_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< 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...

Static Public Member Functions
static std::unique_ptr< UIObject >	create (vcl::Window *pWindow)

Protected Member Functions
virtual OUString	get_name () const

Private Attributes
VclPtr< vcl::Window >	mxWindow

Detailed Description

Definition at line 118 of file uiobject.hxx.

Constructor & Destructor Documentation

◆ WindowUIObject()

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

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

Referenced by create().

Member Function Documentation

◆ create()

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

static

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

References WindowUIObject().

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

◆ dumpHierarchy()

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

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

◆ dumpState()

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

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

◆ execute()

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

overridevirtual

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

Reimplemented from UIObject.

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

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

References get_name(), vcl::Window::GrabFocus(), vcl::Window::KeyInput(), mxWindow, and SAL_WARN.

◆ get_action()

OUString WindowUIObject::get_action ( VclEventId nEvent ) const

overridevirtual

Gets the corresponding Action string for the event.

Reimplemented from UIObject.

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

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

References ButtonClick, CheckboxToggle, ControlGetFocus, ControlLoseFocus, EditModify, vcl::Window::get_id(), and mxWindow.

Referenced by ButtonUIObject::get_action(), EditUIObject::get_action(), CheckBoxUIObject::get_action(), RadioButtonUIObject::get_action(), ListBoxUIObject::get_action(), ComboBoxUIObject::get_action(), SpinUIObject::get_action(), SpinFieldUIObject::get_action(), TabControlUIObject::get_action(), and ToolBoxUIObject::get_action().

◆ get_child()

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

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

◆ get_children()

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

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

◆ get_name()

OUString WindowUIObject::get_name ( ) const

protectedvirtual

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

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

Referenced by execute(), and get_type().

◆ get_state()

StringMap WindowUIObject::get_state ( )

overridevirtual

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

Reimplemented from UIObject.

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

Definition at line 291 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::HasChildPathFocus(), vcl::Window::IsEnabled(), vcl::Window::IsReallyVisible(), vcl::Window::IsVisible(), mxWindow, vcl::Window::RequestDoubleBuffering(), and vcl::Window::SupportsDoubleBuffering().

◆ get_type()

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

References get_name().

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

◆ get_visible_child()

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

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

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

Member Data Documentation

◆ mxWindow

VclPtr<vcl::Window> WindowUIObject::mxWindow

private

Definition at line 120 of file uiobject.hxx.

Referenced by dumpHierarchy(), dumpState(), execute(), get_action(), get_child(), get_children(), get_state(), and get_visible_child().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WindowUIObject()

Member Function Documentation

◆ create()

◆ dumpHierarchy()

◆ dumpState()

◆ execute()

◆ get_action()

◆ get_child()

◆ get_children()

◆ get_name()

◆ get_state()

◆ get_type()

◆ get_visible_child()

Member Data Documentation

◆ mxWindow