LibreOffice Module svx (master)  1
displayinfo.hxx
Go to the documentation of this file.
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_SVX_SDR_CONTACT_DISPLAYINFO_HXX
21 #define INCLUDED_SVX_SDR_CONTACT_DISPLAYINFO_HXX
22 
23 #include <svx/svdsob.hxx>
24 #include <vcl/region.hxx>
25 #include <svx/svxdllapi.h>
27 
28 namespace sdr::contact
29  {
31  {
32  // The Layers which shall be processed (visible)
34 
35  // The redraw area, in logical coordinates of OutputDevice. If Region
36  // is empty, everything needs to be redrawn
38 
41 
42  // Internal flag to know when the control layer is painted. Default is
43  // false. If set to true, painting of the page, page borders and
44  // the rasters will be suppressed as if mbPageProcessingActive is set (see there).
45  // This flag is set internally from the processing mechanism to avoid double page
46  // painting when the control layer needs to be painted as last layer
47  bool mbControlLayerProcessingActive : 1;
48 
49  // Internal flag to decide if page stuff (background, border, MasterPage, grid, etc...)
50  // will be processed at all. This flag is user-defined and will not be changed from the
51  // processing mechanism. Default is true, thus set to false if PagePainting should be suppressed.
52  // For more granular switching page stuff painting on and off, use the according flags at the
53  // view (->Is*Visible())
54  bool mbPageProcessingActive : 1;
55 
56  // Internal flag to remember if EnteredGroupDrawMode is active. Default is true
57  // since this mode starts activated and gets switched off when reaching
58  // the current group level. Should only be changed by instances which do
59  // primitive processing
60  bool mbGhostedDrawModeActive : 1;
61 
62  // Internal flag to know if a MasterPage is processed as SubContent of another
63  // page. Initialized to false, this should only be changed from the instance which
64  // is processing the MasterPage asSubContent and knows what it does
65  bool mbSubContentActive : 1;
66 
67  public:
68  // basic constructor.
69  DisplayInfo();
70 
71  // access to ProcessLayers
72  void SetProcessLayers(const SdrLayerIDSet& rSet);
73  const SdrLayerIDSet& GetProcessLayers() const { return maProcessLayers; }
74 
75  // access to RedrawArea
76  void SetRedrawArea(const vcl::Region& rRegion);
77  const vcl::Region& GetRedrawArea() const { return maRedrawArea; }
78 
79  void SetWriterPageFrame(basegfx::B2IRectangle const& rPageFrame);
80  basegfx::B2IRectangle const& GetWriterPageFrame() const { return m_WriterPageFrame; }
81 
82  // Access to ControlLayerProcessingActive flag
83  void SetControlLayerProcessingActive(bool bDoPaint);
84  bool GetControlLayerProcessingActive() const { return mbControlLayerProcessingActive; }
85 
86  // Access to PageProcessingActive flag
87  void SetPageProcessingActive(bool bDoPaint);
88  bool GetPageProcessingActive() const { return mbPageProcessingActive; }
89 
90  // Save the original DrawMode from outdev
91  void ClearGhostedDrawMode();
92  void SetGhostedDrawMode();
93  bool IsGhostedDrawModeActive() const { return mbGhostedDrawModeActive; }
94 
95  // access to master page painting flag
96  bool GetSubContentActive() const { return mbSubContentActive; }
97  void SetSubContentActive(bool bNew);
98  };
99 
100 } // end of namespace sdr::contact
101 
102 
103 #endif // INCLUDED_SVX_SDR_CONTACT_DISPLAYINFO_HXX
104 
105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const vcl::Region & GetRedrawArea() const
Definition: displayinfo.hxx:77
bool GetPageProcessingActive() const
Definition: displayinfo.hxx:88
const SdrLayerIDSet & GetProcessLayers() const
Definition: displayinfo.hxx:73
SdrLayerIDSet maProcessLayers
Definition: displayinfo.hxx:33
bool GetControlLayerProcessingActive() const
Definition: displayinfo.hxx:84
basegfx::B2IRectangle m_WriterPageFrame
only for Writer: current page being painted
Definition: displayinfo.hxx:40
bool IsGhostedDrawModeActive() const
Definition: displayinfo.hxx:93
#define SVXCORE_DLLPUBLIC
Definition: svxdllapi.h:35
basegfx::B2IRectangle const & GetWriterPageFrame() const
Definition: displayinfo.hxx:80
bool GetSubContentActive() const
Definition: displayinfo.hxx:96