xref: /AOO41X/main/offapi/com/sun/star/text/SectionFileLink.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_SectionFileLink_idl__
24#define __com_sun_star_text_SectionFileLink_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module text {
30
31//=============================================================================
32
33// DocMerge from xml: struct com::sun::star::text::SectionFileLink
34/** describes the link for a text section.
35
36
37
38    <p>If the URL is an empty string, then the section is not linked.
39
40    </p>
41    <p>The bookmark of the URL (after the "#") is the name of a bookmark
42    or a section name in the linked document.  If a bookmark or section
43    with this name exists in the document, then only this part is linked
44    into the given text section.
45    </p>
46    <p>
47    <member>SectionFileLink::FilterName</member> is the internal name of
48    the document filter.  To use this struct, it is not necessary to set
49    <member>SectionFileLink::FilterName</member>. It will be automatically
50    assigned.</p>
51 */
52published struct SectionFileLink
53{
54    // DocMerge from xml: field com::sun::star::text::SectionFileLink::FileURL
55    /** contains the URL of the linked file.
56     */
57    string FileURL;
58
59    //-------------------------------------------------------------------------
60
61    // DocMerge from xml: field com::sun::star::text::SectionFileLink::FilterName
62    /** contains the name of the file filter that is used to load the linked file.
63     */
64    string FilterName;
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72#endif
73