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