xref: /aoo41x/main/offapi/com/sun/star/text/BaseFrame.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_BaseFrame_idl__
#define __com_sun_star_text_BaseFrame_idl__

#ifndef __com_sun_star_text_BaseFrameProperties_idl__
#include <com/sun/star/text/BaseFrameProperties.idl>
#endif

#ifndef __com_sun_star_text_TextContent_idl__
#include <com/sun/star/text/TextContent.idl>
#endif

#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_style_GraphicLocation_idl__
#include <com/sun/star/style/GraphicLocation.idl>
#endif
#ifndef __com_sun_star_table_BorderLine_idl__
#include <com/sun/star/table/BorderLine.idl>
#endif
#ifndef __com_sun_star_table_ShadowFormat_idl__
#include <com/sun/star/table/ShadowFormat.idl>
#endif
#ifndef __com_sun_star_text_XTextFrame_idl__
#include <com/sun/star/text/XTextFrame.idl>
#endif

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

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

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

/** specifies the base service of text frames, graphic objects, and embedded objects
 */
published service BaseFrame
{
    service BaseFrameProperties;
    service TextContent;
    //-------------------------------------------------------------------------
	/** This interface specifies the access to the shape data (position
				and size) of the text frame.

				<p>This interface is valid before the text frame is attached
				to a surrounding text, but when attached the values can change
				(e.g., due to a revised layout of the surrounding text).

				<p>The position is relative to the position of the anchor
				[see <member>XTextFrame::getAnchor()</member>]. Size and position are
				both measured in 100th mm. The size is not valid if the
				size is relative and no layout exists or if the layout is invalid.

				<p>This interface is only for the layout.  In particular, the
				setting of values is only allowed for the layout component of the
				owner text of this text component.
	 */
	[optional] interface com::sun::star::drawing::XShape;
	//-------------------------------------------------------------------------
	/** This interface makes it possible to access the properties of
				this text frame.

				<p>This interface is valid before the text frame is attached to
				a surrounding text.
	 */
	interface com::sun::star::beans::XPropertySet;
	//-------------------------------------------------------------------------
	/** This interface specifies the name of this text frame.

				<p>The name may be set automatically by the container if it is not
				set when inserted. In this case a random, unique name is assigned.
	 */
	interface com::sun::star::container::XNamed;
    //-------------------------------------------------------------------------
	/** contains the name of the frame style that is applied to this object.
	 */
	[property] string FrameStyleName;

};

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

}; }; }; };

#endif