offapi/com/sun/star/util/XReplaceable.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 #ifndef __com_sun_star_util_XReplaceable_idl__
  20 #define __com_sun_star_util_XReplaceable_idl__
  21
  22 #include <com/sun/star/util/XSearchable.idl>
  23
  24 #include <com/sun/star/util/XReplaceDescriptor.idl>
  25
  26 #include <com/sun/star/util/XSearchDescriptor.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module util {
  31
  32
  33 /** makes it possible to replace strings in a text described by a
  34     SearchDescriptor.
  35
  36     Example: replace all bold words "search for" by "look for"
  37
  38     @code{.py}
  39     xReplaceDescr = xDocument.createReplaceDescriptor()
  40     xReplaceDescr.SearchString = "search for"
  41     xReplaceDescr.ReplaceString = "look for"
  42     xFound = xDocument.replaceAll( xReplaceDescr )
  43     @endcode
  44  */
  45 published interface XReplaceable: com::sun::star::util::XSearchable
  46 {
  47     /** creates a descriptor which contains properties that
  48         specify a search in this container.@see SearchDescriptor
  49      */
  50     com::sun::star::util::XReplaceDescriptor createReplaceDescriptor();
  51
  52     /** searches for all occurrences of whatever is specified.@see SearchDescriptor
  53      */
  54     long replaceAll( [in] com::sun::star::util::XSearchDescriptor xDesc );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */