1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef VCL_MNEMONICENGINE_HXX
#define VCL_MNEMONICENGINE_HXX
#include "dllapi.h"
#include <sal/config.h>
#include <sal/types.h>
#include <memory>
class String;
class KeyEvent;
//........................................................................
namespace vcl
{
//........................................................................
//====================================================================
//= IMnemonicEntryList
//====================================================================
/// callback for a MnemonicEngine
class SAL_NO_VTABLE VCL_DLLPUBLIC IMnemonicEntryList
{
public:
/** returns the first list entry for the mnemonic search
@return
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.
*/
virtual const void* FirstSearchEntry( String& _rEntryText ) const = 0;
/** returns the next list entry for the mnemonic search
@return
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 <member>FirstSearchEntry</member> (i.e. you cycled
around), then searching stops, too.
*/
virtual const void* NextSearchEntry( const void* _pCurrentSearchEntry, String& _rEntryText ) const = 0;
/** "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.
@param _pEntry
the entry to select. This is the return value of a previous call
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 <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 <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 <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 <member>SelectSearchEntry</member> will be followed by a
call to <member>ExecuteSearchEntry</member>.
This way, you can implement cyclic selection of entries: In
<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 <member>FirstSearchEntry</member> or <member>NextSearchEntry</member>.
*/
virtual void ExecuteSearchEntry( const void* _pEntry ) const = 0;
protected:
~IMnemonicEntryList() {}
};
//====================================================================
//= MnemonicEngine
//====================================================================
struct MnemonicEngine_Data;
class VCL_DLLPUBLIC MnemonicEngine
{
::std::auto_ptr< MnemonicEngine_Data > m_pData;
public:
MnemonicEngine( IMnemonicEntryList& _rEntryList );
~MnemonicEngine();
/** handles a key event
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, <member>IMnemonicEntryList::SelectSearchEntry</member>
is called.
If the entry is the only one with the given mnemonic character, then
also <member>IMnemonicEntryList::ExecuteSearchEntry</member>
is called.
@return
if the key event has been handled, and should thus not be processed
further.
*/
bool HandleKeyEvent( const KeyEvent& _rKEvt );
};
//........................................................................
} // namespace vcl
//........................................................................
#endif // VCL_MNEMONICENGINE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
