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