summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/XFastPropertySet.idl
blob: 1534e674ae60fc53573277df564ed0e58a799921 (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_beans_XFastPropertySet_idl__ 
#define __com_sun_star_beans_XFastPropertySet_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 
#include <com/sun/star/beans/UnknownPropertyException.idl> 
#endif 
 
#ifndef __com_sun_star_beans_PropertyVetoException_idl__ 
#include <com/sun/star/beans/PropertyVetoException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 
#include <com/sun/star/lang/WrappedTargetException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module beans {  
 
//============================================================================= 
 
/** provides a fast way of accessing and changing property values.
    
    <p>This interface is an extension to the <type>XPropertySet</type>
    interface. The get and set methods use handles to access the 
    property values instead of character strings.</p>
 */
published interface XFastPropertySet: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    /** sets the value to the property with the specified name.

        @param nHandle			
            contains the implementation handle of the 
            implementation for the property.

        @param aValue			
            contains the new value of the property.

        @throws UnknownPropertyException	
            if the property does not exist.

        @throws PropertyVetoException		
            if a vetoable listener does not approve the change of 
            a property value.

        @throws IllegalArgumentException  
            if the new value cannot be converted to the type of the 
            underlying property by an identity or widening conversion.

        @throws  stardiv::uno::lang::WrappedTargetException 
            if the implementation has an internal reason for the exception.
            In this case the original exception is wrapped into this
            <type scope="com::sun::star::lang">WrappedTargetException</type>.

     */
    void setFastPropertyValue( [in] long nHandle, 
             [in] any aValue ) 
            raises( com::sun::star::beans::UnknownPropertyException, 
                    com::sun::star::beans::PropertyVetoException, 
                    com::sun::star::lang::IllegalArgumentException, 
                    com::sun::star::lang::WrappedTargetException ); 
 
    //------------------------------------------------------------------------- 
     
    /** @returns  
            the value of the property with the name PropertyName. 
                 
        @param nHandle			 
            contains the implementation handle of the implementation for the property. 
                 
        @throws UnknownPropertyException	 
            if the property does not exist. 
                 
        @throws  com::sun::star::lang::WrappedTargetException  
            if the implementation has an internal reason for the exception. 
            In this case the original exception is wrapped into that 
            <type scope="com::sun::star::lang">WrappedTargetException</type>.
     */
    any getFastPropertyValue( [in] long nHandle ) 
            raises( com::sun::star::beans::UnknownPropertyException, 
                    com::sun::star::lang::WrappedTargetException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif