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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_SectionFileLink_idl__
  28 #define __com_sun_star_text_SectionFileLink_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module text {
  34
  35 //=============================================================================
  36
  37 // DocMerge from xml: struct com::sun::star::text::SectionFileLink
  38 /** describes the link for a text section.
  39
  40
  41
  42     <p>If the URL is an empty string, then the section is not linked.
  43
  44     </p>
  45     <p>The bookmark of the URL (after the "#") is the name of a bookmark
  46     or a section name in the linked document.  If a bookmark or section
  47     with this name exists in the document, then only this part is linked
  48     into the given text section.
  49     </p>
  50     <p>
  51     <member>SectionFileLink::FilterName</member> is the internal name of
  52     the document filter.  To use this struct, it is not necessary to set
  53     <member>SectionFileLink::FilterName</member>. It will be automatically
  54     assigned.</p>
  55  */
  56 published struct SectionFileLink
  57 {
  58     // DocMerge from xml: field com::sun::star::text::SectionFileLink::FileURL
  59     /** contains the URL of the linked file.
  60      */
  61     string FileURL;
  62
  63     //-------------------------------------------------------------------------
  64
  65     // DocMerge from xml: field com::sun::star::text::SectionFileLink::FilterName
  66     /** contains the name of the file filter that is used to load the linked file.
  67      */
  68     string FilterName;
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif