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