offapi/com/sun/star/util/XReplaceDescriptor.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: XReplaceDescriptor.idl,v $
  10  * $Revision: 1.9 $
  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_XReplaceDescriptor_idl__
  31 #define __com_sun_star_util_XReplaceDescriptor_idl__
  32
  33 #ifndef __com_sun_star_util_XSearchDescriptor_idl__
  34 #include <com/sun/star/util/XSearchDescriptor.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module util {
  41
  42 //=============================================================================
  43
  44 /** specifies a string replace operation.
  45  */
  46 published interface XReplaceDescriptor: com::sun::star::util::XSearchDescriptor
  47 {
  48     //-------------------------------------------------------------------------
  49     /** @returns
  50                     the string which replaces the found occurrences.
  51      */
  52     string getReplaceString();
  53
  54     //-------------------------------------------------------------------------
  55     /** sets the string which replaces the found occurrences.
  56      */
  57     void setReplaceString( [in] string aReplaceString );
  58
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; };
  64
  65 #endif