sw/inc/IDocumentDrawModelAccess.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IDocumentDrawModelAccess.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef IDOCUMENTDRAWMODEL_HXX_INCLUDED
  32 #define IDOCUMENTDRAWMODEL_HXX_INCLUDED
  33
  34 #include <svx/svdtypes.hxx>
  35
  36 class SdrModel;
  37 class SdrPageView;
  38
  39 /** IDocumentDrawModelAccess
  40  */
  41 class IDocumentDrawModelAccess
  42 {
  43 public:
  44
  45     /** Draw Model and id accessors
  46      */
  47     virtual const SdrModel* GetDrawModel() const = 0;
  48     virtual SdrModel* GetDrawModel() = 0;
  49     virtual SdrModel* _MakeDrawModel() = 0;
  50     virtual SdrModel* GetOrCreateDrawModel() = 0;
  51     virtual SdrLayerID GetHeavenId() const = 0;
  52     virtual SdrLayerID GetHellId() const = 0;
  53     virtual SdrLayerID GetControlsId() const = 0;
  54     virtual SdrLayerID GetInvisibleHeavenId() const = 0;
  55     virtual SdrLayerID GetInvisibleHellId() const = 0;
  56     virtual SdrLayerID GetInvisibleControlsId() const = 0;
  57
  58     /** method to notify drawing page view about the invisible layers
  59         OD 26.06.2003 #108784#
  60         @author OD
  61     */
  62     virtual void NotifyInvisibleLayers( SdrPageView& _rSdrPageView ) = 0;
  63
  64     /** method to determine, if a layer ID belongs to the visible ones.
  65         OD 25.06.2003 #108784#
  66         Note: If given layer ID is unknown, method asserts and returns <false>.
  67         @author OD
  68
  69         @param _nLayerId
  70         input parameter - layer ID, which has to be checked, if it belongs to
  71         the visible ones.
  72
  73         @return bool, indicating, if given layer ID belongs to the visible ones.
  74     */
  75     virtual bool IsVisibleLayerId( const SdrLayerID& _nLayerId ) const = 0;
  76
  77     /** method to determine, if the corresponding visible layer ID for a invisible one.
  78
  79         OD 25.06.2003 #108784#
  80         Note: If given layer ID is a visible one, method returns given layer ID.
  81         Note: If given layer ID is unknown, method returns given layer ID.
  82
  83         @author OD
  84
  85         @param _nInvisibleLayerId
  86         input parameter - invisible layer ID for which the corresponding
  87         visible one has to be returned.
  88
  89         @return sal_Int8, visible layer ID corresponding to given layer ID
  90     */
  91     virtual SdrLayerID GetVisibleLayerIdByInvisibleOne( const SdrLayerID& _nInvisibleLayerId ) = 0;
  92
  93     /** method to determine, if the corresponding invisible layer ID for a visible one.
  94
  95         OD 25.06.2003 #108784#
  96         Note: If given layer ID is a invisible one, method returns given layer ID.
  97         Note: If given layer ID is unknown, method returns given layer ID.
  98
  99         @author OD
 100
 101         @param _nVisibleLayerId
 102         input parameter - visible layer ID for which the corresponding
 103         invisible one has to be returned.
 104
 105         @return sal_Int8, invisible layer ID corresponding to given layer ID
 106     */
 107     virtual SdrLayerID GetInvisibleLayerIdByVisibleOne( const SdrLayerID& _nVisibleLayerId ) = 0;
 108
 109 protected:
 110
 111     virtual ~IDocumentDrawModelAccess() {};
 112 };
 113
 114 #endif