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 _SDR_MASTERPAGEDESCRIPTOR_HXX
  21 #define _SDR_MASTERPAGEDESCRIPTOR_HXX
  22
  23 #include <svx/sdrpageuser.hxx>
  24 #include <svx/svdsob.hxx>
  25
  26 //////////////////////////////////////////////////////////////////////////////
  27 // predeclarations
  28 class SdrObject;
  29 class SfxItemSet;
  30 class SdrPageProperties;
  31
  32 namespace sdr
  33 {
  34     namespace contact
  35     {
  36         class ViewContact;
  37     } // end of namespace contact
  38 } // end of namespace sdr
  39
  40 //////////////////////////////////////////////////////////////////////////////
  41
  42 namespace sdr
  43 {
  44     class MasterPageDescriptor : public sdr::PageUser
  45     {
  46     private:
  47         SdrPage&                                        maOwnerPage;
  48         SdrPage&                                        maUsedPage;
  49         SetOfByte                                       maVisibleLayers;
  50
  51         // ViewContact part
  52         sdr::contact::ViewContact*                      mpViewContact;
  53
  54         // assignment operator defined, but not implemented
  55         void operator=(const MasterPageDescriptor& rCandidate);
  56
  57     protected:
  58         virtual sdr::contact::ViewContact* CreateObjectSpecificViewContact();
  59
  60     public:
  61         MasterPageDescriptor(SdrPage& aOwnerPage, SdrPage& aUsedPage);
  62         virtual ~MasterPageDescriptor();
  63
  64         // ViewContact part
  65         sdr::contact::ViewContact& GetViewContact() const;
  66
  67         // this method is called form the destructor of the referenced page.
  68         // do all necessary action to forget the page. It is not necessary to call
  69         // RemovePageUser(), that is done form the destructor.
  70         virtual void PageInDestruction(const SdrPage& rPage);
  71
  72         // member access to UsedPage
  73         SdrPage& GetUsedPage() const { return maUsedPage; }
  74
  75         // member access to OwnerPage
  76         SdrPage& GetOwnerPage() const { return maOwnerPage; }
  77
  78         // member access to VisibleLayers
  79         const SetOfByte& GetVisibleLayers() const { return maVisibleLayers; }
  80         void SetVisibleLayers(const SetOfByte& rNew);
  81
  82         // operators
  83         bool operator==(const MasterPageDescriptor& rCandidate) const;
  84         bool operator!=(const MasterPageDescriptor& rCandidate) const;
  85
  86         const SdrPageProperties* getCorrectSdrPageProperties() const;
  87     };
  88 } // end of namespace sdr
  89
  90 //////////////////////////////////////////////////////////////////////////////
  91
  92 #endif //_SDR_MASTERPAGEDESCRIPTOR_HXX
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */