LibreOffice Module vcl (master) 1
keycod.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_KEYCOD_HXX
21#define INCLUDED_VCL_KEYCOD_HXX
22
23#include <rtl/ustring.hxx>
24#include <vcl/dllapi.h>
25#include <vcl/keycodes.hxx>
26
27enum class KeyFuncType : sal_Int32 { DONTKNOW,
28 CUT, COPY, PASTE, UNDO,
29 REDO, DELETE };
30
31namespace vcl
32{
33
35{
36private:
39
40public:
41 KeyCode() { nKeyCodeAndModifiers = 0; eFunc = KeyFuncType::DONTKNOW; }
42 KeyCode( sal_uInt16 nKey, sal_uInt16 nModifier = 0 );
43 KeyCode( sal_uInt16 nKey, bool bShift, bool bMod1, bool bMod2, bool bMod3 );
44 KeyCode( KeyFuncType eFunction );
45
46 sal_uInt16 GetFullCode() const { return nKeyCodeAndModifiers; }
47 KeyFuncType GetFullFunction() const { return eFunc; }
48
49 sal_uInt16 GetCode() const
50 { return (nKeyCodeAndModifiers & KEY_CODE_MASK); }
51
52 sal_uInt16 GetModifier() const
53 { return (nKeyCodeAndModifiers & KEY_MODIFIERS_MASK); }
54 bool IsShift() const
55 { return ((nKeyCodeAndModifiers & KEY_SHIFT) != 0); }
56 bool IsMod1() const
57 { return ((nKeyCodeAndModifiers & KEY_MOD1) != 0); }
58 bool IsMod2() const
59 { return ((nKeyCodeAndModifiers & KEY_MOD2) != 0); }
60 bool IsMod3() const
61 { return ((nKeyCodeAndModifiers & KEY_MOD3) != 0); }
62 sal_uInt16 GetGroup() const
63 { return (nKeyCodeAndModifiers & KEYGROUP_TYPE); }
64
65 OUString GetName() const;
66
67 bool IsFunction() const
68 { return (eFunc != KeyFuncType::DONTKNOW); }
69
70 KeyFuncType GetFunction() const;
71
72 bool operator ==( const KeyCode& rKeyCode ) const;
73 bool operator !=( const KeyCode& rKeyCode ) const;
74};
75
76} // namespace vcl
77
78inline vcl::KeyCode::KeyCode( sal_uInt16 nKey, sal_uInt16 nModifier )
79{
80 nKeyCodeAndModifiers = nKey | nModifier;
82}
83
84inline vcl::KeyCode::KeyCode( sal_uInt16 nKey, bool bShift, bool bMod1, bool bMod2, bool bMod3 )
85{
86 nKeyCodeAndModifiers = nKey;
87 if( bShift )
88 nKeyCodeAndModifiers |= KEY_SHIFT;
89 if( bMod1 )
90 nKeyCodeAndModifiers |= KEY_MOD1;
91 if( bMod2 )
92 nKeyCodeAndModifiers |= KEY_MOD2;
93 if( bMod3 )
94 nKeyCodeAndModifiers |= KEY_MOD3;
96}
97
98inline bool vcl::KeyCode::operator ==( const vcl::KeyCode& rKeyCode ) const
99{
100 if ( (eFunc == KeyFuncType::DONTKNOW) && (rKeyCode.eFunc == KeyFuncType::DONTKNOW) )
101 return (nKeyCodeAndModifiers == rKeyCode.nKeyCodeAndModifiers);
102 else
103 return (GetFunction() == rKeyCode.GetFunction());
104}
105
106inline bool vcl::KeyCode::operator !=( const vcl::KeyCode& rKeyCode ) const
107{
108 if ( (eFunc == KeyFuncType::DONTKNOW) && (rKeyCode.eFunc == KeyFuncType::DONTKNOW) )
109 return (nKeyCodeAndModifiers != rKeyCode.nKeyCodeAndModifiers);
110 else
111 return (GetFunction() != rKeyCode.GetFunction());
112}
113
114#endif // INCLUDED_VCL_KEYCOD_HXX
115
116/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const short REDO
const short PASTE
const short COPY
const short CUT
const short UNDO
sal_uInt16 GetGroup() const
Definition: keycod.hxx:62
bool IsMod1() const
Definition: keycod.hxx:56
sal_uInt16 GetCode() const
Definition: keycod.hxx:49
sal_uInt16 GetModifier() const
Definition: keycod.hxx:52
KeyFuncType GetFullFunction() const
Definition: keycod.hxx:47
sal_uInt16 nKeyCodeAndModifiers
Definition: keycod.hxx:37
bool operator!=(const KeyCode &rKeyCode) const
Definition: keycod.hxx:106
bool IsFunction() const
Definition: keycod.hxx:67
KeyFuncType GetFunction() const
Definition: keycod.cxx:72
bool IsShift() const
Definition: keycod.hxx:54
bool operator==(const KeyCode &rKeyCode) const
Definition: keycod.hxx:98
bool IsMod2() const
Definition: keycod.hxx:58
bool IsMod3() const
Definition: keycod.hxx:60
KeyFuncType eFunc
Definition: keycod.hxx:38
sal_uInt16 GetFullCode() const
Definition: keycod.hxx:46
virtual OUString GetName() const override
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
KeyFuncType
Definition: keycod.hxx:27
constexpr sal_uInt16 KEY_MOD2
Definition: keycodes.hxx:32
constexpr sal_uInt16 KEY_MOD1
Definition: keycodes.hxx:31
constexpr sal_uInt16 KEY_CODE_MASK
Definition: keycodes.hxx:27
constexpr sal_uInt16 KEY_MODIFIERS_MASK
Definition: keycodes.hxx:34
constexpr sal_uInt16 KEY_MOD3
Definition: keycodes.hxx:33
constexpr sal_uInt16 KEYGROUP_TYPE
Definition: keycodes.hxx:42
constexpr sal_uInt16 KEY_SHIFT
Definition: keycodes.hxx:30
bool operator==(const ItalicMatrix &a, const ItalicMatrix &b)
Definition: vclenum.hxx:182
bool operator!=(const ItalicMatrix &a, const ItalicMatrix &b)
Definition: vclenum.hxx:187