offapi/com/sun/star/text/XFlatParagraph.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: XFlatParagraph.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef __com_sun_star_text_XFlatParagraph_idl__
  32 #define __com_sun_star_text_XFlatParagraph_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_Locale_idl__
  39 #include <com/sun/star/lang/Locale.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_PropertyValue_idl__
  47 #include <com/sun/star/beans/PropertyValue.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_text_XTextMarkup_idl__
  51 #include <com/sun/star/text/XTextMarkup.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56 module com {  module sun {  module star {  module text {
  57
  58 //=============================================================================
  59
  60 /** provides functionality to ...
  61
  62     @since OOo 3.0
  63  */
  64
  65 interface XFlatParagraph: com::sun::star::text::XTextMarkup
  66 {
  67
  68     //-------------------------------------------------------------------------
  69     /** get the content of the paragraph
  70
  71         @returns
  72                 the content of the paragraph.
  73     */
  74     string getText();
  75
  76     //-------------------------------------------------------------------------
  77     /** check whether the content has been modified
  78
  79         @returns
  80                 <TRUE/>  if the content has been modified,
  81                 <FALSE/> otherwise.
  82     */
  83     boolean isModified();
  84
  85     //-------------------------------------------------------------------------
  86     /** change the 'checked' flag of the respective text node, i.e., mark the
  87         text node as 'processed'
  88
  89         @param nType
  90                 type, see <type>TextMarkupType</type>.
  91
  92         @param  bVal
  93                 <TRUE/>  the respective text node has been processed
  94                 <FALSE/> the respective text node needs to be processed again
  95                          later
  96     */
  97     void setChecked( [in] long nType, [in] boolean bVal );
  98
  99     //-------------------------------------------------------------------------
 100     /** returns whether the respective text node has already been processed
 101
 102         @param nType
 103                 type, see <type>TextMarkupType</type>.
 104
 105         @returns
 106                 <TRUE/>  if the respective text node has been checked
 107                 <FALSE/> otherwise.
 108     */
 109     boolean isChecked( [in] long nType );
 110
 111     //-------------------------------------------------------------------------
 112     /** get the language of the specific text
 113
 114         @param  nPos
 115                 start index of the text.
 116
 117         @param  nLen
 118                 the length of the text.
 119
 120         @returns
 121                 the locale for the language identified.
 122                 If no language could be identified, the locale will be empty.
 123
 124         @throws IllegalArgumentException
 125                 when any argument is wrong.
 126     */
 127     com::sun::star::lang::Locale getLanguageOfText( [in] long nPos, [in] long nLen )
 128             raises( com::sun::star::lang::IllegalArgumentException );
 129
 130     //-------------------------------------------------------------------------
 131     /** get the single most probable language of the specific text,
 132         especially after getLanguageOfText fails
 133
 134         @param  nPos
 135                 start index of the text.
 136
 137         @param  nLen
 138                 the length of the text.
 139
 140         @returns
 141                 the locale for the language identified.
 142
 143         @throws IllegalArgumentException
 144                 when any argument is wrong.
 145     */
 146     com::sun::star::lang::Locale getPrimaryLanguageOfText( [in] long nPos,
 147                                                            [in] long nLen )
 148             raises( com::sun::star::lang::IllegalArgumentException );
 149
 150     //-------------------------------------------------------------------------
 151     /** replace the specific text with new text.
 152
 153         @param  nPos
 154                 start index of the text.
 155
 156         @param  nLen
 157                 the length of the text.
 158
 159         @param  nNewText
 160                 new text.
 161
 162         @param aAttributes
 163                 the given set of attributes e.g. Language
 164
 165         @throws IllegalArgumentException
 166                 when any argument is wrong.
 167     */
 168     void changeText( [in] long nPos, [in] long nLen, [in] string aNewText,
 169                      [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes )
 170             raises( com::sun::star::lang::IllegalArgumentException );
 171
 172     //-------------------------------------------------------------------------
 173     /** replace the attributes of the specific text with the given set of attributes.
 174
 175         @param  nPos
 176                 start index of the text.
 177
 178         @param  nLen
 179                 the length of the text.
 180
 181         @param aAttributes
 182                 the given set of attributes e.g. Language.
 183
 184         @throws IllegalArgumentException
 185                 when any argument is wrong.
 186     */
 187     void    changeAttributes( [in] long nPos, [in] long nLen,
 188                               [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes )
 189             raises( com::sun::star::lang::IllegalArgumentException );
 190
 191     //-------------------------------------------------------------------------
 192     /** get a list of indexes that separate each two different languages
 193
 194         @returns
 195             a list of indices.
 196     */
 197     sequence< long > getLanguagePortions();
 198 };
 199
 200 //=============================================================================
 201
 202 }; }; }; };
 203
 204 #endif