vcl/inc/salwtype.hxx

   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_INC_SALWTYPE_HXX
  21 #define INCLUDED_VCL_INC_SALWTYPE_HXX
  22
  23 #include <rtl/ref.hxx>
  24 #include <rtl/ustring.hxx>
  25 #include <tools/gen.hxx>
  26 #include <tools/solar.h>
  27 #include <tools/long.hxx>
  28 #include <vcl/GestureEventPan.hxx>
  29 #include <vcl/GestureEventZoom.hxx>
  30 #include <vcl/GestureEventRotate.hxx>
  31
  32 class LogicalFontInstance;
  33 class SalGraphics;
  34 class SalFrame;
  35 class SalObject;
  36 namespace vcl
  37 {
  38     class Window;
  39     enum class WindowState;
  40 }
  41 enum class InputContextFlags;
  42 enum class WindowStateMask;
  43 enum class ExtTextInputAttr;
  44 enum class ModKeyFlags;
  45
  46 enum class SalEvent {
  47     NONE,
  48     MouseMove,
  49     MouseLeave,
  50     MouseButtonDown,
  51     MouseButtonUp,
  52     KeyInput,
  53     KeyUp,
  54     KeyModChange,
  55     Paint,
  56     Resize,
  57     GetFocus,
  58     LoseFocus,
  59     Close,
  60     Shutdown,
  61     SettingsChanged,
  62     PrinterChanged,
  63     DisplayChanged,
  64     FontChanged,
  65     WheelMouse,
  66     UserEvent,
  67     MouseActivate,
  68     ExtTextInput,
  69     EndExtTextInput,
  70     ExtTextInputPos,
  71     InputContextChange,
  72     Move,
  73     MoveResize,
  74     ClosePopups,
  75     ExternalKeyInput,
  76     ExternalKeyUp,
  77     MenuCommand,
  78     MenuHighlight,
  79     MenuActivate,
  80     MenuDeactivate,
  81     ExternalMouseMove,
  82     ExternalMouseButtonDown,
  83     ExternalMouseButtonUp,
  84     InputLanguageChange,
  85     ShowDialog,
  86     MenuButtonCommand,
  87     SurroundingTextRequest,
  88     DeleteSurroundingTextRequest,
  89     SurroundingTextSelectionChange,
  90     StartReconversion,
  91     QueryCharPosition,
  92     GestureSwipe,
  93     GestureLongPress,
  94     ExternalGesture,
  95     GesturePan,
  96     GestureZoom,
  97     GestureRotate,
  98 };
  99
 100 struct SalAbstractMouseEvent
 101 {
 102     sal_uInt64 mnTime;  // Time in ms, when event is created
 103     tools::Long mnX;           // X-Position (Pixel, TopLeft-Output)
 104     tools::Long mnY;           // Y-Position (Pixel, TopLeft-Output)
 105     sal_uInt16 mnCode;  // SV-Modifiercode (KEY_SHIFT|KEY_MOD1|KEY_MOD2|MOUSE_LEFT|MOUSE_MIDDLE|MOUSE_RIGHT)
 106
 107 protected:
 108     SalAbstractMouseEvent() : mnTime(0), mnX(0), mnY(0), mnCode(0) {}
 109 };
 110
 111 // MOUSELEAVE must send, when the pointer leave the client area and
 112 // the mouse is not captured
 113 // MOUSEMOVE, MOUSELEAVE, MOUSEBUTTONDOWN and MOUSEBUTTONUP
 114 // MAC: Ctrl+Button is MOUSE_RIGHT
 115 struct SalMouseEvent final : public SalAbstractMouseEvent
 116 {
 117     sal_uInt16      mnButton;       // 0-MouseMove/MouseLeave, MOUSE_LEFT, MOUSE_RIGHT, MOUSE_MIDDLE
 118
 119     SalMouseEvent() : mnButton(0) {}
 120 };
 121
 122 // KEYINPUT and KEYUP
 123 struct SalKeyEvent
 124 {
 125     sal_uInt16      mnCode;         // SV-KeyCode (KEY_xxx | KEY_SHIFT | KEY_MOD1 | KEY_MOD2)
 126     sal_uInt16      mnCharCode;     // SV-CharCode
 127     sal_uInt16      mnRepeat;       // Repeat-Count (KeyInputs-1)
 128 };
 129
 130 // MENUEVENT
 131 struct SalMenuEvent
 132 {
 133     sal_uInt16      mnId;           // Menu item ID
 134     void*           mpMenu;         // pointer to VCL menu (class Menu)
 135
 136    SalMenuEvent() : mnId( 0 ), mpMenu( nullptr ) {}
 137    SalMenuEvent( sal_uInt16 i_nId, void* i_pMenu )
 138     : mnId( i_nId ), mpMenu( i_pMenu ) {}
 139 };
 140
 141 // KEYMODCHANGE
 142 struct SalKeyModEvent
 143 {
 144     bool            mbDown;         // Whether the change occurred on a key down event
 145     sal_uInt16      mnCode;         // SV-Modifiercode (KEY_SHIFT|KEY_MOD1|KEY_MOD2)
 146     ModKeyFlags     mnModKeyCode;   // extended Modifier (MODKEY_LEFT,MODKEY_RIGHT,MODKEY_PRESS,MODKEY_RELEASE)
 147 };
 148
 149 struct SalPaintEvent
 150 {
 151     tools::Long            mnBoundX;           // BoundRect - X
 152     tools::Long            mnBoundY;           // BoundRect - Y
 153     tools::Long            mnBoundWidth;       // BoundRect - Width
 154     tools::Long            mnBoundHeight;      // BoundRect - Height
 155     bool            mbImmediateUpdate;  // set to true to force an immediate update
 156
 157     SalPaintEvent( tools::Long x, tools::Long y, tools::Long w, tools::Long h, bool bImmediate = false ) :
 158         mnBoundX( x ), mnBoundY( y ),
 159         mnBoundWidth( w ), mnBoundHeight( h ),
 160         mbImmediateUpdate( bImmediate )
 161     {}
 162 };
 163
 164 #define SAL_WHEELMOUSE_EVENT_PAGESCROLL     (sal_uLong(0xFFFFFFFF))
 165 struct SalWheelMouseEvent final : public SalAbstractMouseEvent
 166 {
 167     tools::Long            mnDelta;        // Number of rotations
 168     tools::Long            mnNotchDelta;   // Number of fixed rotations
 169     double          mnScrollLines;  // Actual number of lines to scroll
 170     bool        mbHorz;         // Horizontal
 171     bool        mbDeltaIsPixel; // delta value is a pixel value (on touch devices)
 172
 173     SalWheelMouseEvent()
 174     : mnDelta(0), mnNotchDelta(0), mnScrollLines(0), mbHorz(false), mbDeltaIsPixel(false)
 175     {}
 176 };
 177
 178 struct SalExtTextInputEvent
 179 {
 180     OUString            maText;         // Text
 181     const ExtTextInputAttr* mpTextAttr;     // Text-Attribute
 182     sal_Int32           mnCursorPos;    // Cursor-Position
 183     sal_uInt8           mnCursorFlags;  // EXTTEXTINPUT_CURSOR_xxx
 184 };
 185
 186 struct SalExtTextInputPosEvent
 187 {
 188     tools::Long            mnX;            // Cursor-X-Position to upper left corner of frame
 189     tools::Long            mnY;            // Cursor-Y-Position to upper left corner of frame
 190     tools::Long            mnWidth;        // Cursor-Width in Pixel
 191     tools::Long            mnHeight;       // Cursor-Height in Pixel
 192     tools::Long            mnExtWidth;     // Width of the PreEdit area
 193     bool            mbVertical;     // true if in vertical mode
 194     SalExtTextInputPosEvent()
 195         : mnX(0)
 196         , mnY(0)
 197         , mnWidth(0)
 198         , mnHeight(0)
 199         , mnExtWidth(0)
 200         , mbVertical(false)
 201     {
 202     }
 203 };
 204
 205 struct SalInputContextChangeEvent
 206 {
 207 };
 208
 209 struct SalSurroundingTextRequestEvent
 210 {
 211     OUString        maText;         // Text
 212     sal_uLong       mnStart;        // The beginning index of selected range
 213     sal_uLong       mnEnd;          // The end index of selected range
 214 };
 215
 216 struct SalSurroundingTextSelectionChangeEvent
 217 {
 218     sal_uLong       mnStart;        // The beginning index of selected range
 219     sal_uLong       mnEnd;          // The end index of selected range
 220 };
 221
 222 struct SalQueryCharPositionEvent
 223 {
 224     sal_uLong       mnCharPos;              // The index of character in a composition.
 225     AbsoluteScreenPixelRectangle maCursorBound;         // The cursor bounds corresponding to the character specified by mnCharPos - X
 226     bool            mbValid;                // The data is valid or not.
 227     bool            mbVertical;             // The text is vertical or not.
 228 };
 229
 230 typedef bool (*SALFRAMEPROC)( vcl::Window* pInst, SalEvent nEvent, const void* pEvent );
 231
 232 enum class SalObjEvent {
 233     GetFocus           = 1,
 234     LoseFocus          = 2,
 235     ToTop              = 3
 236 };
 237
 238 struct SalInputContext
 239 {
 240     rtl::Reference<LogicalFontInstance> mpFont;
 241     InputContextFlags      mnOptions;
 242 };
 243
 244 struct SalGestureSwipeEvent
 245 {
 246     double mnVelocityX;
 247     double mnVelocityY;
 248     tools::Long mnX;
 249     tools::Long mnY;
 250 };
 251
 252 struct SalGestureLongPressEvent
 253 {
 254     tools::Long mnX;
 255     tools::Long mnY;
 256 };
 257
 258 struct SalGestureEvent
 259 {
 260     GestureEventPanType meEventType;
 261     PanningOrientation meOrientation;
 262     double mfOffset;
 263     tools::Long mnX;
 264     tools::Long mnY;
 265 };
 266
 267 struct SalGestureZoomEvent
 268 {
 269     GestureEventZoomType meEventType = GestureEventZoomType::Begin;
 270     tools::Long mnX = 0;
 271     tools::Long mnY = 0;
 272     double mfScaleDelta = 0;
 273 };
 274
 275 struct SalGestureRotateEvent
 276 {
 277     GestureEventRotateType meEventType = GestureEventRotateType::Begin;
 278     tools::Long mnX = 0;
 279     tools::Long mnY = 0;
 280     double mfAngleDelta = 0;
 281 };
 282
 283 typedef void (*SALTIMERPROC)();
 284
 285 #endif // INCLUDED_VCL_INC_SALWTYPE_HXX
 286
 287 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */