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

callback for a MnemonicEngine More...

#include <mnemonicengine.hxx>

Inheritance diagram for vcl::IMnemonicEntryList:
[legend]

Public Member Functions

virtual const voidFirstSearchEntry (OUString &_rEntryText) const =0
 returns the first list entry for the mnemonic search More...
 
virtual const voidNextSearchEntry (const void *_pCurrentSearchEntry, OUString &_rEntryText) const =0
 returns the next list entry for the mnemonic search More...
 
virtual void SelectSearchEntry (const void *_pEntry)=0
 "selects" a given entry. More...
 
virtual void ExecuteSearchEntry (const void *_pEntry) const =0
 "executes" the current search entry, i.e. More...
 

Protected Member Functions

 ~IMnemonicEntryList ()
 

Detailed Description

callback for a MnemonicEngine

Definition at line 41 of file mnemonicengine.hxx.

Constructor & Destructor Documentation

vcl::IMnemonicEntryList::~IMnemonicEntryList ( )
inlineprotected

Definition at line 114 of file mnemonicengine.hxx.

Member Function Documentation

virtual void vcl::IMnemonicEntryList::ExecuteSearchEntry ( const void _pEntry) const
pure virtual

"executes" the current search entry, i.e.

the one returned in the previous NextSearchEntry call.

Note: The semantics of "execute" depends on your implementation. You might even have a list of entries which cannot be executed at all.

This method is called after SelectSearchEntry, if and only if the current entry's mnemonic is unambiguous.

For instance, imagine a list which has two entries with the same mnemonic character, say "c". Now if the user presses Alt-C, the MnemonicEngine will call SelectCurrentEntry as soon as it encounters the first entry, but it'll never call ExecuteSearchEntry.

If, however, "c" is a unique mnemonic character in your entry list, then the call of SelectSearchEntry will be followed by a call to ExecuteSearchEntry.

This way, you can implement cyclic selection of entries: In FirstSearchEntry, return the entry which was previously selected, and in NextSearchEntry, internally cycle around in your list. Then, multiple user inputs of Alt-C will cycle through all entries with the mnemonic being "c".

Parameters
_pEntrythe entry to select. This is the return value of a previous call to FirstSearchEntry or NextSearchEntry.

Implemented in SvTreeListBox.

virtual const void* vcl::IMnemonicEntryList::FirstSearchEntry ( OUString &  _rEntryText) const
pure virtual

returns the first list entry for the mnemonic search

Returns
a pointer which can be used to unuquely identify the entry. The MenomonicEngine itself does not use this value, it is only passed to other methods of this callback interface.

If this value is NULL, searching stops.

Implemented in SvTreeListBox.

virtual const void* vcl::IMnemonicEntryList::NextSearchEntry ( const void _pCurrentSearchEntry,
OUString &  _rEntryText 
) const
pure virtual

returns the next list entry for the mnemonic search

Returns
a pointer which can be used to unuquely identify the entry. The MenomonicEngine itself does not use this value, it is only passed to other methods of this callback interface.

If this value is NULL, searching stops.

If this value is the same as returned by the previous call to FirstSearchEntry (i.e. you cycled around), then searching stops, too.

Implemented in SvTreeListBox.

virtual void vcl::IMnemonicEntryList::SelectSearchEntry ( const void _pEntry)
pure virtual

"selects" a given entry.

Note: The semantics of "select" depends on your implementation. You might actually really select the entry (in the sense of a selected list box entry, for example), you might make it the current entry, if your implementation supports this - whatever.

Parameters
_pEntrythe entry to select. This is the return value of a previous call to FirstSearchEntry or NextSearchEntry.

Implemented in SvTreeListBox.


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