summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/util/XPropertyReplace.idl
blob: 46b7b667ffe61841322f40c261ea94df56caf316 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/**
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_util_XPropertyReplace_idl__
#define __com_sun_star_util_XPropertyReplace_idl__

#include <com/sun/star/util/XReplaceDescriptor.idl>

#include <com/sun/star/beans/PropertyValue.idl>

#include <com/sun/star/beans/UnknownPropertyException.idl>

#include <com/sun/star/lang/IllegalArgumentException.idl>



module com {  module sun {  module star {  module util {


/** makes it possible to search and replace properties.
 */
published interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor
{
    /** provides the information if specific property values are
        searched, or just the existence of the specified properties.
     */
    boolean getValueSearch();

    /** specifies if specific property values are searched,
        or just the existence of the specified properties.
     */
    void setValueSearch( [in] boolean bValueSearch );

    /** @returns
                    the attributes to search for.
     */
    sequence<com::sun::star::beans::PropertyValue> getSearchAttributes();

    /** sets the properties to search for.
     */
    void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::IllegalArgumentException );

    /** @returns
                    the attribute values which are used to replace the found occurrences.
     */
    sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes();

    /** sets the properties to replace the found occurrences.
     */
    void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::IllegalArgumentException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */