xref: /trunk/main/offapi/com/sun/star/text/XText.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_XText_idl__
#define __com_sun_star_text_XText_idl__

#ifndef __com_sun_star_text_XSimpleText_idl__
#include <com/sun/star/text/XSimpleText.idl>
#endif

#ifndef __com_sun_star_text_XTextCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
#endif

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

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

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif


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

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

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

/** extends a <type>XSimpleText</type> by the capability of inserting
		<type>XTextContent</type>s.
 */
published interface XText: com::sun::star::text::XSimpleText
{
	//-------------------------------------------------------------------------

	/** inserts a content, such as a text table, text frame or text
		field.

		<p>Which contents are accepted is implementation-specific. Some
		implementations may only accept contents which were created by the
		factory that supplied the same text or the document which contains
		the text.
		</p>

        @param xRange
            specifies the position of insertion.

        @param xContent
            the text content to be inserted.

        @param bAbsorb
            specifies whether the text spanned by <var>xRange</var> will be
            replaced. If <TRUE/> then the content of <var>xRange</var> will
            be replaced by <var>xContent</var>, otherwise <var>xContent</var>
            will be inserted at the end of <var>xRange</var>.
	 */
	void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
			 [in] com::sun::star::text::XTextContent xContent,
			 [in] boolean bAbsorb )
			raises( com::sun::star::lang::IllegalArgumentException );

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

	/** removes the specified content from the text object.

		@example xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
	 */
	void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
			raises( com::sun::star::container::NoSuchElementException );

};

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

}; }; }; };

#endif