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

#include <uiobject.hxx>

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

Public Member Functions

 TreeListEntryUIObject (const VclPtr< SvTreeListBox > &xTreeList, SvTreeListEntry *pEntry)
 
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...
 
virtual OUString get_type () const override
 Returns the type of the UIObject. 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...
 

Private Attributes

VclPtr< SvTreeListBoxmxTreeList
 
SvTreeListEntry *const mpEntry
 

Detailed Description

Definition at line 491 of file uiobject.hxx.

Constructor & Destructor Documentation

◆ TreeListEntryUIObject()

TreeListEntryUIObject::TreeListEntryUIObject ( const VclPtr< SvTreeListBox > &  xTreeList,
SvTreeListEntry pEntry 
)

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

Referenced by get_child().

Member Function Documentation

◆ execute()

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

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

Reimplemented from UIObject.

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

References Button, SvLBoxButton::ClickHdl(), SvTreeListBox::Collapse(), SvTreeListBox::DoubleClickHdl(), SvTreeListBox::Expand(), SvTreeListEntry::GetFirstItem(), mpEntry, mxTreeList, SvTreeListBox::Select(), and SvTreeListBox::SetCurEntry().

◆ get_child()

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

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

References SvTreeListBox::GetEntry(), mpEntry, mxTreeList, and TreeListEntryUIObject().

◆ get_children()

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

Returns a set containing all descendants of the object.

Reimplemented from UIObject.

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

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

◆ get_state()

StringMap TreeListEntryUIObject::get_state ( )
overridevirtual

◆ get_type()

OUString TreeListEntryUIObject::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 199 of file treelist/uiobject.cxx.

Member Data Documentation

◆ mpEntry

SvTreeListEntry* const TreeListEntryUIObject::mpEntry
private

Definition at line 512 of file uiobject.hxx.

Referenced by execute(), get_child(), get_children(), and get_state().

◆ mxTreeList

VclPtr<SvTreeListBox> TreeListEntryUIObject::mxTreeList
private

Definition at line 510 of file uiobject.hxx.

Referenced by execute(), get_child(), get_children(), and get_state().


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