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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_Text_idl__
  28 #define __com_sun_star_text_Text_idl__
  29
  30 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  31 #include <com/sun/star/container/XEnumerationAccess.idl>
  32 #endif
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_PropertyValues_idl__
  37 #include <com/sun/star/beans/PropertyValues.idl>
  38 #endif
  39
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module text {
  44
  45  published interface XText;
  46  published interface XTextRangeMover;
  47  published interface XTextRangeCompare;
  48  published interface XRelativeTextContentInsert;
  49 //=============================================================================
  50
  51 /** is an independent piece of text which consists of a
  52     series of one or more paragraphs.
  53
  54     <p>This service is used, for example, for the text of a TextDocument
  55     or the text in a cell or TextFrame.
  56
  57     @see com::sun::star::text::TextDocument
  58     @see com::sun::star::text::TextFrame
  59     @see com::sun::star::table::Cell
  60  */
  61 published service Text
  62 {
  63     /** This is the factory for an enumeration of the paragraphs in this text.
  64
  65         <p>This interface is mainly useful for exporting the text to a
  66         data format.
  67      */
  68     interface com::sun::star::container::XEnumerationAccess;
  69
  70 //=============================================================================
  71
  72     /** provides a cursor factory and the possibility to insert and remove contents.
  73      */
  74     interface XText;
  75
  76 //=============================================================================
  77
  78     /** optional interface to compare postions of <type>TextRange</type>
  79                 instances within this text.
  80      */
  81     [optional] interface XTextRangeCompare;
  82
  83 //=============================================================================
  84
  85     /** makes it possible to change the position of paragraphs.
  86
  87      */
  88     [optional] interface XTextRangeMover;
  89
  90 //=============================================================================
  91
  92     /** makes it possible to insert a new text content, before or
  93                    after existing text contents.
  94
  95                    @deprecated hack
  96      */
  97     [optional] interface XRelativeTextContentInsert;
  98
  99 //=============================================================================
 100
 101     /** contains the properties of a redline at the start of the document.<br>
 102     The sequence contains the following properties
 103     <UL>
 104         <LI><P>string RedlineAuthor        </P></LI>
 105         <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
 106         <LI><P>string RedlineComment       </P></LI>
 107         <LI><P>string RedlineType          </P></LI>
 108         <LI><P>string RedlineIdentifier    </P></LI>
 109         <LI><P>boolean IsCollapsed          </P></LI>
 110         <LI><P>boolean IsStart              </P></LI>
 111         <LI><P>boolean MergeLastPara        </P></LI>
 112         <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
 113         <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
 114             (contains the same properties except for the RedlineSuccessorData</P></LI>
 115     </UL>
 116      @see EndRedline
 117      */
 118     [optional, property] ::com::sun::star::beans::PropertyValues StartRedline;
 119
 120 //=============================================================================
 121
 122     /** contains the properties of a redline at the start of the document.
 123     The sequence contains the following properties
 124     <UL>
 125         <LI><P>string RedlineAuthor        </P></LI>
 126         <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
 127         <LI><P>string RedlineComment       </P></LI>
 128         <LI><P>string RedlineType          </P></LI>
 129         <LI><P>string RedlineIdentifier    </P></LI>
 130         <LI><P>boolean IsCollapsed          </P></LI>
 131         <LI><P>boolean IsStart              </P></LI>
 132         <LI><P>boolean MergeLastPara        </P></LI>
 133         <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
 134         <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
 135             (contains the same properties except for the RedlineSuccessorData</P></LI>
 136     </UL>
 137      @see StartRedline
 138      */
 139     [optional, maybevoid, property] ::com::sun::star::beans::PropertyValues EndRedline;
 140
 141 //=============================================================================
 142
 143 };
 144
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 #endif