offapi/com/sun/star/text/BaseFrame.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: BaseFrame.idl,v $
  10  * $Revision: 1.16 $
  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_BaseFrame_idl__
  31 #define __com_sun_star_text_BaseFrame_idl__
  32
  33 #ifndef __com_sun_star_text_BaseFrameProperties_idl__
  34 #include <com/sun/star/text/BaseFrameProperties.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_TextContent_idl__
  38 #include <com/sun/star/text/TextContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_XShape_idl__
  42 #include <com/sun/star/drawing/XShape.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XPropertySet_idl__
  46 #include <com/sun/star/beans/XPropertySet.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_XNamed_idl__
  50 #include <com/sun/star/container/XNamed.idl>
  51 #endif
  52 #ifndef __com_sun_star_style_GraphicLocation_idl__
  53 #include <com/sun/star/style/GraphicLocation.idl>
  54 #endif
  55 #ifndef __com_sun_star_table_BorderLine_idl__
  56 #include <com/sun/star/table/BorderLine.idl>
  57 #endif
  58 #ifndef __com_sun_star_table_ShadowFormat_idl__
  59 #include <com/sun/star/table/ShadowFormat.idl>
  60 #endif
  61 #ifndef __com_sun_star_text_XTextFrame_idl__
  62 #include <com/sun/star/text/XTextFrame.idl>
  63 #endif
  64
  65 //=============================================================================
  66
  67  module com {  module sun {  module star {  module text {
  68
  69 //=============================================================================
  70
  71 /** specifies the base service of text frames, graphic objects, and embedded objects
  72  */
  73 published service BaseFrame
  74 {
  75     service BaseFrameProperties;
  76     service TextContent;
  77     //-------------------------------------------------------------------------
  78     /** This interface specifies the access to the shape data (position
  79                 and size) of the text frame.
  80
  81                 <p>This interface is valid before the text frame is attached
  82                 to a surrounding text, but when attached the values can change
  83                 (e.g., due to a revised layout of the surrounding text).
  84
  85                 <p>The position is relative to the position of the anchor
  86                 [see <member>XTextFrame::getAnchor()</member>]. Size and position are
  87                 both measured in 100th mm. The size is not valid if the
  88                 size is relative and no layout exists or if the layout is invalid.
  89
  90                 <p>This interface is only for the layout.  In particular, the
  91                 setting of values is only allowed for the layout component of the
  92                 owner text of this text component.
  93      */
  94     [optional] interface com::sun::star::drawing::XShape;
  95     //-------------------------------------------------------------------------
  96     /** This interface makes it possible to access the properties of
  97                 this text frame.
  98
  99                 <p>This interface is valid before the text frame is attached to
 100                 a surrounding text.
 101      */
 102     interface com::sun::star::beans::XPropertySet;
 103     //-------------------------------------------------------------------------
 104     /** This interface specifies the name of this text frame.
 105
 106                 <p>The name may be set automatically by the container if it is not
 107                 set when inserted. In this case a random, unique name is assigned.
 108      */
 109     interface com::sun::star::container::XNamed;
 110     //-------------------------------------------------------------------------
 111     /** contains the name of the frame style that is applied to this object.
 112      */
 113     [property] string FrameStyleName;
 114
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif