vcl/inc/salframe.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_SALFRAME_HXX
  21 #define INCLUDED_VCL_INC_SALFRAME_HXX
  22
  23 #include <tools/solar.h>
  24 #include <vcl/dllapi.h>
  25
  26 #include <vcl/ptrstyle.hxx>
  27
  28 #include <salwtype.hxx>
  29 #include <salgeom.hxx>
  30 #include <tools/gen.hxx>
  31 #include <vcl/region.hxx>
  32
  33 #include <vcl/impdel.hxx>
  34 #include <rtl/ustring.hxx>
  35 #include <vcl/keycod.hxx>
  36
  37 class AllSettings;
  38 class SalGraphics;
  39 class SalBitmap;
  40 class SalMenu;
  41 class Window;
  42
  43 struct SalFrameState;
  44 struct SalInputContext;
  45 struct SystemEnvData;
  46
  47 // SalFrame types
  48 #define SAL_FRAME_TOTOP_RESTOREWHENMIN      ((sal_uInt16)0x0001)
  49 #define SAL_FRAME_TOTOP_FOREGROUNDTASK      ((sal_uInt16)0x0002)
  50 #define SAL_FRAME_TOTOP_GRABFOCUS           ((sal_uInt16)0x0004)
  51 #define SAL_FRAME_TOTOP_GRABFOCUS_ONLY       ((sal_uInt16)0x0008)
  52
  53 #define SAL_FRAME_ENDEXTTEXTINPUT_COMPLETE  ((sal_uInt16)0x0001)
  54 #define SAL_FRAME_ENDEXTTEXTINPUT_CANCEL    ((sal_uInt16)0x0002)
  55
  56 // SalFrame styles
  57 #define SAL_FRAME_STYLE_DEFAULT             ((sal_uLong)0x00000001)
  58 #define SAL_FRAME_STYLE_MOVEABLE            ((sal_uLong)0x00000002)
  59 #define SAL_FRAME_STYLE_SIZEABLE            ((sal_uLong)0x00000004)
  60 #define SAL_FRAME_STYLE_CLOSEABLE           ((sal_uLong)0x00000008)
  61
  62 // no shadow effect on Windows XP
  63 #define SAL_FRAME_STYLE_NOSHADOW            ((sal_uLong)0x00000010)
  64 // indicate tooltip windows, so they can always be topmost
  65 #define SAL_FRAME_STYLE_TOOLTIP             ((sal_uLong)0x00000020)
  66 // windows without windowmanager decoration, this typically only applies to floating windows
  67 #define SAL_FRAME_STYLE_OWNERDRAWDECORATION ((sal_uLong)0x00000040)
  68 // dialogs
  69 #define SAL_FRAME_STYLE_DIALOG              ((sal_uLong)0x00000080)
  70 // partial fullscreen: fullscreen on one monitor of a multimonitor display
  71 #define SAL_FRAME_STYLE_PARTIAL_FULLSCREEN  ((sal_uLong)0x00800000)
  72 // plugged system child window
  73 #define SAL_FRAME_STYLE_PLUG                ((sal_uLong)0x10000000)
  74 // system child window inside another SalFrame
  75 #define SAL_FRAME_STYLE_SYSTEMCHILD         ((sal_uLong)0x08000000)
  76 // floating window
  77 #define SAL_FRAME_STYLE_FLOAT               ((sal_uLong)0x20000000)
  78 // floating window that needs to be focusable
  79 #define SAL_FRAME_STYLE_FLOAT_FOCUSABLE     ((sal_uLong)0x04000000)
  80 // toolwindows should be painted with a smaller decoration
  81 #define SAL_FRAME_STYLE_TOOLWINDOW          ((sal_uLong)0x40000000)
  82 // the window containing the intro bitmap, aka splashscreen
  83 #define SAL_FRAME_STYLE_INTRO               ((sal_uLong)0x80000000)
  84
  85 // - extended frame style                 -
  86 // - (sal equivalent to extended WinBits) -
  87 typedef sal_uInt64 SalExtStyle;
  88 #define SAL_FRAME_EXT_STYLE_DOCUMENT        SalExtStyle(0x00000001)
  89 #define SAL_FRAME_EXT_STYLE_DOCMODIFIED     SalExtStyle(0x00000002)
  90
  91 // Flags for SetPosSize
  92 #define SAL_FRAME_POSSIZE_X                 ((sal_uInt16)0x0001)
  93 #define SAL_FRAME_POSSIZE_Y                 ((sal_uInt16)0x0002)
  94 #define SAL_FRAME_POSSIZE_WIDTH             ((sal_uInt16)0x0004)
  95 #define SAL_FRAME_POSSIZE_HEIGHT            ((sal_uInt16)0x0008)
  96
  97 struct SystemParentData;
  98
  99 class VCL_PLUGIN_PUBLIC SalFrame : public vcl::DeletionNotifier
 100 {
 101     // the VCL window corresponding to this frame
 102     Window*                 m_pWindow;
 103     SALFRAMEPROC            m_pProc;
 104
 105 public:
 106     SalFrame() : m_pWindow( NULL ), m_pProc( NULL ) {}
 107     virtual ~SalFrame();
 108
 109     SalFrameGeometry        maGeometry;
 110
 111     // SalGraphics or NULL, but two Graphics for all SalFrames
 112     // must be returned
 113     virtual SalGraphics*    AcquireGraphics() = 0;
 114     virtual void            ReleaseGraphics( SalGraphics* pGraphics ) = 0;
 115
 116     // Event must be destroyed, when Frame is destroyed
 117     // When Event is called, SalInstance::Yield() must be returned
 118     virtual bool        PostEvent( void* pData ) = 0;
 119
 120     virtual void            SetTitle( const OUString& rTitle ) = 0;
 121     virtual void            SetIcon( sal_uInt16 nIcon ) = 0;
 122     virtual void            SetRepresentedURL( const OUString& );
 123     virtual void            SetMenu( SalMenu *pSalMenu ) = 0;
 124     virtual void            DrawMenuBar() = 0;
 125
 126     virtual void            SetExtendedFrameStyle( SalExtStyle nExtStyle ) = 0;
 127
 128     // Before the window is visible, a resize event
 129     // must be sent with the correct size
 130     virtual void            Show( bool bVisible, bool bNoActivate = false ) = 0;
 131     virtual void            Enable( bool bEnable ) = 0;
 132     // Set ClientSize and Center the Window to the desktop
 133     // and send/post a resize message
 134     virtual void            SetMinClientSize( long nWidth, long nHeight ) = 0;
 135     virtual void            SetMaxClientSize( long nWidth, long nHeight ) = 0;
 136     virtual void            SetPosSize( long nX, long nY, long nWidth, long nHeight, sal_uInt16 nFlags ) = 0;
 137     virtual void            GetClientSize( long& rWidth, long& rHeight ) = 0;
 138     virtual void            GetWorkArea( Rectangle& rRect ) = 0;
 139     virtual SalFrame*       GetParent() const = 0;
 140     // Note: x will be mirrored at parent if UI mirroring is active
 141     SalFrameGeometry        GetGeometry();
 142     const SalFrameGeometry& GetUnmirroredGeometry() const { return maGeometry; }
 143
 144     virtual void            SetWindowState( const SalFrameState* pState ) = 0;
 145     virtual bool        GetWindowState( SalFrameState* pState ) = 0;
 146     virtual void            ShowFullScreen( bool bFullScreen, sal_Int32 nDisplay ) = 0;
 147
 148     // Enable/Disable ScreenSaver, SystemAgents, ...
 149     virtual void            StartPresentation( bool bStart ) = 0;
 150     // Show Window over all other Windows
 151     virtual void            SetAlwaysOnTop( bool bOnTop ) = 0;
 152
 153     // Window to top and grab focus
 154     virtual void            ToTop( sal_uInt16 nFlags ) = 0;
 155
 156     // this function can call with the same
 157     // pointer style
 158     virtual void            SetPointer( PointerStyle ePointerStyle ) = 0;
 159     virtual void            CaptureMouse( bool bMouse ) = 0;
 160     virtual void            SetPointerPos( long nX, long nY ) = 0;
 161
 162     // flush output buffer
 163     virtual void            Flush( void) = 0;
 164     virtual void            Flush( const Rectangle& );
 165     // flush output buffer, wait till outstanding operations are done
 166     virtual void            Sync() = 0;
 167
 168     virtual void            SetInputContext( SalInputContext* pContext ) = 0;
 169     virtual void            EndExtTextInput( sal_uInt16 nFlags ) = 0;
 170
 171     virtual OUString        GetKeyName( sal_uInt16 nKeyCode ) = 0;
 172
 173     // returns in 'rKeyCode' the single keycode that translates to the given unicode when using a keyboard layout of language 'aLangType'
 174     // returns false if no mapping exists or function not supported
 175     // this is required for advanced menu support
 176     virtual bool        MapUnicodeToKeyCode( sal_Unicode aUnicode, LanguageType aLangType, KeyCode& rKeyCode ) = 0;
 177
 178     // returns the input language used for the last key stroke
 179     // may be LANGUAGE_DONTKNOW if not supported by the OS
 180     virtual LanguageType    GetInputLanguage() = 0;
 181
 182     virtual void            UpdateSettings( AllSettings& rSettings ) = 0;
 183
 184     virtual void                Beep() = 0;
 185
 186     // returns system data (most prominent: window handle)
 187     virtual const SystemEnvData*
 188                             GetSystemData() const = 0;
 189
 190     // get current modifier, button mask and mouse position
 191     struct SalPointerState
 192     {
 193         sal_uLong   mnState;
 194         Point   maPos;      // in frame coordinates
 195     };
 196
 197     virtual SalPointerState GetPointerState() = 0;
 198
 199     struct SalIndicatorState
 200     {
 201         sal_uInt16  mnState;
 202     };
 203
 204     virtual SalIndicatorState GetIndicatorState() = 0;
 205
 206     virtual void            SimulateKeyPress( sal_uInt16 nKeyCode ) = 0;
 207
 208     // set new parent window
 209     virtual void            SetParent( SalFrame* pNewParent ) = 0;
 210     // reparent window to act as a plugin; implementation
 211     // may choose to use a new system window internally
 212     // return false to indicate failure
 213     virtual bool            SetPluginParent( SystemParentData* pNewParent ) = 0;
 214
 215     // move the frame to a new screen
 216     virtual void            SetScreenNumber( unsigned int nScreen ) = 0;
 217
 218     virtual void            SetApplicationID( const OUString &rApplicationID) = 0;
 219
 220     // shaped system windows
 221     // set clip region to none (-> rectangular windows, normal state)
 222     virtual void            ResetClipRegion() = 0;
 223     // start setting the clipregion consisting of nRects rectangles
 224     virtual void            BeginSetClipRegion( sal_uLong nRects ) = 0;
 225     // add a rectangle to the clip region
 226     virtual void            UnionClipRegion( long nX, long nY, long nWidth, long nHeight ) = 0;
 227     // done setting up the clipregion
 228     virtual void            EndSetClipRegion() = 0;
 229
 230     // Callbacks (indepent part in vcl/source/window/winproc.cxx)
 231     // for default message handling return 0
 232     void                    SetCallback( Window* pWindow, SALFRAMEPROC pProc )
 233         { m_pWindow = pWindow; m_pProc = pProc; }
 234
 235     // returns the instance set
 236     Window*                 GetWindow() const
 237         { return m_pWindow; }
 238
 239     // Call the callback set; this sometimes necessary for implementation classes
 240     // that should not know more than necessary about the SalFrame implementation
 241     // (e.g. input methods, printer update handlers).
 242     long                    CallCallback( sal_uInt16 nEvent, const void* pEvent ) const
 243         { return m_pProc ? long(m_pProc( m_pWindow, const_cast<SalFrame*>(this), nEvent, pEvent )) : 0; }
 244 };
 245
 246 #endif // INCLUDED_VCL_INC_SALFRAME_HXX
 247
 248 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */