/************************************************************************* * * $RCSfile: BaseFrameProperties.idl,v $ * * $Revision: 1.4 $ * * last change: $Author: kz $ $Date: 2004-05-19 10:43:46 $ * * 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_BaseFrameProperties_idl__ #define __com_sun_star_text_BaseFrameProperties_idl__ #ifndef __com_sun_star_style_GraphicLocation_idl__ #include #endif #ifndef __com_sun_star_table_BorderLine_idl__ #include #endif #ifndef __com_sun_star_table_ShadowFormat_idl__ #include #endif #ifndef __com_sun_star_text_XTextFrame_idl__ #include #endif #ifndef __com_sun_star_text_WrapTextMode_idl__ #include #endif #ifndef __com_sun_star_awt_Size_idl__ #include #endif #ifndef __com_sun_star_util_Color_idl__ #include #endif //============================================================================= module com { module sun { module star { module text { //============================================================================= /** specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles. */ service BaseFrameProperties { //------------------------------------------------------------------------- /** contains the number of the page where the objects are anchored.

The value is valid only if the AnchorType is TextContentAnchorType::AT_PAGE.

*/ [property] short AnchorPageNo; //------------------------------------------------------------------------- /** contains the text frame the current frame is anchored to.

The value is valid only if the AnchorType is TextContentAnchorType::AT_FRAME.

*/ [property] com::sun::star::text::XTextFrame AnchorFrame; //------------------------------------------------------------------------- /** contains the color of the background of the object. */ [property] com::sun::star::util::Color 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. */ [property] com::sun::star::style::GraphicLocation BackGraphicLocation; //------------------------------------------------------------------------- /** contains the left border of the object. @see BaseFrame::com::sun::star::table::BorderLine */ [property] com::sun::star::table::BorderLine LeftBorder; //------------------------------------------------------------------------- /** contains the right border of the object. @see BaseFrame::com::sun::star::table::BorderLine */ [property] com::sun::star::table::BorderLine RightBorder; //------------------------------------------------------------------------- /** contains the top border of the object. @see BaseFrame::com::sun::star::table::BorderLine */ [property] com::sun::star::table::BorderLine TopBorder; //------------------------------------------------------------------------- /** contains the bottom border of the object. @see BaseFrame::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 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).

It is only valid if TextEmbeddedObject::RelativeHeight is zero.

*/ [property] long Height; //------------------------------------------------------------------------- /** contains the width of the object (1/100 mm).

It is only valid if TextEmbeddedObject::RelativeWidth is zero.

*/ [property] long Width; //------------------------------------------------------------------------- /** contains the relative height of the object.

It is only valid if it is greater than zero.

*/ [property] short RelativeHeight; //------------------------------------------------------------------------- /** contains the relative width of the object.

It is only valid if it is greater than zero.

*/ [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 BaseFrame::HoriOrientation */ [property] short HoriOrient; //------------------------------------------------------------------------- /** contains the horizontal position of the object (1/100 mm).

It is only valid if "HoriOrient" is HoriOrientation_NONE.

*/ [property] long HoriOrientPosition; //------------------------------------------------------------------------- /** determines the environment of the object to which the orientation is related. @see BaseFrame::RelOrientation */ [property] short HoriOrientRelation; //------------------------------------------------------------------------- /** determines the vertical orientation of the object. @see BaseFrame::VertOrientation */ [property] short VertOrient; //------------------------------------------------------------------------- /** contains the vertical position of the object (1/100 mm). It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE. */ [property] long VertOrientPosition; //------------------------------------------------------------------------- /** determines the environment of the object to which the orientation is related. @see BaseFrame::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. */ [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 BaseFrame::Height @see BaseFrame::Width */ [property] com::sun::star::awt::Size Size; //------------------------------------------------------------------------- /** determines if the size is protected. */ [property] boolean SizeProtected; //------------------------------------------------------------------------- /** determines the type of the surrounding text. @deprecated */ [property] com::sun::star::text::WrapTextMode Surround; //------------------------------------------------------------------------- /** determines if the text of the paragraph in which the object is anchored, wraps around the object. */ [property] boolean SurroundAnchorOnly; }; //============================================================================= }; }; }; }; #endif