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

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