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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module util {
  23
  24
  25 /** makes it possible to search and replace properties.
  26  */
  27 published interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor
  28 {
  29     /** provides the information if specific property values are
  30         searched, or just the existence of the specified properties.
  31      */
  32     boolean getValueSearch();
  33
  34     /** specifies if specific property values are searched,
  35         or just the existence of the specified properties.
  36      */
  37     void setValueSearch( [in] boolean bValueSearch );
  38
  39     /** @returns
  40                     the attributes to search for.
  41      */
  42     sequence<com::sun::star::beans::PropertyValue> getSearchAttributes();
  43
  44     /** sets the properties to search for.
  45      */
  46     void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
  47             raises( com::sun::star::beans::UnknownPropertyException,
  48                     com::sun::star::lang::IllegalArgumentException );
  49
  50     /** @returns
  51                     the attribute values which are used to replace the found occurrences.
  52      */
  53     sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes();
  54
  55     /** sets the properties to replace the found occurrences.
  56      */
  57     void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
  58             raises( com::sun::star::beans::UnknownPropertyException,
  59                     com::sun::star::lang::IllegalArgumentException );
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */