LibreOffice Module vcl (master)  1
mnemonicengine.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_VCL_MNEMONICENGINE_HXX
21 #define INCLUDED_VCL_MNEMONICENGINE_HXX
22 
23 #include <vcl/dllapi.h>
24 
25 #include <sal/config.h>
26 #include <sal/types.h>
27 #include <rtl/ustring.hxx>
28 
29 #include <memory>
30 
31 class KeyEvent;
32 
33 
34 namespace vcl
35 {
36 
37 
38  //= IMnemonicEntryList
39 
42  {
43  public:
53  virtual const void* FirstSearchEntry( OUString& _rEntryText ) const = 0;
54 
68  virtual const void* NextSearchEntry( const void* _pCurrentSearchEntry, OUString& _rEntryText ) const = 0;
69 
81  virtual void SelectSearchEntry( const void* _pEntry ) = 0;
82 
111  virtual void ExecuteSearchEntry( const void* _pEntry ) const = 0;
112 
113  protected:
115  };
116 
117 
118  //= MnemonicEngine
119 
120  struct MnemonicEngine_Data;
122  {
123  ::std::unique_ptr< MnemonicEngine_Data > m_pData;
124 
125  public:
126  MnemonicEngine( IMnemonicEntryList& _rEntryList );
127  ~MnemonicEngine();
128 
144  bool HandleKeyEvent( const KeyEvent& _rKEvt );
145  };
146 
147 
148 } // namespace vcl
149 
150 
151 #endif // INCLUDED_VCL_MNEMONICENGINE_HXX
152 
153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
callback for a MnemonicEngine
::std::unique_ptr< MnemonicEngine_Data > m_pData
#define SAL_NO_VTABLE