Line data Source code
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_CMDEVT_HXX
21 : #define INCLUDED_VCL_CMDEVT_HXX
22 :
23 : #include <tools/gen.hxx>
24 : #include <tools/solar.h>
25 : #include <vcl/dllapi.h>
26 : #include <vcl/keycod.hxx>
27 : #include <vcl/font.hxx>
28 :
29 :
30 : // - CommandExtTextInputData -
31 :
32 :
33 : #define EXTTEXTINPUT_ATTR_GRAYWAVELINE ((sal_uInt16)0x0100)
34 : #define EXTTEXTINPUT_ATTR_UNDERLINE ((sal_uInt16)0x0200)
35 : #define EXTTEXTINPUT_ATTR_BOLDUNDERLINE ((sal_uInt16)0x0400)
36 : #define EXTTEXTINPUT_ATTR_DOTTEDUNDERLINE ((sal_uInt16)0x0800)
37 : #define EXTTEXTINPUT_ATTR_DASHDOTUNDERLINE ((sal_uInt16)0x1000)
38 : #define EXTTEXTINPUT_ATTR_HIGHLIGHT ((sal_uInt16)0x2000)
39 : #define EXTTEXTINPUT_ATTR_REDTEXT ((sal_uInt16)0x4000)
40 : #define EXTTEXTINPUT_ATTR_HALFTONETEXT ((sal_uInt16)0x8000)
41 :
42 : #define EXTTEXTINPUT_CURSOR_INVISIBLE ((sal_uInt16)0x0001)
43 : #define EXTTEXTINPUT_CURSOR_OVERWRITE ((sal_uInt16)0x0002)
44 :
45 : class VCL_DLLPUBLIC CommandExtTextInputData
46 : {
47 : private:
48 : OUString maText;
49 : sal_uInt16* mpTextAttr;
50 : sal_Int32 mnCursorPos;
51 : sal_uInt16 mnCursorFlags;
52 : bool mbOnlyCursor;
53 :
54 : public:
55 : CommandExtTextInputData( const OUString& rText,
56 : const sal_uInt16* pTextAttr,
57 : sal_Int32 nCursorPos,
58 : sal_uInt16 nCursorFlags,
59 : bool bOnlyCursor );
60 : CommandExtTextInputData( const CommandExtTextInputData& rData );
61 : ~CommandExtTextInputData();
62 :
63 0 : const OUString& GetText() const { return maText; }
64 0 : const sal_uInt16* GetTextAttr() const { return mpTextAttr; }
65 : sal_uInt16 GetCharTextAttr(sal_Int32 nIndex) const
66 : {
67 : assert(nIndex >= 0);
68 : if (mpTextAttr && nIndex < maText.getLength() && nIndex >=0)
69 : return mpTextAttr[nIndex];
70 : else
71 : return 0;
72 : }
73 :
74 0 : sal_Int32 GetCursorPos() const { return mnCursorPos; }
75 0 : bool IsCursorVisible() const { return (mnCursorFlags & EXTTEXTINPUT_CURSOR_INVISIBLE) == 0; }
76 0 : bool IsCursorOverwrite() const { return (mnCursorFlags & EXTTEXTINPUT_CURSOR_OVERWRITE) != 0; }
77 : sal_uInt16 GetCursorFlags() const { return mnCursorFlags; }
78 0 : bool IsOnlyCursorChanged() const { return mbOnlyCursor; }
79 : };
80 :
81 :
82 : // - CommandInputContextData -
83 :
84 :
85 : class VCL_DLLPUBLIC CommandInputContextData
86 : {
87 : private:
88 : LanguageType meLanguage;
89 :
90 : public:
91 : CommandInputContextData();
92 : CommandInputContextData( LanguageType eLang );
93 :
94 : LanguageType GetLanguage() const { return meLanguage; }
95 : };
96 :
97 : inline CommandInputContextData::CommandInputContextData()
98 : {
99 : meLanguage = LANGUAGE_DONTKNOW;
100 : }
101 :
102 0 : inline CommandInputContextData::CommandInputContextData( LanguageType eLang )
103 : {
104 0 : meLanguage = eLang;
105 0 : }
106 :
107 :
108 : // - CommandWheelData -
109 :
110 :
111 : enum class CommandWheelMode
112 : {
113 : NONE = 0,
114 : SCROLL = 1,
115 : ZOOM = 2,
116 : ZOOM_SCALE = 3,
117 : DATAZOOM = 4
118 : };
119 :
120 : // Magic value used in mnLines field in CommandWheelData
121 : #define COMMAND_WHEEL_PAGESCROLL ((sal_uLong)0xFFFFFFFF)
122 :
123 : class VCL_DLLPUBLIC CommandWheelData
124 : {
125 : private:
126 : long mnDelta;
127 : long mnNotchDelta;
128 : sal_uLong mnLines;
129 : CommandWheelMode mnWheelMode;
130 : sal_uInt16 mnCode;
131 : bool mbHorz;
132 : bool mbDeltaIsPixel;
133 :
134 : public:
135 : CommandWheelData();
136 : CommandWheelData( long nWheelDelta, long nWheelNotchDelta,
137 : sal_uLong nScrollLines,
138 : CommandWheelMode nWheelMode, sal_uInt16 nKeyModifier,
139 : bool bHorz = false, bool bDeltaIsPixel = false );
140 :
141 0 : long GetDelta() const { return mnDelta; }
142 0 : long GetNotchDelta() const { return mnNotchDelta; }
143 0 : sal_uLong GetScrollLines() const { return mnLines; }
144 0 : bool IsHorz() const { return mbHorz; }
145 0 : bool IsDeltaPixel() const { return mbDeltaIsPixel; }
146 :
147 0 : CommandWheelMode GetMode() const { return mnWheelMode; }
148 :
149 0 : sal_uInt16 GetModifier() const
150 0 : { return (mnCode & (KEY_SHIFT | KEY_MOD1 | KEY_MOD2)); }
151 0 : bool IsShift() const
152 0 : { return ((mnCode & KEY_SHIFT) != 0); }
153 0 : bool IsMod1() const
154 0 : { return ((mnCode & KEY_MOD1) != 0); }
155 0 : bool IsMod2() const
156 0 : { return ((mnCode & KEY_MOD2) != 0); }
157 : bool IsMod3() const
158 : { return ((mnCode & KEY_MOD3) != 0); }
159 : };
160 :
161 : inline CommandWheelData::CommandWheelData()
162 : {
163 : mnDelta = 0;
164 : mnNotchDelta = 0;
165 : mnLines = 0;
166 : mnWheelMode = CommandWheelMode::NONE;
167 : mnCode = 0;
168 : mbHorz = false;
169 : mbDeltaIsPixel = false;
170 : }
171 :
172 0 : inline CommandWheelData::CommandWheelData( long nWheelDelta, long nWheelNotchDelta,
173 : sal_uLong nScrollLines,
174 : CommandWheelMode nWheelMode, sal_uInt16 nKeyModifier,
175 : bool bHorz, bool bDeltaIsPixel )
176 : {
177 0 : mnDelta = nWheelDelta;
178 0 : mnNotchDelta = nWheelNotchDelta;
179 0 : mnLines = nScrollLines;
180 0 : mnWheelMode = nWheelMode;
181 0 : mnCode = nKeyModifier;
182 0 : mbHorz = bHorz;
183 0 : mbDeltaIsPixel = bDeltaIsPixel;
184 0 : }
185 :
186 :
187 : // - CommandScrollData -
188 :
189 :
190 : class VCL_DLLPUBLIC CommandScrollData
191 : {
192 : private:
193 : long mnDeltaX;
194 : long mnDeltaY;
195 :
196 : public:
197 : CommandScrollData();
198 : CommandScrollData( long nDeltaX, long nDeltaY );
199 :
200 0 : long GetDeltaX() const { return mnDeltaX; }
201 0 : long GetDeltaY() const { return mnDeltaY; }
202 : };
203 :
204 0 : inline CommandScrollData::CommandScrollData()
205 : {
206 0 : mnDeltaX = 0;
207 0 : mnDeltaY = 0;
208 0 : }
209 :
210 0 : inline CommandScrollData::CommandScrollData( long nDeltaX, long nDeltaY )
211 : {
212 0 : mnDeltaX = nDeltaX;
213 0 : mnDeltaY = nDeltaY;
214 0 : }
215 :
216 :
217 : // - CommandModKeyData -
218 :
219 :
220 : class VCL_DLLPUBLIC CommandModKeyData
221 : {
222 : private:
223 : sal_uInt16 mnCode;
224 :
225 : public:
226 : CommandModKeyData();
227 : CommandModKeyData( sal_uInt16 nCode );
228 :
229 : bool IsShift() const { return (mnCode & MODKEY_SHIFT) != 0; }
230 0 : bool IsMod1() const { return (mnCode & MODKEY_MOD1) != 0; }
231 0 : bool IsMod2() const { return (mnCode & MODKEY_MOD2) != 0; }
232 : bool IsMod3() const { return (mnCode & MODKEY_MOD3) != 0; }
233 :
234 0 : bool IsLeftShift() const { return (mnCode & MODKEY_LSHIFT) != 0; }
235 : bool IsLeftMod1() const { return (mnCode & MODKEY_LMOD1) != 0; }
236 : bool IsLeftMod2() const { return (mnCode & MODKEY_LMOD2) != 0; }
237 : bool IsLeftMod3() const { return (mnCode & MODKEY_LMOD3) != 0; }
238 :
239 0 : bool IsRightShift() const { return (mnCode & MODKEY_RSHIFT) != 0; }
240 : bool IsRightMod1() const { return (mnCode & MODKEY_RMOD1) != 0; }
241 : bool IsRightMod2() const { return (mnCode & MODKEY_RMOD2) != 0; }
242 : bool IsRightMod3() const { return (mnCode & MODKEY_RMOD3) != 0; }
243 : };
244 :
245 : inline CommandModKeyData::CommandModKeyData()
246 : {
247 : mnCode = 0L;
248 : }
249 :
250 0 : inline CommandModKeyData::CommandModKeyData( sal_uInt16 nCode )
251 : {
252 0 : mnCode = nCode;
253 0 : }
254 :
255 :
256 : // - CommanDialogData -
257 :
258 :
259 : #define SHOWDIALOG_ID_PREFERENCES 1
260 : #define SHOWDIALOG_ID_ABOUT 2
261 :
262 : class VCL_DLLPUBLIC CommandDialogData
263 : {
264 : int m_nDialogId;
265 : public:
266 0 : CommandDialogData( int nDialogId = SHOWDIALOG_ID_PREFERENCES )
267 0 : : m_nDialogId( nDialogId )
268 0 : {}
269 :
270 0 : int GetDialogId() const { return m_nDialogId; }
271 : };
272 :
273 :
274 : // Media Commands
275 :
276 :
277 : #define MEDIA_COMMAND_CHANNEL_DOWN ((sal_Int16)1) // Decrement the channel value, for example, for a TV or radio tuner.
278 : #define MEDIA_COMMAND_CHANNEL_UP ((sal_Int16)2) // Increment the channel value, for example, for a TV or radio tuner.
279 : #define MEDIA_COMMAND_NEXTTRACK ((sal_Int16)3) // Go to next media track/slide.
280 : #define MEDIA_COMMAND_PAUSE ((sal_Int16)4) // Pause. If already paused, take no further action. This is a direct PAUSE command that has no state.
281 : #define MEDIA_COMMAND_PLAY ((sal_Int16)5) // Begin playing at the current position. If already paused, it will resume. This is a direct PLAY command that has no state.
282 : #define MEDIA_COMMAND_PLAY_PAUSE ((sal_Int16)6) // Play or pause playback.
283 : #define MEDIA_COMMAND_PREVIOUSTRACK ((sal_Int16)7) // Go to previous media track/slide.
284 : #define MEDIA_COMMAND_RECORD ((sal_Int16)8) // Begin recording the current stream.
285 : #define MEDIA_COMMAND_REWIND ((sal_Int16)9)// Go backward in a stream at a higher rate of speed.
286 : #define MEDIA_COMMAND_STOP ((sal_Int16)10)// Stop playback.
287 : #define MEDIA_COMMAND_MIC_ON_OFF_TOGGLE ((sal_Int16)11)// Toggle the microphone.
288 : #define MEDIA_COMMAND_MICROPHONE_VOLUME_DOWN ((sal_Int16)12)// Increase microphone volume.
289 : #define MEDIA_COMMAND_MICROPHONE_VOLUME_MUTE ((sal_Int16)13)// Mute the microphone.
290 : #define MEDIA_COMMAND_MICROPHONE_VOLUME_UP ((sal_Int16)14)// Decrease microphone volume.
291 : #define MEDIA_COMMAND_VOLUME_DOWN ((sal_Int16)15)// Lower the volume.
292 : #define MEDIA_COMMAND_VOLUME_MUTE ((sal_Int16)16)// Mute the volume.
293 : #define MEDIA_COMMAND_VOLUME_UP ((sal_Int16)17)// Raise the volume.
294 : #define MEDIA_COMMAND_MENU ((sal_Int16)18)// Button Menu pressed.
295 : #define MEDIA_COMMAND_MENU_HOLD ((sal_Int16)19)// Button Menu (long) pressed.
296 : #define MEDIA_COMMAND_PLAY_HOLD ((sal_Int16)20)// Button Play (long) pressed.
297 : #define MEDIA_COMMAND_NEXTTRACK_HOLD ((sal_Int16)21)// Button Right holding pressed.
298 : #define MEDIA_COMMAND_PREVIOUSTRACK_HOLD ((sal_Int16)22)// Button Left holding pressed.
299 :
300 :
301 :
302 : // - CommandSelectionChangeData -
303 :
304 :
305 : class VCL_DLLPUBLIC CommandSelectionChangeData
306 : {
307 : private:
308 : sal_uLong mnStart;
309 : sal_uLong mnEnd;
310 :
311 : public:
312 : CommandSelectionChangeData();
313 : CommandSelectionChangeData( sal_uLong nStart, sal_uLong nEnd );
314 :
315 0 : sal_uLong GetStart() const { return mnStart; }
316 0 : sal_uLong GetEnd() const { return mnEnd; }
317 : };
318 :
319 : inline CommandSelectionChangeData::CommandSelectionChangeData()
320 : {
321 : mnStart = mnEnd = 0;
322 : }
323 :
324 0 : inline CommandSelectionChangeData::CommandSelectionChangeData( sal_uLong nStart,
325 : sal_uLong nEnd )
326 : {
327 0 : mnStart = nStart;
328 0 : mnEnd = nEnd;
329 0 : }
330 :
331 :
332 : // - CommandEvent -
333 :
334 :
335 : #define COMMAND_CONTEXTMENU ((sal_uInt16)1)
336 : #define COMMAND_STARTDRAG ((sal_uInt16)2)
337 : #define COMMAND_WHEEL ((sal_uInt16)3)
338 : #define COMMAND_STARTAUTOSCROLL ((sal_uInt16)4)
339 : #define COMMAND_AUTOSCROLL ((sal_uInt16)5)
340 : #define COMMAND_STARTEXTTEXTINPUT ((sal_uInt16)7)
341 : #define COMMAND_EXTTEXTINPUT ((sal_uInt16)8)
342 : #define COMMAND_ENDEXTTEXTINPUT ((sal_uInt16)9)
343 : #define COMMAND_INPUTCONTEXTCHANGE ((sal_uInt16)10)
344 : #define COMMAND_CURSORPOS ((sal_uInt16)11)
345 : #define COMMAND_PASTESELECTION ((sal_uInt16)12)
346 : #define COMMAND_MODKEYCHANGE ((sal_uInt16)13)
347 : #define COMMAND_HANGUL_HANJA_CONVERSION ((sal_uInt16)14)
348 : #define COMMAND_INPUTLANGUAGECHANGE ((sal_uInt16)15)
349 : #define COMMAND_SHOWDIALOG ((sal_uInt16)16)
350 : #define COMMAND_MEDIA ((sal_uInt16)17)
351 : #define COMMAND_SELECTIONCHANGE ((sal_uInt16)18)
352 : #define COMMAND_PREPARERECONVERSION ((sal_uInt16)19)
353 : #define COMMAND_QUERYCHARPOSITION ((sal_uInt16)20)
354 :
355 :
356 : class VCL_DLLPUBLIC CommandEvent
357 : {
358 : private:
359 : Point maPos;
360 : void* mpData;
361 : sal_uInt16 mnCommand;
362 : bool mbMouseEvent;
363 :
364 : public:
365 : CommandEvent();
366 : CommandEvent( const Point& rMousePos, sal_uInt16 nCmd,
367 : bool bMEvt = false, const void* pCmdData = NULL );
368 :
369 0 : sal_uInt16 GetCommand() const { return mnCommand; }
370 0 : const Point& GetMousePosPixel() const { return maPos; }
371 0 : bool IsMouseEvent() const { return mbMouseEvent; }
372 0 : void* GetData() const { return mpData; }
373 :
374 : const CommandExtTextInputData* GetExtTextInputData() const;
375 : const CommandInputContextData* GetInputContextChangeData() const;
376 : const CommandWheelData* GetWheelData() const;
377 : const CommandScrollData* GetAutoScrollData() const;
378 : const CommandModKeyData* GetModKeyData() const;
379 : const CommandDialogData* GetDialogData() const;
380 : sal_Int16 GetMediaCommand() const;
381 : const CommandSelectionChangeData* GetSelectionChangeData() const;
382 : };
383 :
384 0 : inline CommandEvent::CommandEvent()
385 : {
386 0 : mpData = NULL;
387 0 : mnCommand = 0;
388 0 : mbMouseEvent = false;
389 0 : }
390 :
391 0 : inline CommandEvent::CommandEvent( const Point& rMousePos,
392 : sal_uInt16 nCmd, bool bMEvt, const void* pCmdData ) :
393 0 : maPos( rMousePos )
394 : {
395 0 : mpData = (void*)pCmdData;
396 0 : mnCommand = nCmd;
397 0 : mbMouseEvent = bMEvt;
398 0 : }
399 :
400 0 : inline const CommandExtTextInputData* CommandEvent::GetExtTextInputData() const
401 : {
402 0 : if ( mnCommand == COMMAND_EXTTEXTINPUT )
403 0 : return (const CommandExtTextInputData*)mpData;
404 : else
405 0 : return NULL;
406 : }
407 :
408 : inline const CommandInputContextData* CommandEvent::GetInputContextChangeData() const
409 : {
410 : if ( mnCommand == COMMAND_INPUTCONTEXTCHANGE )
411 : return (const CommandInputContextData*)mpData;
412 : else
413 : return NULL;
414 : }
415 :
416 0 : inline const CommandWheelData* CommandEvent::GetWheelData() const
417 : {
418 0 : if ( mnCommand == COMMAND_WHEEL )
419 0 : return (const CommandWheelData*)mpData;
420 : else
421 0 : return NULL;
422 : }
423 :
424 0 : inline const CommandScrollData* CommandEvent::GetAutoScrollData() const
425 : {
426 0 : if ( mnCommand == COMMAND_AUTOSCROLL )
427 0 : return (const CommandScrollData*)mpData;
428 : else
429 0 : return NULL;
430 : }
431 :
432 : inline const CommandModKeyData* CommandEvent::GetModKeyData() const
433 : {
434 : if( mnCommand == COMMAND_MODKEYCHANGE )
435 : return (const CommandModKeyData*)mpData;
436 : else
437 : return NULL;
438 : }
439 :
440 0 : inline const CommandDialogData* CommandEvent::GetDialogData() const
441 : {
442 0 : if( mnCommand == COMMAND_SHOWDIALOG )
443 0 : return (const CommandDialogData*)mpData;
444 : else
445 0 : return NULL;
446 : }
447 :
448 0 : inline sal_Int16 CommandEvent::GetMediaCommand() const
449 : {
450 0 : if( mnCommand == COMMAND_MEDIA )
451 0 : return *(const sal_Int16*)(mpData);
452 : else
453 0 : return 0;
454 : }
455 :
456 0 : inline const CommandSelectionChangeData* CommandEvent::GetSelectionChangeData() const
457 : {
458 0 : if( mnCommand == COMMAND_SELECTIONCHANGE )
459 0 : return (const CommandSelectionChangeData*)mpData;
460 : else
461 0 : return NULL;
462 : }
463 :
464 :
465 : #endif // INCLUDED_VCL_CMDEVT_HXX
466 :
467 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
