sw/inc/IDocumentLinksAdministration.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_IDOCUMENTLINKSADMINISTRATION_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTLINKSADMINISTRATION_HXX
  22
  23 #include <sal/types.h>
  24
  25 namespace com { namespace sun { namespace star { namespace uno { class Any; } } } }
  26 namespace sfx2 { class SvLinkSource;  class LinkManager; }
  27 namespace rtl { class OUString; }
  28 using rtl::OUString;
  29
  30
  31  /** Document links administration interface
  32  */
  33  class IDocumentLinksAdministration
  34  {
  35  public:
  36     /** Insert links in-/visibly into LinkManager (linked ranges).
  37     */
  38     virtual bool IsVisibleLinks() const = 0;
  39
  40     virtual void SetVisibleLinks(bool bFlag) = 0;
  41
  42     virtual sfx2::LinkManager& GetLinkManager() = 0;
  43
  44     virtual const sfx2::LinkManager& GetLinkManager() const = 0;
  45
  46     /** #i42634# Moved common code of SwReader::Read() and
  47         SwDocShell::UpdateLinks() to new SwDoc::UpdateLinks():
  48     */
  49     virtual void UpdateLinks() = 0;
  50
  51     /** for linking of parts of documents.
  52     */
  53     virtual bool GetData(const OUString& rItem, const OUString& rMimeType, css::uno::Any& rValue) const = 0;
  54
  55     virtual void SetData(const OUString& rItem) = 0;
  56
  57     virtual ::sfx2::SvLinkSource* CreateLinkSource(const OUString& rItem) = 0;
  58
  59     /** Embed all local links (ranges/graphics).
  60     */
  61     virtual bool EmbedAllLinks() = 0;
  62
  63     virtual void SetLinksUpdated(const bool bNewLinksUpdated) = 0;
  64
  65     virtual bool LinksUpdated() const = 0;
  66
  67 protected:
  68     virtual ~IDocumentLinksAdministration() {};
  69  };
  70
  71  #endif // INCLUDED_SW_INC_IDOCUMENTLINKSADMINISTRATION_HXX
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */