offapi/com/sun/star/util/XReplaceable.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_util_XReplaceable_idl__
  28 #define __com_sun_star_util_XReplaceable_idl__
  29
  30 #ifndef __com_sun_star_util_XSearchable_idl__
  31 #include <com/sun/star/util/XSearchable.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_XReplaceDescriptor_idl__
  35 #include <com/sun/star/util/XReplaceDescriptor.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_XSearchDescriptor_idl__
  39 #include <com/sun/star/util/XSearchDescriptor.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module util {
  46
  47 //=============================================================================
  48
  49 /** makes it possible to replace strings in a text described by a
  50     <type>SearchDescriptor</type>.
  51
  52     @example
  53     <listing>
  54     'replace all bold words "search for" by "look for"
  55     xReplaceDescr = xDocument.createReplaceDescriptor()
  56     xReplaceDescr.SearchString = "search for"
  57     xReplaceDescr.ReplaceString = "look for"
  58     xFound = xDocument.replaceAll( xReplaceDescr )
  59     </listing>
  60  */
  61 published interface XReplaceable: com::sun::star::util::XSearchable
  62 {
  63     //-------------------------------------------------------------------------
  64     /** creates a descriptor which contains properties that
  65         specify a search in this container.@see SearchDescriptor
  66      */
  67     com::sun::star::util::XReplaceDescriptor createReplaceDescriptor();
  68
  69     //-------------------------------------------------------------------------
  70     /** searches for all occurrences of whatever is specified.@see SearchDescriptor
  71      */
  72     long replaceAll( [in] com::sun::star::util::XSearchDescriptor xDesc );
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif