include/svx/sdrmasterpagedescriptor.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_SVX_SDRMASTERPAGEDESCRIPTOR_HXX
  21 #define INCLUDED_SVX_SDRMASTERPAGEDESCRIPTOR_HXX
  22
  23 #include <svx/sdrpageuser.hxx>
  24 #include <svx/svdsob.hxx>
  25 #include <svx/svxdllapi.h>
  26 #include <memory>
  27
  28 class SdrPageProperties;
  29 namespace sdr::contact { class ViewContact; }
  30
  31
  32 namespace sdr
  33 {
  34     class SVXCORE_DLLPUBLIC MasterPageDescriptor final : public sdr::PageUser
  35     {
  36     private:
  37         SdrPage&                                        maOwnerPage;
  38         SdrPage&                                        maUsedPage;
  39         SdrLayerIDSet                                       maVisibleLayers;
  40
  41         // ViewContact part
  42         mutable std::unique_ptr<sdr::contact::ViewContact>      mpViewContact;
  43
  44         void operator=(const MasterPageDescriptor& rCandidate) = delete;
  45
  46     public:
  47         MasterPageDescriptor(SdrPage& aOwnerPage, SdrPage& aUsedPage);
  48         virtual ~MasterPageDescriptor();
  49
  50         // ViewContact part
  51         sdr::contact::ViewContact& GetViewContact() const;
  52
  53         // this method is called from the destructor of the referenced page.
  54         // do all necessary action to forget the page. It is not necessary to call
  55         // RemovePageUser(), that is done from the destructor.
  56         virtual void PageInDestruction(const SdrPage& rPage) override;
  57
  58         // member access to UsedPage
  59         SdrPage& GetUsedPage() const { return maUsedPage; }
  60
  61         // member access to OwnerPage
  62         SdrPage& GetOwnerPage() const { return maOwnerPage; }
  63
  64         // member access to VisibleLayers
  65         const SdrLayerIDSet& GetVisibleLayers() const { return maVisibleLayers; }
  66         void SetVisibleLayers(const SdrLayerIDSet& rNew);
  67
  68         const SdrPageProperties* getCorrectSdrPageProperties() const;
  69     };
  70 } // end of namespace sdr
  71
  72 #endif // INCLUDED_SVX_SDRMASTERPAGEDESCRIPTOR_HXX
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */