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