LibreOffice Module vcl (master) 1
mnemonic.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_MNEMONIC_HXX
21#define INCLUDED_VCL_MNEMONIC_HXX
22
23#include <com/sun/star/uno/Reference.h>
24#include <rtl/ustring.hxx>
25#include <vcl/dllapi.h>
26
27namespace com::sun::star::i18n { class XCharacterClassification; }
28
29// Mnemonic Chars, which we want support
30// Latin 0-9
31#define MNEMONIC_RANGE_1_START 0x30
32#define MNEMONIC_RANGE_1_END 0x39
33// Latin a-z
34#define MNEMONIC_RANGE_2_START 0x61
35#define MNEMONIC_RANGE_2_END 0x7A
36// Cyrillic
37#define MNEMONIC_RANGE_3_START 0x0430
38#define MNEMONIC_RANGE_3_END 0x044F
39// Greek
40#define MNEMONIC_RANGE_4_START 0x03B1
41#define MNEMONIC_RANGE_4_END 0x03CB
42#define MNEMONIC_RANGES 4
43#define MAX_MNEMONICS ((MNEMONIC_RANGE_1_END-MNEMONIC_RANGE_1_START+1)+\
44 (MNEMONIC_RANGE_2_END-MNEMONIC_RANGE_2_START+1)+\
45 (MNEMONIC_RANGE_3_END-MNEMONIC_RANGE_3_START+1)+\
46 (MNEMONIC_RANGE_4_END-MNEMONIC_RANGE_4_START+1))
47
48#define MNEMONIC_CHAR u'~'
49#define MNEMONIC_INDEX_NOTFOUND (sal_uInt16(0xFFFF))
50
51VCL_DLLPUBLIC OUString removeMnemonicFromString(OUString const& rStr, sal_Int32& rMnemonicPos);
52VCL_DLLPUBLIC OUString removeMnemonicFromString(OUString const& rStr);
53
55{
57 // 0 == Mnemonic; >0 == count of characters
59 css::uno::Reference< css::i18n::XCharacterClassification > mxCharClass;
60
61 SAL_DLLPRIVATE static sal_uInt16 ImplGetMnemonicIndex( sal_Unicode c );
62 SAL_DLLPRIVATE sal_Unicode ImplFindMnemonic( const OUString& rKey );
63
64public:
66
67 void RegisterMnemonic( const OUString& rKey );
68 [[nodiscard]] OUString CreateMnemonic(const OUString& rKey);
69 css::uno::Reference< css::i18n::XCharacterClassification > const & GetCharClass();
70
71 // returns a string where all '~'-characters and CJK mnemonics of the form (~A) are completely removed
72 static OUString EraseAllMnemonicChars( const OUString& rStr );
73};
74
75#endif // INCLUDED_VCL_MNEMONIC_HXX
76
77/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sal_Unicode m_cMnemonic
Definition: mnemonic.hxx:56
css::uno::Reference< css::i18n::XCharacterClassification > mxCharClass
Definition: mnemonic.hxx:59
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
#define MAX_MNEMONICS
Definition: mnemonic.hxx:43
#define MNEMONIC_CHAR
Definition: mnemonic.hxx:48
VCL_DLLPUBLIC OUString removeMnemonicFromString(OUString const &rStr, sal_Int32 &rMnemonicPos)
unsigned char sal_uInt8
sal_uInt16 sal_Unicode