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

   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
  28 #ifndef __com_sun_star_text_TextRangeContentProperties_idl__
  29 #define __com_sun_star_text_TextRangeContentProperties_idl__
  30
  31 #ifndef __com_sun_star_table_XCell_idl__
  32 #include <com/sun/star/table/XCell.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_text_XTextContent_idl__
  36 #include <com/sun/star/text/XTextContent.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_text_XDocumentIndex_idl__
  40 #include <com/sun/star/text/XDocumentIndex.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_text_XTextTable_idl__
  44 #include <com/sun/star/text/XTextTable.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_text_XTextFrame_idl__
  48 #include <com/sun/star/text/XTextFrame.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_text_XTextSection_idl__
  52 #include <com/sun/star/text/XTextSection.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_text_XDocumentIndexMark_idl__
  56 #include <com/sun/star/text/XDocumentIndexMark.idl>
  57 #endif
  58
  59 #ifndef __com_sun_star_text_XFootnote_idl__
  60 #include <com/sun/star/text/XFootnote.idl>
  61 #endif
  62
  63
  64 //=============================================================================
  65
  66 module com {  module sun {  module star {  module text {
  67
  68 //=============================================================================
  69
  70 /** describes the structural properties to retrieve text contents.
  71
  72     @since OOo 3.3
  73  */
  74 service TextRangeContentProperties
  75 {
  76     //-------------------------------------------------------------------------
  77     /** may contain a document index. */
  78     [optional, readonly, property] com::sun::star::text::XDocumentIndex
  79         DocumentIndex;
  80
  81     //-------------------------------------------------------------------------
  82     /** may contain a text table. */
  83     [optional, readonly, property] com::sun::star::text::XTextTable
  84         TextTable;
  85
  86     //-------------------------------------------------------------------------
  87     /** may contain a table cell. */
  88     [optional, readonly, property] com::sun::star::table::XCell Cell;
  89
  90     //-------------------------------------------------------------------------
  91     /** may contain a text frame. */
  92     [optional, readonly, property] com::sun::star::text::XTextFrame
  93         TextFrame;
  94
  95     //-------------------------------------------------------------------------
  96     /** may contain a text section. */
  97     [optional, readonly, property] com::sun::star::text::XTextSection
  98         TextSection;
  99
 100     //-------------------------------------------------------------------------
 101     /** may contain a document index mark. */
 102     [optional, readonly, property] com::sun::star::text::XDocumentIndexMark
 103         DocumentIndexMark;
 104
 105     //-------------------------------------------------------------------------
 106     /** may contain a reference mark. */
 107     [optional, readonly, property] com::sun::star::text::XTextContent
 108         ReferenceMark;
 109
 110     //-------------------------------------------------------------------------
 111     /** may contain a footnote. */
 112     [optional, readonly, property] com::sun::star::text::XFootnote Footnote;
 113
 114     //-------------------------------------------------------------------------
 115     /** may contain a endnote. */
 116     [optional, readonly, property] com::sun::star::text::XFootnote Endnote;
 117
 118     //-------------------------------------------------------------------------
 119     /** may contain a nested text content.
 120
 121         For example, may contain an <type>InContentMetadata</type> or a
 122         <type scope="com::sun::star::text::textfield">MetadataField</type>.
 123      */
 124     [optional, readonly, property] com::sun::star::text::XTextContent
 125         NestedTextContent;
 126
 127 };
 128
 129 //=============================================================================
 130
 131 }; }; }; };
 132
 133 #endif