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