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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_BaseFrame_idl__
  28 #define __com_sun_star_text_BaseFrame_idl__
  29
  30 #ifndef __com_sun_star_text_BaseFrameProperties_idl__
  31 #include <com/sun/star/text/BaseFrameProperties.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_text_TextContent_idl__
  35 #include <com/sun/star/text/TextContent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_drawing_XShape_idl__
  39 #include <com/sun/star/drawing/XShape.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_XNamed_idl__
  47 #include <com/sun/star/container/XNamed.idl>
  48 #endif
  49 #ifndef __com_sun_star_style_GraphicLocation_idl__
  50 #include <com/sun/star/style/GraphicLocation.idl>
  51 #endif
  52 #ifndef __com_sun_star_table_BorderLine_idl__
  53 #include <com/sun/star/table/BorderLine.idl>
  54 #endif
  55 #ifndef __com_sun_star_table_ShadowFormat_idl__
  56 #include <com/sun/star/table/ShadowFormat.idl>
  57 #endif
  58 #ifndef __com_sun_star_text_XTextFrame_idl__
  59 #include <com/sun/star/text/XTextFrame.idl>
  60 #endif
  61
  62 //=============================================================================
  63
  64  module com {  module sun {  module star {  module text {
  65
  66 //=============================================================================
  67
  68 /** specifies the base service of text frames, graphic objects, and embedded objects
  69  */
  70 published service BaseFrame
  71 {
  72     service BaseFrameProperties;
  73     service TextContent;
  74     //-------------------------------------------------------------------------
  75     /** This interface specifies the access to the shape data (position
  76                 and size) of the text frame.
  77
  78                 <p>This interface is valid before the text frame is attached
  79                 to a surrounding text, but when attached the values can change
  80                 (e.g., due to a revised layout of the surrounding text).
  81
  82                 <p>The position is relative to the position of the anchor
  83                 [see <member>XTextFrame::getAnchor()</member>]. Size and position are
  84                 both measured in 100th mm. The size is not valid if the
  85                 size is relative and no layout exists or if the layout is invalid.
  86
  87                 <p>This interface is only for the layout.  In particular, the
  88                 setting of values is only allowed for the layout component of the
  89                 owner text of this text component.
  90      */
  91     [optional] interface com::sun::star::drawing::XShape;
  92     //-------------------------------------------------------------------------
  93     /** This interface makes it possible to access the properties of
  94                 this text frame.
  95
  96                 <p>This interface is valid before the text frame is attached to
  97                 a surrounding text.
  98      */
  99     interface com::sun::star::beans::XPropertySet;
 100     //-------------------------------------------------------------------------
 101     /** This interface specifies the name of this text frame.
 102
 103                 <p>The name may be set automatically by the container if it is not
 104                 set when inserted. In this case a random, unique name is assigned.
 105      */
 106     interface com::sun::star::container::XNamed;
 107     //-------------------------------------------------------------------------
 108     /** contains the name of the frame style that is applied to this object.
 109      */
 110     [property] string FrameStyleName;
 111
 112 };
 113
 114 //=============================================================================
 115
 116 }; }; }; };
 117
 118 #endif