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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_BaseFrame_idl__
  20 #define __com_sun_star_text_BaseFrame_idl__
  21
  22 #include <com/sun/star/text/BaseFrameProperties.idl>
  23 #include <com/sun/star/text/TextContent.idl>
  24 #include <com/sun/star/drawing/XShape.idl>
  25 #include <com/sun/star/beans/XPropertySet.idl>
  26 #include <com/sun/star/container/XNamed.idl>
  27 #include <com/sun/star/style/GraphicLocation.idl>
  28 #include <com/sun/star/table/BorderLine.idl>
  29 #include <com/sun/star/table/ShadowFormat.idl>
  30 #include <com/sun/star/text/XTextFrame.idl>
  31
  32
  33  module com {  module sun {  module star {  module text {
  34
  35
  36 /** specifies the base service of text frames, graphic objects, and embedded objects
  37  */
  38 published service BaseFrame
  39 {
  40     service BaseFrameProperties;
  41     service TextContent;
  42     /** This interface specifies the access to the shape data (position
  43                 and size) of the text frame.
  44
  45                 <p>This interface is valid before the text frame is attached
  46                 to a surrounding text, but when attached the values can change
  47                 (e.g., due to a revised layout of the surrounding text).
  48
  49                 <p>The position is relative to the position of the anchor
  50                 [see XTextFrame::getAnchor()]. Size and position are
  51                 both measured in 100th mm. The size is not valid if the
  52                 size is relative and no layout exists or if the layout is invalid.
  53
  54                 <p>This interface is only for the layout.  In particular, the
  55                 setting of values is only allowed for the layout component of the
  56                 owner text of this text component.
  57      */
  58     [optional] interface com::sun::star::drawing::XShape;
  59     /** This interface makes it possible to access the properties of
  60                 this text frame.
  61
  62                 <p>This interface is valid before the text frame is attached to
  63                 a surrounding text.
  64      */
  65     interface com::sun::star::beans::XPropertySet;
  66     /** This interface specifies the name of this text frame.
  67
  68                 <p>The name may be set automatically by the container if it is not
  69                 set when inserted. In this case a random, unique name is assigned.
  70      */
  71     interface com::sun::star::container::XNamed;
  72     /** contains the name of the frame style that is applied to this object.
  73      */
  74     [property] string FrameStyleName;
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */