/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTextContent.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-11-11 13:24:48 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XTextContent_idl__
#define __com_sun_star_text_XTextContent_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_text_XTextRange_idl__
#include <com/sun/star/text/XTextRange.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


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

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

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

/** enables objects to be inserted into a text and to provide their
    location in a text once they are inserted into it.
 */
published interface XTextContent: com::sun::star::lang::XComponent
{
    //-------------------------------------------------------------------------

    /** is called when this object gets embedded in a text.



        <p>This acts like a multi-phase construction, thus the object may be
        invalid until it is attached to a text position. In general, this method
        is called from within




        .

        </p>
        <p>Both text objects and text content objects may only be connected
        to each other if they are created by the same component. When
        implementing new components, this behaviour is deprecated.</p>
     */
    void attach( [in] com::sun::star::text::XTextRange xTextRange )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------

    /** @returns
                the text range to which the content is attached.

        <p>Note: The anchor of the actual implementation for text tables
        does not have a position in the text. Thus that anchor can not be
        used for some operation like <member>attach</member> for example or
        <member scope="com::sun::star::text">insertTextContent</member>
        or other function that require the object to have a position in the text.</p>

        <p>The reason why a text table still needs an anchor is that for example
        tables should be insertable via <member scope="com::sun::star::text">insertTextContent</member>
        and that interface uses a parameter of that type.</p>
     */
    com::sun::star::text::XTextRange getAnchor();

};

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

}; }; }; };

#endif
