offapi/com/sun/star/util/XPropertyReplace.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: XPropertyReplace.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_XPropertyReplace_idl__
  31 #define __com_sun_star_util_XPropertyReplace_idl__
  32
  33 #ifndef __com_sun_star_util_XReplaceDescriptor_idl__
  34 #include <com/sun/star/util/XReplaceDescriptor.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_UnknownPropertyException_idl__
  42 #include <com/sun/star/beans/UnknownPropertyException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  46 #include <com/sun/star/lang/IllegalArgumentException.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module util {
  53
  54 //=============================================================================
  55
  56 /** makes it possible to search and replace properties.
  57  */
  58 published interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor
  59 {
  60     //-------------------------------------------------------------------------
  61     /** provides the information if specific property values are
  62         searched, or just the existence of the specified properties.
  63      */
  64     boolean getValueSearch();
  65
  66     //-------------------------------------------------------------------------
  67     /** specifies if specific property values are searched,
  68         or just the existence of the specified properties.
  69      */
  70     void setValueSearch( [in] boolean bValueSearch );
  71
  72     //-------------------------------------------------------------------------
  73     /** @returns
  74                     the attributes to search for.
  75      */
  76     sequence<com::sun::star::beans::PropertyValue> getSearchAttributes();
  77
  78     //-------------------------------------------------------------------------
  79     /** sets the properties to search for.
  80      */
  81     void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
  82             raises( com::sun::star::beans::UnknownPropertyException,
  83                     com::sun::star::lang::IllegalArgumentException );
  84
  85     //-------------------------------------------------------------------------
  86     /** @returns
  87                     the attribute values which are used to replace the found occurrences.
  88      */
  89     sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes();
  90
  91     //-------------------------------------------------------------------------
  92     /** sets the properties to replace the found occurrences.
  93      */
  94     void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
  95             raises( com::sun::star::beans::UnknownPropertyException,
  96                     com::sun::star::lang::IllegalArgumentException );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif