offapi/com/sun/star/text/Text.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
  22  module com {  module sun {  module star {  module text {
  23
  24  published interface XText;
  25  published interface XTextRangeMover;
  26  published interface XTextRangeCompare;
  27  published interface XRelativeTextContentInsert;
  28
  29 /** is an independent piece of text which consists of a
  30     series of one or more paragraphs.
  31
  32     <p>This service is used, for example, for the text of a TextDocument
  33     or the text in a cell or TextFrame.
  34
  35     @see com::sun::star::text::TextDocument
  36     @see com::sun::star::text::TextFrame
  37     @see com::sun::star::table::Cell
  38  */
  39 published service Text
  40 {
  41     /** This is the factory for an enumeration of the paragraphs in this text.
  42
  43         <p>This interface is mainly useful for exporting the text to a
  44         data format.
  45      */
  46     interface com::sun::star::container::XEnumerationAccess;
  47
  48
  49     /** provides a cursor factory and the possibility to insert and remove contents.
  50      */
  51     interface XText;
  52
  53
  54     /** optional interface to compare positions of TextRange
  55                 instances within this text.
  56      */
  57     [optional] interface XTextRangeCompare;
  58
  59
  60     /** makes it possible to change the position of paragraphs.
  61
  62      */
  63     [optional] interface XTextRangeMover;
  64
  65
  66     /** makes it possible to insert a new text content, before or
  67                    after existing text contents.
  68
  69                    @deprecated hack
  70      */
  71     [optional] interface XRelativeTextContentInsert;
  72
  73
  74     /** contains the properties of a redline at the start of the document.<br>
  75     The sequence contains the following properties
  76     <UL>
  77         <LI><P>string RedlineAuthor        </P></LI>
  78         <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
  79         <LI><P>string RedlineComment       </P></LI>
  80         <LI><P>string RedlineType          </P></LI>
  81         <LI><P>string RedlineIdentifier    </P></LI>
  82         <LI><P>boolean IsCollapsed          </P></LI>
  83         <LI><P>boolean IsStart              </P></LI>
  84         <LI><P>boolean MergeLastPara        </P></LI>
  85         <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
  86         <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
  87             (contains the same properties except for the RedlineSuccessorData)</P></LI>
  88     </UL>
  89      @see EndRedline
  90      */
  91     [optional, property] ::com::sun::star::beans::PropertyValues StartRedline;
  92
  93
  94     /** contains the properties of a redline at the start of the document.
  95     The sequence contains the following properties
  96     <UL>
  97         <LI><P>string RedlineAuthor        </P></LI>
  98         <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
  99         <LI><P>string RedlineComment       </P></LI>
 100         <LI><P>string RedlineType          </P></LI>
 101         <LI><P>string RedlineIdentifier    </P></LI>
 102         <LI><P>boolean IsCollapsed          </P></LI>
 103         <LI><P>boolean IsStart              </P></LI>
 104         <LI><P>boolean MergeLastPara        </P></LI>
 105         <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
 106         <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
 107             (contains the same properties except for the RedlineSuccessorData)</P></LI>
 108     </UL>
 109      @see StartRedline
 110      */
 111     [optional, maybevoid, property] ::com::sun::star::beans::PropertyValues EndRedline;
 112
 113
 114 };
 115
 116
 117 }; }; }; };
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */