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