blob: 5e6bc122e828e15ce17fb68802395e0ae138bbd9 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef _SV_MNEMONIC_HXX
#define _SV_MNEMONIC_HXX
#include <vcl/dllapi.h>
#include <tools/string.hxx>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/i18n/XCharacterClassification.hpp>
// ---------------------
// - ImplMnemonicTypes -
// ---------------------
// Mnemonic Chars, which we want support
// Latin 0-9
#define MNEMONIC_RANGE_1_START 0x30
#define MNEMONIC_RANGE_1_END 0x39
// Latin A-Z
#define MNEMONIC_RANGE_2_START 0x41
#define MNEMONIC_RANGE_2_END 0x5A
// Cyrillic
#define MNEMONIC_RANGE_3_START 0x0410
#define MNEMONIC_RANGE_3_END 0x042F
// Greek
#define MNEMONIC_RANGE_4_START 0x0391
#define MNEMONIC_RANGE_4_END 0x03AB
#define MNEMONIC_RANGES 4
#define MAX_MNEMONICS ((MNEMONIC_RANGE_1_END-MNEMONIC_RANGE_1_START+1)+\
(MNEMONIC_RANGE_2_END-MNEMONIC_RANGE_2_START+1)+\
(MNEMONIC_RANGE_3_END-MNEMONIC_RANGE_3_START+1)+\
(MNEMONIC_RANGE_4_END-MNEMONIC_RANGE_4_START+1))
#define MNEMONIC_CHAR ((sal_Unicode)'~')
#define MNEMONIC_INDEX_NOTFOUND ((sal_uInt16)0xFFFF)
// -------------------------
// - MnemonicGenerator -
// -------------------------
class VCL_DLLPUBLIC MnemonicGenerator
{
private:
// 0 == Mnemonic; >0 == count of characters
sal_uInt8 maMnemonics[MAX_MNEMONICS];
::com::sun::star::uno::Reference< ::com::sun::star::i18n::XCharacterClassification > mxCharClass;
protected:
SAL_DLLPRIVATE sal_uInt16 ImplGetMnemonicIndex( sal_Unicode c );
SAL_DLLPRIVATE sal_Unicode ImplFindMnemonic( const XubString& rKey );
public:
MnemonicGenerator();
void RegisterMnemonic( const XubString& rKey );
sal_Bool CreateMnemonic( XubString& rKey );
::com::sun::star::uno::Reference< ::com::sun::star::i18n::XCharacterClassification > GetCharClass();
// returns a string where all '~'-characters and CJK mnemonics of the form (~A) are completely removed
static String EraseAllMnemonicChars( const String& rStr );
};
#endif // _SV_MNEMONIC_HXX