/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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 OOo 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