summaryrefslogtreecommitdiff
path: root/include/vcl/mnemonicengine.hxx
diff options
context:
space:
mode:
authorCaolán McNamara <caolanm@redhat.com>2014-02-04 16:13:21 +0000
committerCaolán McNamara <caolanm@redhat.com>2014-02-04 16:14:08 +0000
commit2b76184892ddaeebaf8603f62c54dee17922f274 (patch)
tree7ead69b8f130309eccf65e623d0e64a2d8ab658c /include/vcl/mnemonicengine.hxx
parent79ab9d7b6ede19bc494770bba6cc59bd4618d5ae (diff)
Revert "Doxygen warnings corrected"
This reverts commit ff8036df5c5575503dc30d255dfbe99cc637c510. multiple build failures with namespace collisions etc Change-Id: Ie8ac08feff518af3584a26957f07a60d95932c76 Reviewed-on: https://gerrit.libreoffice.org/7855 Reviewed-by: Caolán McNamara <caolanm@redhat.com> Tested-by: Caolán McNamara <caolanm@redhat.com>
Diffstat (limited to 'include/vcl/mnemonicengine.hxx')
-rw-r--r--include/vcl/mnemonicengine.hxx30
1 files changed, 15 insertions, 15 deletions
diff --git a/include/vcl/mnemonicengine.hxx b/include/vcl/mnemonicengine.hxx
index e07298da53ed..64de438bce36 100644
--- a/include/vcl/mnemonicengine.hxx
+++ b/include/vcl/mnemonicengine.hxx
@@ -49,7 +49,7 @@ namespace vcl
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 <NULL/>, searching stops.
*/
virtual const void* FirstSearchEntry( OUString& _rEntryText ) const = 0;
@@ -60,10 +60,10 @@ namespace vcl
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 <NULL/>, searching stops.
If this value is the same as returned by the previous call
- to FirstSearchEntry (i.e. you cycled
+ to <member>FirstSearchEntry</member> (i.e. you cycled
around), then searching stops, too.
*/
virtual const void* NextSearchEntry( const void* _pCurrentSearchEntry, OUString& _rEntryText ) const = 0;
@@ -77,37 +77,37 @@ namespace vcl
@param _pEntry
the entry to select. This is the return value of a previous call
- to FirstSearchEntry or NextSearchEntry.
+ to <member>FirstSearchEntry</member> or <member>NextSearchEntry</member>.
*/
virtual void SelectSearchEntry( const void* _pEntry ) = 0;
/** "executes" the current search entry, i.e. the one returned
- in the previous NextSearchEntry call.
+ in the previous <member>NextSearchEntry</member> 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,
+ This method is called after <member>SelectSearchEntry</member>,
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 <code>Alt-C</code>, the MnemonicEngine
- will call SelectCurrentEntry as soon as it encounters
- the first entry, but it'll never call ExecuteSearchEntry.
+ will call <member>SelectCurrentEntry</member> as soon as it encounters
+ the first entry, but it'll never call <member>ExecuteSearchEntry</member>.
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.
+ call of <member>SelectSearchEntry</member> will be followed by a
+ call to <member>ExecuteSearchEntry</member>.
This way, you can implement cyclic selection of entries: In
- FirstSearchEntry, return the entry which was previously
- selected, and in NextSearchEntry, interlly cycle around
+ <member>FirstSearchEntry</member>, return the entry which was previously
+ selected, and in <member>NextSearchEntry</member>, interlly cycle around
in your list. Then, multiple user inputs of <code>Alt-C</code> will
cycle through all entries with the mnemonic being "c".
@param _pEntry
the entry to select. This is the return value of a previous call
- to FirstSearchEntry or NextSearchEntry.
+ to <member>FirstSearchEntry</member> or <member>NextSearchEntry</member>.
*/
virtual void ExecuteSearchEntry( const void* _pEntry ) const = 0;
@@ -131,11 +131,11 @@ namespace vcl
If the key event denotes pressing an accelerator key, then the
entry list is searched for a matching entry. If such an entry is
- found, IMnemonicEntryList::SelectSearchEntry
+ found, <member>IMnemonicEntryList::SelectSearchEntry</member>
is called.
If the entry is the only one with the given mnemonic character, then
- also IMnemonicEntryList::ExecuteSearchEntry
+ also <member>IMnemonicEntryList::ExecuteSearchEntry</member>
is called.
@return