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