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
  20
  21  module com {  module sun {  module star {  module text {
  22
  23
  24 /** specifies the base service of text frames, graphic objects, and embedded objects
  25  */
  26 published service BaseFrame
  27 {
  28     service BaseFrameProperties;
  29     service TextContent;
  30     /** This interface specifies the access to the shape data (position
  31                 and size) of the text frame.
  32
  33                 <p>This interface is valid before the text frame is attached
  34                 to a surrounding text, but when attached the values can change
  35                 (e.g., due to a revised layout of the surrounding text).
  36
  37                 <p>The position is relative to the position of the anchor
  38                 [see XTextFrame::getAnchor()]. Size and position are
  39                 both measured in 100th mm. The size is not valid if the
  40                 size is relative and no layout exists or if the layout is invalid.
  41
  42                 <p>This interface is only for the layout.  In particular, the
  43                 setting of values is only allowed for the layout component of the
  44                 owner text of this text component.
  45      */
  46     [optional] interface com::sun::star::drawing::XShape;
  47     /** This interface makes it possible to access the properties of
  48                 this text frame.
  49
  50                 <p>This interface is valid before the text frame is attached to
  51                 a surrounding text.
  52      */
  53     interface com::sun::star::beans::XPropertySet;
  54     /** This interface specifies the name of this text frame.
  55
  56                 <p>The name may be set automatically by the container if it is not
  57                 set when inserted. In this case a random, unique name is assigned.
  58      */
  59     interface com::sun::star::container::XNamed;
  60     /** contains the name of the frame style that is applied to this object.
  61      */
  62     [property] string FrameStyleName;
  63
  64 };
  65
  66
  67 }; }; }; };
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */