xref: /aoo41x/main/offapi/com/sun/star/text/TextRangeContentProperties.idl (revision 2a413f17)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_text_TextRangeContentProperties_idl__
#define __com_sun_star_text_TextRangeContentProperties_idl__

#ifndef __com_sun_star_table_XCell_idl__
#include <com/sun/star/table/XCell.idl>
#endif

#ifndef __com_sun_star_text_XTextContent_idl__
#include <com/sun/star/text/XTextContent.idl>
#endif

#ifndef __com_sun_star_text_XDocumentIndex_idl__
#include <com/sun/star/text/XDocumentIndex.idl>
#endif

#ifndef __com_sun_star_text_XTextTable_idl__
#include <com/sun/star/text/XTextTable.idl>
#endif

#ifndef __com_sun_star_text_XTextFrame_idl__
#include <com/sun/star/text/XTextFrame.idl>
#endif

#ifndef __com_sun_star_text_XTextSection_idl__
#include <com/sun/star/text/XTextSection.idl>
#endif

#ifndef __com_sun_star_text_XDocumentIndexMark_idl__
#include <com/sun/star/text/XDocumentIndexMark.idl>
#endif

#ifndef __com_sun_star_text_XFootnote_idl__
#include <com/sun/star/text/XFootnote.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module text {

//=============================================================================

/** describes the structural properties to retrieve text contents.

    @since OpenOffice 3.3
 */
service TextRangeContentProperties
{
    //-------------------------------------------------------------------------
    /** may contain a document index. */
    [optional, readonly, property] com::sun::star::text::XDocumentIndex
        DocumentIndex;

    //-------------------------------------------------------------------------
    /** may contain a text table. */
    [optional, readonly, property] com::sun::star::text::XTextTable
        TextTable;

    //-------------------------------------------------------------------------
    /** may contain a table cell. */
    [optional, readonly, property] com::sun::star::table::XCell Cell;

    //-------------------------------------------------------------------------
    /** may contain a text frame. */
    [optional, readonly, property] com::sun::star::text::XTextFrame
        TextFrame;

    //-------------------------------------------------------------------------
    /** may contain a text section. */
    [optional, readonly, property] com::sun::star::text::XTextSection
        TextSection;

    //-------------------------------------------------------------------------
    /** may contain a document index mark. */
    [optional, readonly, property] com::sun::star::text::XDocumentIndexMark
        DocumentIndexMark;

    //-------------------------------------------------------------------------
    /** may contain a reference mark. */
    [optional, readonly, property] com::sun::star::text::XTextContent
        ReferenceMark;

    //-------------------------------------------------------------------------
    /** may contain a footnote. */
    [optional, readonly, property] com::sun::star::text::XFootnote Footnote;

    //-------------------------------------------------------------------------
    /** may contain a endnote. */
    [optional, readonly, property] com::sun::star::text::XFootnote Endnote;

    //-------------------------------------------------------------------------
    /** may contain a nested text content.

        For example, may contain an <type>InContentMetadata</type> or a
        <type scope="com::sun::star::text::textfield">MetadataField</type>.
     */
    [optional, readonly, property] com::sun::star::text::XTextContent
        NestedTextContent;

};

//=============================================================================

}; }; }; };

#endif