offapi/com/sun/star/text/XFlatParagraph.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 module com {  module sun {  module star {  module text {
  22
  23
  24 /** provides functionality to ...
  25
  26     @since OOo 3.0
  27  */
  28
  29 interface XFlatParagraph: com::sun::star::text::XTextMarkup
  30 {
  31
  32     /** get the content of the paragraph
  33
  34         @returns
  35                 the content of the paragraph.
  36     */
  37     string getText();
  38
  39     /** check whether the content has been modified
  40
  41         @returns
  42                 `TRUE`  if the content has been modified,
  43                 `FALSE` otherwise.
  44     */
  45     boolean isModified();
  46
  47     /** change the "checked" flag of the respective text node, i.e., mark the
  48         text node as "processed"
  49
  50         @param nType
  51                 type, see TextMarkupType.
  52
  53         @param  bVal
  54                 `TRUE`  the respective text node has been processed
  55                 `FALSE` the respective text node needs to be processed again
  56                          later
  57     */
  58     void setChecked( [in] long nType, [in] boolean bVal );
  59
  60     /** returns whether the respective text node has already been processed
  61
  62         @param nType
  63                 type, see TextMarkupType.
  64
  65         @returns
  66                 `TRUE`  if the respective text node has been checked
  67                 `FALSE` otherwise.
  68     */
  69     boolean isChecked( [in] long nType );
  70
  71     /** get the language of the specific text
  72
  73         @param  nPos
  74                 start index of the text.
  75
  76         @param  nLen
  77                 the length of the text.
  78
  79         @returns
  80                 the locale for the language identified.
  81                 If no language could be identified, the locale will be empty.
  82
  83         @throws IllegalArgumentException
  84                 when any argument is wrong.
  85     */
  86     com::sun::star::lang::Locale getLanguageOfText( [in] long nPos, [in] long nLen )
  87             raises( com::sun::star::lang::IllegalArgumentException );
  88
  89     /** get the single most probable language of the specific text,
  90         especially after getLanguageOfText fails
  91
  92         @param  nPos
  93                 start index of the text.
  94
  95         @param  nLen
  96                 the length of the text.
  97
  98         @returns
  99                 the locale for the language identified.
 100
 101         @throws IllegalArgumentException
 102                 when any argument is wrong.
 103     */
 104     com::sun::star::lang::Locale getPrimaryLanguageOfText( [in] long nPos,
 105                                                            [in] long nLen )
 106             raises( com::sun::star::lang::IllegalArgumentException );
 107
 108     /** replace the specific text with new text.
 109
 110         @param  nPos
 111                 start index of the text.
 112
 113         @param  nLen
 114                 the length of the text.
 115
 116         @param  NewText
 117                 new text.
 118
 119         @param aAttributes
 120                 the given set of attributes e.g. Language
 121
 122         @throws IllegalArgumentException
 123                 when any argument is wrong.
 124     */
 125     void changeText( [in] long nPos, [in] long nLen, [in] string NewText,
 126                      [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes )
 127             raises( com::sun::star::lang::IllegalArgumentException );
 128
 129     /** replace the attributes of the specific text with the given set of attributes.
 130
 131         @param  nPos
 132                 start index of the text.
 133
 134         @param  nLen
 135                 the length of the text.
 136
 137         @param aAttributes
 138                 the given set of attributes e.g. Language.
 139
 140         @throws IllegalArgumentException
 141                 when any argument is wrong.
 142     */
 143     void    changeAttributes( [in] long nPos, [in] long nLen,
 144                               [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes )
 145             raises( com::sun::star::lang::IllegalArgumentException );
 146
 147     /** get a list of indexes that separate each two different languages
 148
 149         @returns
 150             a list of indices.
 151     */
 152     sequence< long > getLanguagePortions();
 153 };
 154
 155
 156 }; }; }; };
 157
 158 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */