offapi/com/sun/star/text/XFlatParagraphIteratorProvider.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 #ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
  21 #define __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/text/XFlatParagraphIterator.idl>
  26
  27 //---------------------------------------Note----------------------------------
  28 //    allows for different iterators for grammar checking and smart tags,
  29 //    interface must be implemented exactly once for each document since
  30 //    the interface pointer will be used to get an unique document id.
  31
  32
  33 module com {  module sun {  module star {  module text {
  34
  35
  36 /** provides functionality to ...
  37
  38     @since OOo 3.0
  39  */
  40
  41 interface XFlatParagraphIteratorProvider: com::sun::star::uno::XInterface
  42 {
  43     /** get XFlatParagraphIterator
  44
  45         @param  nType
  46                 Type of text markup see TextMarkupType.
  47
  48         @param  bAutomatic
  49                 Automatic or interactive checking.
  50
  51         @returns
  52                 the iterator.
  53
  54         @throws IllegalArgumentException
  55                 if any argument is wrong.
  56
  57     */
  58     com::sun::star::text::XFlatParagraphIterator getFlatParagraphIterator( [in] long nType,
  59                                                                            [in] boolean bAutomatic )
  60             raises( com::sun::star::lang::IllegalArgumentException );
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */