summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/reflection/XIdlField2.idl
blob: 87e516c906dd22c6392d0c4f4b8e1a6afb5f4aa1 (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
127
128
129
130
131
132
133
/*************************************************************************
 *
 * 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_reflection_XIdlField2_idl__
#define __com_sun_star_reflection_XIdlField2_idl__

#ifndef __com_sun_star_reflection_XIdlMember_idl__
#include <com/sun/star/reflection/XIdlMember.idl>
#endif

#ifndef __com_sun_star_reflection_XIdlClass_idl__
#include <com/sun/star/reflection/XIdlClass.idl>
#endif

#ifndef __com_sun_star_reflection_FieldAccessMode_idl__
#include <com/sun/star/reflection/FieldAccessMode.idl>
#endif

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

#ifndef __com_sun_star_lang_IllegalAccessException_idl__
#include <com/sun/star/lang/IllegalAccessException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module reflection {

//=============================================================================

/** Reflects an IDL interface attribute, enum or compound type
    (i.e. struct/exception) member.
*/
published interface XIdlField2: com::sun::star::reflection::XIdlMember
{
    /** Returns the type of the field.

        @return
                type of the field
    */
    com::sun::star::reflection::XIdlClass getType();

    /** Returns the access mode of the field, i.e. read-write, read-only or
        write-only (access mode "const" is deprecated).

        @return
                access mode of the field
    */
    com::sun::star::reflection::FieldAccessMode getAccessMode();

    /** Gets the value of the reflected field from the given object,
        i.e. an interface, enum or compound type (struct/exception).
        For enums, the given object is ignored; the returned value
        reflects the constant enum 32-bit value.

        <p>When setting an interface attribute raises a
        non-<type scope="com::sun::star::uno">RuntimeException</type>, it is
        wrapped in a <type
        scope="com::sun::star::lang">WrappedTargetRuntimeException</type>.</p>

        @param obj
               object instance having member of reflected type
        @return
                value of field

        @throws IllegalAccessException
        An <type scope="com::sun::star::lang">IllegalAccessException</type>
        is thrown if the given object is no interface, enum or compound type;
        or the given object does not have the reflected field.
    */
    any get(
        [in] any obj )
        raises( com::sun::star::lang::IllegalArgumentException );

    /** Sets the value of the reflected field of the given object,
        i.e. an interface or compound type (struct/exception).

        <p>When setting an interface attribute raises a
        non-<type scope="com::sun::star::uno">RuntimeException</type>, it is
        wrapped in a <type
        scope="com::sun::star::lang">WrappedTargetRuntimeException</type>.</p>

        @param obj
               object instance having member of reflected type
        @param value
               value to be set

        @throws IllegalAccessException
        An <type scope="com::sun::star::lang">IllegalAccessException</type>
        is thrown if the given object is no interface or compound type;
        or the given object does not have the reflected field.
    */
    void set(
        [inout] any obj,
        [in] any value )
        raises( com::sun::star::lang::IllegalArgumentException,
                com::sun::star::lang::IllegalAccessException );
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif