offapi/com/sun/star/text/ChainedTextFrame.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_ChainedTextFrame_idl__
  20 #define __com_sun_star_text_ChainedTextFrame_idl__
  21
  22 #include <com/sun/star/text/TextFrame.idl>
  23
  24 #include <com/sun/star/util/XChainable.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30
  31 /** extends a TextFrame which shares the same Text
  32     with other ChainedTextFrame instances that will make the text
  33     flow through the chained frames. The text flows in the next frame if
  34     there is no space left in the current frame.
  35  */
  36 published service ChainedTextFrame
  37 {
  38     service com::sun::star::text::TextFrame;
  39
  40     /** name of the previous frame in the chain
  41
  42         <p>An empty string indicates that there is no previous frame.</p>
  43      */
  44     [property, maybevoid] string ChainNextName;
  45
  46     /** name of the next frame in the chain
  47
  48         <p>An empty string indicates that there is no next frame.</p>
  49      */
  50     [property, maybevoid] string ChainPrevName;
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */