xref: /aoo4110/main/offapi/com/sun/star/text/BaseFrame.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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