offapi/com/sun/star/text/SectionFileLink.idl

   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 #ifndef __com_sun_star_text_SectionFileLink_idl__
  20 #define __com_sun_star_text_SectionFileLink_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module text {
  25
  26 /** describes the link for a text section.
  27
  28
  29
  30     <p>If the URL is an empty string, then the section is not linked.
  31
  32     </p>
  33     <p>The bookmark of the URL (after the "#") is the name of a bookmark
  34     or a section name in the linked document.  If a bookmark or section
  35     with this name exists in the document, then only this part is linked
  36     into the given text section.
  37     </p>
  38     <p>
  39     SectionFileLink::FilterName is the internal name of
  40     the document filter.  To use this struct, it is not necessary to set
  41     SectionFileLink::FilterName. It will be automatically
  42     assigned.</p>
  43  */
  44 published struct SectionFileLink
  45 {
  46     /** contains the URL of the linked file.
  47      */
  48     string FileURL;
  49
  50     /** contains the name of the file filter that is used to load the linked file.
  51      */
  52     string FilterName;
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */