offapi/com/sun/star/util/XTextSearch.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_util_XTextSearch_idl__
  21 #define __com_sun_star_util_XTextSearch_idl__
  22
  23
  24 #include <com/sun/star/lang/Locale.idl>
  25 #include <com/sun/star/uno/XInterface.idl>
  26 #include <com/sun/star/util/SearchOptions.idl>
  27 #include <com/sun/star/util/SearchResult.idl>
  28
  29
  30 module com { module sun { module star { module util {
  31
  32 /** enables an object to search in its content.
  33  */
  34 published interface XTextSearch : com::sun::star::uno::XInterface
  35 {
  36     /** set the options for the forward or backward search.
  37
  38     */
  39     void setOptions ([in] SearchOptions options);
  40     /** search forward in the searchStr, starts at startPos and ends by endpos.
  41         The result is returned in the SearchResult.
  42
  43     */
  44     SearchResult  searchForward  ([in] string searchStr, [in] long startPos, [in] long endPos );
  45     /** search backward in the searchStr, starts at startPos and ends by endpos.
  46         The endpos must be lower then the startpos, because the function searches backward!
  47         The result is returned in the SearchResult.
  48
  49     */
  50     SearchResult  searchBackward ([in] string searchStr, [in] long startPos, [in] long endPos );
  51 };
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */