offapi/com/sun/star/text/TextFrame.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TextFrame.idl,v $
  10  * $Revision: 1.14.122.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_TextFrame_idl__
  31 #define __com_sun_star_text_TextFrame_idl__
  32
  33 #ifndef __com_sun_star_text_XTextFrame_idl__
  34 #include <com/sun/star/text/XTextFrame.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_BaseFrame_idl__
  38 #include <com/sun/star/text/BaseFrame.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module text {
  44
  45 //=============================================================================
  46
  47 /** specifies a rectangular shape which contains a <type>Text</type> object
  48     and is attached to a piece of surrounding <type>Text</type>.
  49
  50     @see Text
  51
  52     @example StarBasic
  53
  54     <p>This example shows how to create a <type>TextFrame</type> and insert
  55     it at the very beginning of <type>Text</type> component. The macro
  56     is ready to run, if it is a script within a text document. </p>
  57
  58     <listing>
  59     Sub Main
  60     oFrame = ThisComponent.createInstance( "com.sun.star.text.TextFrame" )
  61     oFrame.Width = 6000
  62     ThisComponent.Text.insertTextContent( ThisComponent.Text.Start, oFrame, false )
  63     oFrame.Text.String = "Hello, this text is within the frame."
  64     End Sub
  65     </listing>
  66  */
  67 published service TextFrame
  68 {
  69     /** contains the definition of interfaces and properties that are supported by text frames,
  70      graphic objects and embeddedobjects.
  71      */
  72     service BaseFrame;
  73
  74     /** This interface makes it possible to access the text within this
  75                 text frame.
  76      */
  77     interface com::sun::star::text::XTextFrame;
  78     //-------------------------------------------------------------------------
  79     /** contains the metric height value of the frame.
  80      */
  81     [property] long FrameHeightAbsolute;
  82
  83     //-------------------------------------------------------------------------
  84     /** contains the metric width value of the frame.
  85      */
  86     [property] long FrameWidthAbsolute;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** specifies a width relative to the width of the
  91         surrounding text.
  92         <p>If the value for "WidthPercent" is 0, the absolute value from
  93         is used.</p>
  94      */
  95     [property] byte FrameWidthPercent;
  96
  97     //-------------------------------------------------------------------------
  98     /** specifies a width relative to the width of the
  99         surrounding text.
 100
 101         <p>If the value for "HeightPercent" is 0, the absolute value from
 102         is used.</p>
 103      */
 104     [property] byte FrameHeightPercent;
 105     //-------------------------------------------------------------------------
 106     /** If "AutomaticHeight" is set, then the object grows if it is required
 107         by the frame content.
 108      */
 109     [property] boolean FrameIsAutomaticHeight;
 110     //-------------------------------------------------------------------------
 111     /** determines the interpretation of the height and relative
 112         height properties.
 113
 114             @see SizeType
 115      */
 116     [property] short SizeType;
 117     //-------------------------------------------------------------------------
 118     /** determines the interpretation of the width and relative
 119         width properties.
 120
 121         @see    SizeType
 122         @since  OOo 2.4
 123      */
 124     [optional, property] short WidthType;
 125     //-----------------------------------------------------------------------------
 126     /** contains the writing direction, as represented by the
 127         <type scope="com::sun::star::text">WritingMode2</type> constants
 128      */
 129     [optional, property] short WritingMode;
 130
 131     /** controls, if the frame follows the text flow or can leave its layout environment
 132
 133         <p>If set, the frame follows the text flow and doesn't leaves the layout
 134         environment, which is given by its anchor, above and below.
 135         E.g.: Anchor resides in the document body then the frame doesn't leave
 136         the document body above and below and follows the text flow through
 137         the document bodies of the different pages.
 138
 139         If not set, the frame doesn't follow the text flow and stays on the page,
 140         on which its anchor is found, but it may leave the layout environment,
 141         which is given by its anchor.
 142         E.g.: Anchor resides in the document body then the frame stays on page,
 143         where this document body is, but it could leave the document body above
 144         and below, e.g. overlapping with the page header.
 145
 146         Note: The areas for the vertical orientation relation at page areas are
 147         interpreted in dependence to this property (@see BaseFrameProperties.VertOrientRelation).
 148         If property is set, the page area is interpreted as the layout environment,
 149         given by its anchor. E.g.: Anchor resides in the page header then the
 150         page header determines the page area. If property isn't set, the page area is
 151         determined by the document page, the anchor is on. E.g.: Anchor resides
 152         in the page header then the document page, the page header is on, determines
 153         the page area.
 154         An exception of this interpretation rule is applied, if the anchor resides
 155         in a table cell. In this situation the page area is always detemined by
 156         the table cell.</p>
 157      */
 158     [optional, property] boolean IsFollowingTextFlow;
 159
 160 };
 161
 162 //=============================================================================
 163
 164 }; }; }; };
 165
 166 #endif