path: root/offapi/com/sun/star/text/BaseFrame.idl

/*************************************************************************
 *
 *  $RCSfile: BaseFrame.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: os $ $Date: 2001-02-15 14:35:20 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_text_BaseFrame_idl__
#define __com_sun_star_text_BaseFrame_idl__

#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

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

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

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

/** specifies the base service of text frames, graphic objects and embedded objects
 */
service BaseFrame
{
    //-------------------------------------------------------------------------
    /** 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.
     */
    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 number of the page where the objects are anchored.
        <p> The value is valid only if the
        <type>TextContentAnchorType</type> is
        <const>TextContentAnchorType::AT_PAGE</const>.</p>
     */
    [property] short AnchorPageNo;
    //-------------------------------------------------------------------------
    /** contains the color of the background of the object.
     */
    [property] long BackColor;
    //-------------------------------------------------------------------------
    /** contains the URL for the background graphic.
     */
    [property] string BackGraphicURL;

    //-------------------------------------------------------------------------
    /** contains the name of the file filter for the background graphic.
     */
    [property] string BackGraphicFilter;

    //-------------------------------------------------------------------------
    /** determines the position of the background graphic.@see GraphicLocation
     */
    [property] com::sun::star::style::GraphicLocation BackGraphicLocation;

    //-------------------------------------------------------------------------
    /** contains the left border of the object.@see com::sun::star::table::BorderLine
     */
    [property] com::sun::star::table::BorderLine LeftBorder;

    //-------------------------------------------------------------------------
    /** contains the right border of the object.@see com::sun::star::table::BorderLine
     */
    [property] com::sun::star::table::BorderLine RightBorder;

    //-------------------------------------------------------------------------
    /** contains the top border of the object.@see com::sun::star::table::BorderLine
     */
    [property] com::sun::star::table::BorderLine TopBorder;

    //-------------------------------------------------------------------------
    /** contains the bottom border of the object.@see com::sun::star::table::BorderLine
     */
    [property] com::sun::star::table::BorderLine BottomBorder;

    //-------------------------------------------------------------------------
    /** contains the distance from the border to the object.
     */
    [property] long BorderDistance;

    //-------------------------------------------------------------------------
    /** contains the distance from the left border to the object.
     */
    [property] long LeftBorderDistance;

    //-------------------------------------------------------------------------
    /** contains the distance from the right border to the object.
     */
    [property] long RightBorderDistance;

    //-------------------------------------------------------------------------
    /** contains the distance from the top border to the object.
     */
    [property] long TopBorderDistance;

    //-------------------------------------------------------------------------
    /** contains the distance from the bottom border to the object.
     */
    [property] long BottomBorderDistance;

    //-------------------------------------------------------------------------
    /** If TRUE, the "BackColor" is ignored.
     */
    [property] boolean BackTransparent;

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

    /** determines if the content is protected.
     */
    [property] boolean ContentProtected;
    //-------------------------------------------------------------------------
    /** contains the name of the frame style that is applied to this object.
     */
    [property] string FrameStyle;

    //-------------------------------------------------------------------------
    /** contains the left margin of the object.
     */
    [property] long LeftMargin;

    //-------------------------------------------------------------------------
    /** contains the right margin of the object.
     */
    [property] long RightMargin;

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

    /** contains the top margin of the object.
     */
    [property] long TopMargin;

    //-------------------------------------------------------------------------
    /** contains the bottom margin of the object.
     */
    [property] long BottomMargin;

    //-------------------------------------------------------------------------
    /** contains the height of the object (1/100 mm).
        <p>It is only valid if <member>TextEmbeddedObject::RelativeHeight</member> is zero.</p>
     */
    [property] long Height;

    //-------------------------------------------------------------------------
    /** contains the width of the object (1/100 mm).
        <p>It is only valid if <member>TextEmbeddedObject::RelativeWidth</member> is zero.</p>
     */
    [property] long Width;
    //-------------------------------------------------------------------------
    /** contains the relative height of the object.
        <p> It is only valid if it is greater than zero.</p>
     */
    [property] short RelativeHeight;

    //-------------------------------------------------------------------------
    /** contains the relative width of the object.
        <p> It is only valid if it is greater than zero. </p>
     */
    [property] short RelativeWidth;
    //-------------------------------------------------------------------------
    /** determins whether the width follows the height.
     */
    [property] boolean IsSyncWidthToHeight;
    //-------------------------------------------------------------------------
    /** determins whether the height follows the width.
     */
    [property] boolean IsSyncHeightToWidth;
    //-------------------------------------------------------------------------
    /** determines the horizontal orientation of the object.@see HoriOrientation
     */
    [property] short HoriOrient;
    //-------------------------------------------------------------------------
    /** contains the horizontal position of the object (1/100 mm).
        <p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p>
     */
    [property] long HoriOrientPosition;

    //-------------------------------------------------------------------------
    /** determines the environment of the object to which the orientation
        is related.@see RelOrientation
     */
    [property] short HoriOrientRelation;

    //-------------------------------------------------------------------------
    /** determines the vertical orientation of the object.@see VertOrientation
     */
    [property] short VertOrient;

    //-------------------------------------------------------------------------
    /** contains the vertical position of the object (1/100 mm).

        It is only valid if <member>TextEmbeddedObject::VertOrient</member> is
        <const>VertOrientation::NONE</const>.
     */
    [property] long VertOrientPosition;

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

    /** determines the environment of the object to which the orientation is related.@see RelOrientation
     */
    [property] short VertOrientRelation;

    //-------------------------------------------------------------------------
    /** contains the URL of a hyperlink that is set at the object.
     */
    [property] string HyperLinkURL;

    //-------------------------------------------------------------------------
    /** contains the name of the target for a hyperlink that is set at the object.
     */
    [property] string HyperLinkTarget;

    //-------------------------------------------------------------------------
    /** contains the name of the hyperlink that is set at the object.
     */
    [property] string HyperLinkName;

    //-------------------------------------------------------------------------
    /** determines if the object is opaque or transparent for text.
     */
    [property] boolean Opaque;

    //-------------------------------------------------------------------------
    /** determines if the object is mirrored on even pages.
     */
    [property] boolean PageToggle;

    //-------------------------------------------------------------------------
    /** determines if the position is protected.
     */
    [property] boolean PositionProtected;

    //-------------------------------------------------------------------------
    /** determines if the object is included in printing.
     */
    [property] boolean Print;

    //-------------------------------------------------------------------------
    /** contains the type of the shadow of the object.@see ShadowFormat
     */
    [property] com::sun::star::table::ShadowFormat ShadowFormat;

    //-------------------------------------------------------------------------
    /** determines if the object gets an image map from a server.
     */
    [property] boolean ServerMap;

    //-------------------------------------------------------------------------
    /** contains the size of the object.@see Height
                @see Width
     */
    [property] com::sun::star::awt::Size Size;

    //-------------------------------------------------------------------------
    /** determines if the size is protected.
     */
    [property] boolean SizeProtected;

    //-------------------------------------------------------------------------
    /** the relative size to the size from the container object.
        That isn't a metric value, its specify how large the object relative to the container object is.
     */
    [property] boolean SizeRelative;

    //-------------------------------------------------------------------------
    /** determines the type of the surrounding text.@see WrapTextMode
     */
    [property] short Surround;

    //-------------------------------------------------------------------------
    /** determines if the text of the paragraph in which the object
        is anchored wraps around the object.
     */
    [property] boolean SurroundAnchorOnly;

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


    /** contains the wrapping of the object.@see WrapTextMode
     */
    [property] short TextWrap;




};

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

}; }; }; };

#endif