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

#include <uiobject.hxx>

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

Public Member Functions

 TreeListUIObject (const VclPtr< SvTreeListBox > &xTreeList)
 
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 std::unique_ptr< UIObjectget_child (const OUString &rID) override
 Returns the child of the current UIObject with the corresponding id. More...
 
virtual std::set< OUString > get_children () const override
 Returns a set containing all descendants of the object. 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)
 

Protected Member Functions

virtual OUString get_name () const override
 
virtual OUString get_name () const
 

Protected Attributes

VclPtr< SvTreeListBoxmxTreeList
 

Detailed Description

Definition at line 468 of file uiobject.hxx.

Constructor & Destructor Documentation

◆ TreeListUIObject()

TreeListUIObject::TreeListUIObject ( const VclPtr< SvTreeListBox > &  xTreeList)

Definition at line 18 of file treelist/uiobject.cxx.

Referenced by create().

Member Function Documentation

◆ create()

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

Definition at line 105 of file treelist/uiobject.cxx.

References TreeListUIObject().

Referenced by SvTreeListBox::GetUITestFactory().

◆ execute()

void TreeListUIObject::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 48 of file treelist/uiobject.cxx.

References WindowUIObject::execute(), SvTreeListBox::GetEditWidget(), and mxTreeList.

◆ get_child()

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

Definition at line 62 of file treelist/uiobject.cxx.

References SvTreeListBox::GetEditWidget(), SvTreeListBox::GetEntry(), and mxTreeList.

◆ get_children()

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

Returns a set containing all descendants of the object.

Reimplemented from WindowUIObject.

Definition at line 87 of file treelist/uiobject.cxx.

References SvTreeListBox::GetLevelChildCount(), i, and mxTreeList.

◆ get_name()

OUString TreeListUIObject::get_name ( ) const
overrideprotectedvirtual

Reimplemented from WindowUIObject.

Reimplemented in IconViewUIObject.

Definition at line 100 of file treelist/uiobject.cxx.

◆ get_state()

StringMap TreeListUIObject::get_state ( )
overridevirtual

Member Data Documentation

◆ mxTreeList

VclPtr<SvTreeListBox> TreeListUIObject::mxTreeList
protected

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