vcl/inc/brdwin.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_BRDWIN_HXX
  21 #define INCLUDED_VCL_INC_BRDWIN_HXX
  22
  23 #include <vcl/notebookbar.hxx>
  24 #include <vcl/window.hxx>
  25 #include <o3tl/typed_flags_set.hxx>
  26 #include <vcl/NotebookBarAddonsMerger.hxx>
  27
  28 #include <com/sun/star/frame/XFrame.hpp>
  29
  30 class ImplBorderWindowView;
  31 enum class DrawButtonFlags;
  32
  33 enum class BorderWindowStyle {
  34     NONE             = 0x0000,
  35     Overlap          = 0x0001,
  36     Float            = 0x0004,
  37     Frame            = 0x0008,
  38     App              = 0x0010
  39 };
  40 namespace o3tl {
  41     template<> struct typed_flags<BorderWindowStyle> : is_typed_flags<BorderWindowStyle, 0x001d> {};
  42 };
  43
  44 enum class BorderWindowHitTest {
  45     NONE           = 0x0000,
  46     Title          = 0x0001,
  47     Left           = 0x0002,
  48     Menu           = 0x0004,
  49     Top            = 0x0008,
  50     Right          = 0x0010,
  51     Bottom         = 0x0020,
  52     TopLeft        = 0x0040,
  53     TopRight       = 0x0080,
  54     BottomLeft     = 0x0100,
  55     BottomRight    = 0x0200,
  56     Close          = 0x0400,
  57     Roll           = 0x0800,
  58     Dock           = 0x1000,
  59     Hide           = 0x2000,
  60     Help           = 0x4000,
  61 };
  62 namespace o3tl {
  63     template<> struct typed_flags<BorderWindowHitTest> : is_typed_flags<BorderWindowHitTest, 0xffff> {};
  64 };
  65
  66 enum class BorderWindowTitleType {
  67     Normal           = 0x0001,
  68     Small            = 0x0002,
  69     Tearoff          = 0x0004,
  70     Popup            = 0x0008,
  71     NONE             = 0x0010
  72 };
  73 namespace o3tl {
  74     template<> struct typed_flags<BorderWindowTitleType> : is_typed_flags<BorderWindowTitleType, 0x001f> {};
  75 };
  76
  77 class ImplBorderWindow : public vcl::Window
  78 {
  79     friend class vcl::Window;
  80     friend class ImplBorderWindowView;
  81     friend class ImplSmallBorderWindowView;
  82     friend class ImplStdBorderWindowView;
  83
  84 private:
  85     std::unique_ptr<ImplBorderWindowView> mpBorderView;
  86     VclPtr<vcl::Window>     mpMenuBarWindow;
  87     VclPtr<NotebookBar>     mpNotebookBar;
  88     long                    mnMinWidth;
  89     long                    mnMinHeight;
  90     long                    mnMaxWidth;
  91     long                    mnMaxHeight;
  92     long                    mnOrgMenuHeight;
  93     BorderWindowTitleType   mnTitleType;
  94     WindowBorderStyle       mnBorderStyle;
  95     bool                    mbFloatWindow;
  96     bool                    mbSmallOutBorder;
  97     bool                    mbFrameBorder;
  98     bool                    mbRollUp;
  99     bool                    mbMenuHide;
 100     bool                    mbDockBtn;
 101     bool                    mbHideBtn;
 102     bool                    mbMenuBtn;
 103     bool                    mbDisplayActive;
 104
 105     using Window::ImplInit;
 106     void                    ImplInit( vcl::Window* pParent,
 107                                       WinBits nStyle, BorderWindowStyle nTypeStyle,
 108                                       SystemParentData* pParentData );
 109
 110                             ImplBorderWindow (const ImplBorderWindow &) = delete;
 111                             ImplBorderWindow& operator= (const ImplBorderWindow &) = delete;
 112
 113 public:
 114                             ImplBorderWindow( vcl::Window* pParent,
 115                                               SystemParentData* pParentData,
 116                                               WinBits nStyle,
 117                                               BorderWindowStyle nTypeStyle );
 118                             ImplBorderWindow( vcl::Window* pParent, WinBits nStyle,
 119                                               BorderWindowStyle nTypeStyle );
 120     virtual                 ~ImplBorderWindow() override;
 121     virtual void            dispose() override;
 122
 123     virtual void            MouseMove( const MouseEvent& rMEvt ) override;
 124     virtual void            MouseButtonDown( const MouseEvent& rMEvt ) override;
 125     virtual void            Tracking( const TrackingEvent& rTEvt ) override;
 126     virtual void            Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
 127     virtual void            Activate() override;
 128     virtual void            Deactivate() override;
 129     virtual void            Resize() override;
 130     virtual void            RequestHelp( const HelpEvent& rHEvt ) override;
 131     virtual void            StateChanged( StateChangedType nType ) override;
 132     virtual void            DataChanged( const DataChangedEvent& rDCEvt ) override;
 133     virtual void            queue_resize(StateChangedType eReason = StateChangedType::Layout) override;
 134
 135     void                    InitView();
 136     void                    UpdateView( bool bNewView, const Size& rNewOutSize );
 137     void                    InvalidateBorder();
 138
 139     using Window::Draw;
 140     void                    Draw( OutputDevice* pDev, const Point& rPos );
 141
 142     void                    SetDisplayActive( bool bActive );
 143     void                    SetTitleType( BorderWindowTitleType nTitleType, const Size& rSize );
 144     void                    SetBorderStyle( WindowBorderStyle nStyle );
 145     WindowBorderStyle       GetBorderStyle() const { return mnBorderStyle; }
 146     void                    SetRollUp( bool bRollUp, const Size& rSize );
 147     void                    SetCloseButton();
 148     void                    SetDockButton( bool bDockButton );
 149     void                    SetHideButton( bool bHideButton );
 150     void                    SetMenuButton( bool bMenuButton );
 151
 152     void                    UpdateMenuHeight();
 153     void                    SetMenuBarWindow( vcl::Window* pWindow );
 154     void                    SetMenuBarMode( bool bHide );
 155
 156     void SetNotebookBar(const OUString& rUIXMLDescription,
 157                         const css::uno::Reference<css::frame::XFrame>& rFrame,
 158                         const NotebookBarAddonsItem &aNotebookBarAddonsItem);
 159     void CloseNotebookBar();
 160     const VclPtr<NotebookBar>& GetNotebookBar() const { return mpNotebookBar; }
 161
 162     void                    SetMinOutputSize( long nWidth, long nHeight )
 163                                 { mnMinWidth = nWidth; mnMinHeight = nHeight; }
 164     void                    SetMaxOutputSize( long nWidth, long nHeight )
 165                                 { mnMaxWidth = nWidth; mnMaxHeight = nHeight; }
 166
 167     void                    GetBorder( sal_Int32& rLeftBorder, sal_Int32& rTopBorder,
 168                                        sal_Int32& rRightBorder, sal_Int32& rBottomBorder ) const;
 169     long                    CalcTitleWidth() const;
 170
 171     tools::Rectangle               GetMenuRect() const;
 172
 173     virtual Size            GetOptimalSize() const override;
 174 };
 175
 176 struct ImplBorderFrameData
 177 {
 178     VclPtr<ImplBorderWindow> mpBorderWindow;
 179     VclPtr<OutputDevice>     mpOutDev;
 180     tools::Rectangle                maTitleRect;
 181     tools::Rectangle                maCloseRect;
 182     tools::Rectangle                maRollRect;
 183     tools::Rectangle                maDockRect;
 184     tools::Rectangle                maMenuRect;
 185     tools::Rectangle                maHideRect;
 186     tools::Rectangle                maHelpRect;
 187     Point                    maMouseOff;
 188     long                     mnWidth;
 189     long                     mnHeight;
 190     long                     mnTrackX;
 191     long                     mnTrackY;
 192     long                     mnTrackWidth;
 193     long                     mnTrackHeight;
 194     sal_Int32                mnLeftBorder;
 195     sal_Int32                mnTopBorder;
 196     sal_Int32                mnRightBorder;
 197     sal_Int32                mnBottomBorder;
 198     long                     mnNoTitleTop;
 199     long                     mnBorderSize;
 200     long                     mnTitleHeight;
 201     BorderWindowHitTest      mnHitTest;
 202     DrawButtonFlags          mnCloseState;
 203     DrawButtonFlags          mnRollState;
 204     DrawButtonFlags          mnDockState;
 205     DrawButtonFlags          mnMenuState;
 206     DrawButtonFlags          mnHideState;
 207     DrawButtonFlags          mnHelpState;
 208     BorderWindowTitleType    mnTitleType;
 209     bool                     mbDragFull;
 210     bool                     mbTitleClipped;
 211 };
 212
 213 class ImplBorderWindowView
 214 {
 215 public:
 216     virtual                 ~ImplBorderWindowView();
 217
 218     virtual bool            MouseMove( const MouseEvent& rMEvt );
 219     virtual bool            MouseButtonDown( const MouseEvent& rMEvt );
 220     virtual bool            Tracking( const TrackingEvent& rTEvt );
 221     virtual OUString        RequestHelp( const Point& rPos, tools::Rectangle& rHelpRect );
 222
 223     virtual void            Init( OutputDevice* pDev, long nWidth, long nHeight ) = 0;
 224     virtual void            GetBorder( sal_Int32& rLeftBorder, sal_Int32& rTopBorder,
 225                                        sal_Int32& rRightBorder, sal_Int32& rBottomBorder ) const = 0;
 226     virtual long            CalcTitleWidth() const = 0;
 227     virtual void            DrawWindow(vcl::RenderContext& rRenderContext, const Point* pOffset = nullptr) = 0;
 228     virtual tools::Rectangle       GetMenuRect() const;
 229
 230     static void             ImplInitTitle( ImplBorderFrameData* pData );
 231     static BorderWindowHitTest ImplHitTest( ImplBorderFrameData const * pData, const Point& rPos );
 232     static void             ImplMouseMove( ImplBorderFrameData* pData, const MouseEvent& rMEvt );
 233     static OUString         ImplRequestHelp( ImplBorderFrameData const * pData, const Point& rPos, tools::Rectangle& rHelpRect );
 234     static long             ImplCalcTitleWidth( const ImplBorderFrameData* pData );
 235 };
 236
 237 class ImplNoBorderWindowView : public ImplBorderWindowView
 238 {
 239 public:
 240                             ImplNoBorderWindowView();
 241
 242     virtual void            Init( OutputDevice* pDev, long nWidth, long nHeight ) override;
 243     virtual void            GetBorder( sal_Int32& rLeftBorder, sal_Int32& rTopBorder,
 244                                        sal_Int32& rRightBorder, sal_Int32& rBottomBorder ) const override;
 245     virtual long            CalcTitleWidth() const override;
 246     virtual void            DrawWindow(vcl::RenderContext& rRenderContext, const Point* pOffset = nullptr) override;
 247 };
 248
 249 class ImplSmallBorderWindowView : public ImplBorderWindowView
 250 {
 251     VclPtr<ImplBorderWindow> mpBorderWindow;
 252     VclPtr<OutputDevice>     mpOutDev;
 253     long                    mnWidth;
 254     long                    mnHeight;
 255     sal_Int32               mnLeftBorder;
 256     sal_Int32               mnTopBorder;
 257     sal_Int32               mnRightBorder;
 258     sal_Int32               mnBottomBorder;
 259     bool                    mbNWFBorder;
 260
 261 public:
 262                             ImplSmallBorderWindowView( ImplBorderWindow* pBorderWindow );
 263
 264     virtual void            Init( OutputDevice* pOutDev, long nWidth, long nHeight ) override;
 265     virtual void            GetBorder( sal_Int32& rLeftBorder, sal_Int32& rTopBorder,
 266                                        sal_Int32& rRightBorder, sal_Int32& rBottomBorder ) const override;
 267     virtual long            CalcTitleWidth() const override;
 268     virtual void            DrawWindow(vcl::RenderContext& rRenderContext, const Point* pOffset = nullptr) override;
 269 };
 270
 271 class ImplStdBorderWindowView : public ImplBorderWindowView
 272 {
 273     ImplBorderFrameData     maFrameData;
 274
 275 public:
 276                             ImplStdBorderWindowView( ImplBorderWindow* pBorderWindow );
 277                             virtual ~ImplStdBorderWindowView() override;
 278
 279     virtual bool        MouseMove( const MouseEvent& rMEvt ) override;
 280     virtual bool        MouseButtonDown( const MouseEvent& rMEvt ) override;
 281     virtual bool        Tracking( const TrackingEvent& rTEvt ) override;
 282     virtual OUString        RequestHelp( const Point& rPos, tools::Rectangle& rHelpRect ) override;
 283     virtual tools::Rectangle       GetMenuRect() const override;
 284
 285     virtual void            Init( OutputDevice* pDev, long nWidth, long nHeight ) override;
 286     virtual void            GetBorder( sal_Int32& rLeftBorder, sal_Int32& rTopBorder,
 287                                        sal_Int32& rRightBorder, sal_Int32& rBottomBorder ) const override;
 288     virtual long            CalcTitleWidth() const override;
 289     virtual void            DrawWindow(vcl::RenderContext& rRenderContext, const Point* pOffset = nullptr) override;
 290 };
 291
 292 #endif // INCLUDED_VCL_INC_BRDWIN_HXX
 293
 294 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */