LibreOffice Module vcl (master) 1
Public Member Functions | Protected Member Functions | List of all members
vcl::ISearchableStringList Class Referenceabstract

#include <quickselectionengine.hxx>

Inheritance diagram for vcl::ISearchableStringList:
[legend]

Public Member Functions

virtual StringEntryIdentifier CurrentEntry (OUString &_out_entryText) const =0
 returns the current entry in the list of searchable strings. More...
 
virtual StringEntryIdentifier NextEntry (StringEntryIdentifier _currentEntry, OUString &_out_entryText) const =0
 returns the next entry in the list. More...
 
virtual void SelectEntry (StringEntryIdentifier _entry)=0
 selects a given entry More...
 

Protected Member Functions

 ~ISearchableStringList ()
 

Detailed Description

Definition at line 40 of file quickselectionengine.hxx.

Constructor & Destructor Documentation

◆ ~ISearchableStringList()

vcl::ISearchableStringList::~ISearchableStringList ( )
inlineprotected

Definition at line 61 of file quickselectionengine.hxx.

Member Function Documentation

◆ CurrentEntry()

virtual StringEntryIdentifier vcl::ISearchableStringList::CurrentEntry ( OUString &  _out_entryText) const
pure virtual

returns the current entry in the list of searchable strings.

Search operations will start with this entry.

Implemented in SvTreeListBox, and ImplListBoxWindow.

Referenced by vcl::findMatchingEntry().

◆ NextEntry()

virtual StringEntryIdentifier vcl::ISearchableStringList::NextEntry ( StringEntryIdentifier  _currentEntry,
OUString &  _out_entryText 
) const
pure virtual

returns the next entry in the list.

The implementation is expected to wrap around. That is, if the given entry denotes the last entry in the list, then NextEntry should return the first entry.

Implemented in SvTreeListBox, and ImplListBoxWindow.

Referenced by vcl::findMatchingEntry().

◆ SelectEntry()

virtual void vcl::ISearchableStringList::SelectEntry ( StringEntryIdentifier  _entry)
pure virtual

selects a given entry

Implemented in SvTreeListBox, and ImplListBoxWindow.


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