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