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

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