xref: /aoo41x/main/offapi/com/sun/star/text/TextContent.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_TextContent_idl__
#define __com_sun_star_text_TextContent_idl__

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

#ifndef __com_sun_star_text_TextContentAnchorType_idl__
#include <com/sun/star/text/TextContentAnchorType.idl>
#endif

#ifndef __com_sun_star_text_WrapTextMode_idl__
#include <com/sun/star/text/WrapTextMode.idl>
#endif


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

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

//=============================================================================
/** is an object which can be anchored in a text, like instances of
	<type>TextFrame</type> or <type>TextField</type>.

	<p>If the concrete <type>TextContent</type> has a textual
	representation which fades into the surrounding text, then
	<type>XTextField</type> is used.

	<p>If the concrete <type>TextContent</type> has a "floating" object,
	like a graphic, <type scope="com::sun::star::drawing">XShape</type>
	is used.

	@see TextField
	@see TextTable
	@see TextFrame
	@see TextSection
	@see TextGraphicObject
	@see TextEmbeddedObject
*/
published service TextContent
{

	/** This interface is used for the attachment of this text content
		to the surrounding text.
	*/
	interface com::sun::star::text::XTextContent;

	//-------------------------------------------------------------------------
	/** specifies how the text content is attached to its surrounding
		<type>Text</type>.
	*/
	[optional, property] com::sun::star::text::TextContentAnchorType AnchorType;

	//-------------------------------------------------------------------------
	/** contains the anchor type of the text content.
	 @see com::sun::star::text::TextContentAnchorType
	 */
	[optional, readonly, property] sequence<com::sun::star::text::TextContentAnchorType> AnchorTypes;

	//-------------------------------------------------------------------------
	/** specifies if the text content is a shape
		and how the text is wrapped around the shape.
	*/
	[optional, property] com::sun::star::text::WrapTextMode TextWrap;

};

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

}; }; }; };

#endif