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

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