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_TextSection_idl__ 24#define __com_sun_star_text_TextSection_idl__ 25 26#ifndef __com_sun_star_text_TextContent_idl__ 27#include <com/sun/star/text/TextContent.idl> 28#endif 29 30#ifndef __com_sun_star_text_XTextSection_idl__ 31#include <com/sun/star/text/XTextSection.idl> 32#endif 33 34#ifndef __com_sun_star_container_XNamed_idl__ 35#include <com/sun/star/container/XNamed.idl> 36#endif 37 38#ifndef __com_sun_star_beans_XPropertySet_idl__ 39#include <com/sun/star/beans/XPropertySet.idl> 40#endif 41 42#ifndef __com_sun_star_beans_XPropertyState_idl__ 43#include <com/sun/star/beans/XPropertyState.idl> 44#endif 45 46#ifndef __com_sun_star_text_SectionFileLink_idl__ 47#include <com/sun/star/text/SectionFileLink.idl> 48#endif 49#ifndef __com_sun_star_style_GraphicLocation_idl__ 50#include <com/sun/star/style/GraphicLocation.idl> 51#endif 52#ifndef __com_sun_star_text_XTextColumns_idl__ 53#include <com/sun/star/text/XTextColumns.idl> 54#endif 55#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_ 56#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> 57#endif 58 59 60//============================================================================= 61 62module com { module sun { module star { module text { 63 64//============================================================================= 65/** A <type>TextSection</type> is a range of complete paragraphs within a text. 66 67 <p>The content of the section may be the content of a link into another 68 document, a link from the same document, or the result of a DDE 69 operation. 70 71 <p><type>TextSection</type> instances can be linked from and to other 72 texts. 73 74*/ 75published service TextSection 76{ 77 service com::sun::star::text::TextContent; 78 79 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; 80 81 interface com::sun::star::text::XTextSection; 82 interface com::sun::star::container::XNamed; 83 interface com::sun::star::beans::XPropertySet; 84 interface com::sun::star::beans::XPropertyState; 85 86 //------------------------------------------------------------------------- 87 /** This property contains a conditional expression. 88 89 <p>If the result of the conditional expression is <true/> and the property 90 <member>TextSection::IsVisible</member> is <false/>, then the section is hidden.</p> 91 */ 92 [property] string Condition; 93 94 //------------------------------------------------------------------------- 95 /** If this property is <FALSE/>, the text section is hidden. 96 */ 97 [property] boolean IsVisible; 98 99 //------------------------------------------------------------------------- 100 /** If this property is <TRUE/>, the text section is protected 101 and cannot be modified from the user interface. 102 */ 103 [property] boolean IsProtected; 104 105 //------------------------------------------------------------------------- 106 /** If this property is set, then the content of the section is read 107 from the specified document. 108 109 */ 110 [property] com::sun::star::text::SectionFileLink FileLink; 111 112 //------------------------------------------------------------------------- 113 /** specifies the source of a file link in the document that is 114 specified in <member>TextSection::FileLink</member>. 115 116 <p>The source may be a text section or a bookmark. 117 If <member>TextSection::FileLink</member> is empty, then the 118 current document is searched for the source. If this property 119 is empty and <member>TextSection::FileLink</member> is set, 120 then the complete document content is linked into this section.</p> 121 */ 122 [property] string LinkRegion; 123 124 //------------------------------------------------------------------------- 125 /** specifies the type of the command string for a DDE operation. 126 <p>The type can be the name of the application that provides a DDE source.</p> 127 */ 128 [property] string DDECommandType; 129 130 //------------------------------------------------------------------------- 131 /** specifies the source file name of the command string for a DDE operation. 132 */ 133 [property] string DDECommandFile; 134 135 //------------------------------------------------------------------------- 136 /** specifies the source element of the command string for a DDE operation. 137 <p>The element can be i.e. a name of a cell in a sheet or a bookmark.</p> 138 */ 139 [property] string DDECommandElement; 140 141 //------------------------------------------------------------------------- 142 /** contains the URL for the background graphic. 143 */ 144 [property] string BackGraphicURL; 145 146 //------------------------------------------------------------------------- 147 /** contains the name of the file filter for the background graphic. 148 */ 149 [property] string BackGraphicFilter; 150 151 //------------------------------------------------------------------------- 152 /** determines the position of the background graphic. 153 154 @see GraphicLocation 155 */ 156 [property] com::sun::star::style::GraphicLocation BackGraphicLocation; 157 /** determines whether footnotes inside the section are displayed at the end of the 158 section text. 159 */ 160 [property] boolean FootnoteIsCollectAtTextEnd; 161 //------------------------------------------------------------------------- 162 /** determines whether the footnotes numbering restarts within the section. 163 This is only valid if <code>FootnoteIsRestartNumbering</code> is set. 164 */ 165 [property] boolean FootnoteIsRestartNumbering; 166 //------------------------------------------------------------------------- 167 /** determines at which number the footnote numbering inside of the section starts. 168 This is only valid if <code>FootnoteIsRestartNumbering</code> is set. 169 */ 170 [property] short FootnoteRestartNumberingAt; 171 //------------------------------------------------------------------------- 172 /** determines whether the footnotes within the section use an own numbering format. 173 This is only valid if <code>FootnoteIsRestartNumbering</code> is set. 174 */ 175 [property] boolean FootnoteIsOwnNumbering; 176 //------------------------------------------------------------------------- 177 /** determines the numbering type of the footnote numbering as a value of 178 <type scope="com::sun::star::style">NumberingType</type>. 179 This is only valid if <code>FootnoteIsOwnNumbering</code> is set. 180 */ 181 [property] short FootnoteNumberingType; 182 //------------------------------------------------------------------------- 183 /** determines the prefix that is display before the footnote number. 184 This is only valid if <code>FootnoteIsOwnNumbering</code> is set. 185 */ 186 [property] string FootnoteNumberingPrefix; 187 //------------------------------------------------------------------------- 188 /** determines the suffix that is display after of the footnote number. 189 This is only valid if <code>FootnoteIsOwnNumbering</code> is set. 190 */ 191 [property] string FootnoteNumberingSuffix; 192 //------------------------------------------------------------------------- 193 /** determines whether endnotes inside the section are displayed at the end of the 194 section text. 195 */ 196 [property] boolean EndnoteIsCollectAtTextEnd; 197 //------------------------------------------------------------------------- 198 /** determines whether the endnotes numbering restarts within the section. 199 This is only valid if <code>EndnoteIsRestartNumbering</code> is set. 200 */ 201 [property] boolean EndnoteIsRestartNumbering; 202 //------------------------------------------------------------------------- 203 /** determines at which number the endnote numbering inside of the section starts. 204 This is only valid if <code>EndnoteIsRestartNumbering</code> is set. 205 */ 206 [property] short EndnoteRestartNumberingAt; 207 //------------------------------------------------------------------------- 208 /** determines whether the endnotes within the section use an own numbering format. 209 This is only valid if <code>EndnoteIsRestartNumbering</code> is set. 210 */ 211 [property] boolean EndnoteIsOwnNumbering; 212 //------------------------------------------------------------------------- 213 /** determines the numbering type of the endnote numbering as a value of 214 <type scope="com::sun::star::style">NumberingType</type>. 215 This is only valid if <code>EndoteIsOwnNumbering</code> is set. 216 */ 217 [property] short EndnoteNumberingType; 218 //------------------------------------------------------------------------- 219 /** determines the prefix that is display before the endnote number. 220 This is only valid if <code>EndnoteIsOwnNumbering</code> is set. 221 */ 222 [property] string EndnoteNumberingPrefix; 223 //------------------------------------------------------------------------- 224 /** determines the suffix that is display after the endnote number. 225 This is only valid if <code>EndnoteIsOwnNumbering</code> is set. 226 */ 227 [property] string EndnoteNumberingSuffix; 228 //------------------------------------------------------------------------- 229 /** determines if a DDE link is updated automatically. 230 */ 231 [property] boolean IsAutomaticUpdate; 232 //------------------------------------------------------------------------- 233 /** allows columns to be set into the text section 234 */ 235 [property] com::sun::star::text::XTextColumns TextColumns; 236 /** determines the left margin of the section 237 */ 238 [optional, property] long SectionLeftMargin; 239 //------------------------------------------------------------------------- 240 /** determines the left margin of the section 241 */ 242 [optional, property] long SectionRightMargin; 243 //------------------------------------------------------------------------- 244}; 245 246//============================================================================= 247 248}; }; }; }; 249 250#endif 251