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