sw/inc/IDocumentDrawModelAccess.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_SW_INC_IDOCUMENTDRAWMODELACCESS_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTDRAWMODELACCESS_HXX
  22
  23 #include <svx/svdtypes.hxx>
  24
  25 class SwDrawModel;
  26 class SwPaM;
  27 class SdrPageView;
  28 class SvxSearchItem;
  29
  30 class IDocumentDrawModelAccess
  31 {
  32 public:
  33
  34     /** Draw Model and id accessors
  35      */
  36     virtual const SwDrawModel* GetDrawModel() const = 0;
  37     virtual SwDrawModel* GetDrawModel() = 0;
  38     virtual SwDrawModel* _MakeDrawModel() = 0;
  39     virtual SwDrawModel* GetOrCreateDrawModel() = 0;
  40     virtual SdrLayerID GetHeavenId() const = 0;
  41     virtual SdrLayerID GetHellId() const = 0;
  42     virtual SdrLayerID GetControlsId() const = 0;
  43     virtual SdrLayerID GetInvisibleHeavenId() const = 0;
  44     virtual SdrLayerID GetInvisibleHellId() const = 0;
  45     virtual SdrLayerID GetInvisibleControlsId() const = 0;
  46
  47     /** method to notify drawing page view about the invisible layers
  48         @author OD
  49     */
  50     virtual void NotifyInvisibleLayers( SdrPageView& _rSdrPageView ) = 0;
  51
  52     /** method to determine, if a layer ID belongs to the visible ones.
  53         Note: If given layer ID is unknown, method asserts and returns <false>.
  54         @author OD
  55
  56         @param _nLayerId
  57         input parameter - layer ID, which has to be checked, if it belongs to
  58         the visible ones.
  59
  60         @return bool, indicating, if given layer ID belongs to the visible ones.
  61     */
  62     virtual bool IsVisibleLayerId( const SdrLayerID& _nLayerId ) const = 0;
  63
  64     /** method to determine, if the corresponding visible layer ID for a invisible one.
  65
  66         Note: If given layer ID is a visible one, method returns given layer ID.
  67         Note: If given layer ID is unknown, method returns given layer ID.
  68
  69         @author OD
  70
  71         @param _nInvisibleLayerId
  72         input parameter - invisible layer ID for which the corresponding
  73         visible one has to be returned.
  74
  75         @return sal_Int8, visible layer ID corresponding to given layer ID
  76     */
  77     virtual SdrLayerID GetVisibleLayerIdByInvisibleOne( const SdrLayerID& _nInvisibleLayerId ) = 0;
  78
  79     /** method to determine, if the corresponding invisible layer ID for a visible one.
  80
  81         Note: If given layer ID is a invisible one, method returns given layer ID.
  82         Note: If given layer ID is unknown, method returns given layer ID.
  83
  84         @author OD
  85
  86         @param _nVisibleLayerId
  87         input parameter - visible layer ID for which the corresponding
  88         invisible one has to be returned.
  89
  90         @return sal_Int8, invisible layer ID corresponding to given layer ID
  91     */
  92     virtual SdrLayerID GetInvisibleLayerIdByVisibleOne( const SdrLayerID& _nVisibleLayerId ) = 0;
  93
  94     /// Searches text in shapes anchored inside rPaM.
  95     virtual bool Search(const SwPaM& rPaM, const SvxSearchItem& rSearchItem) = 0;
  96
  97 protected:
  98
  99     virtual ~IDocumentDrawModelAccess() {};
 100 };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */