summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/reflection/XIdlArray.idl
blob: f2cf3cb9413b152608f5afc1251969f944a249d2 (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
/*************************************************************************
 *
 * 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_XIdlArray_idl__
#define __com_sun_star_reflection_XIdlArray_idl__

#include <com/sun/star/uno/XInterface.idl>

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

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


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

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

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

/** Reflects an IDL sequence and provides dynamic access to instances of
    that sequence.
    This interface supports widening conversion when getting or setting elements.

    @attention
    Although the name of this interface denotes arrays,
    sequences are meant. Don't be obfuscated, arrays are not supported by UNO!
*/
published interface XIdlArray: com::sun::star::uno::XInterface
{
    /** Rellocates the length of the sequence instance.

        @param array
               sequence instance
        @length
                new length of sequence
     */
    void realloc(
        [inout] any array,
        [in] long length )
        raises( com::sun::star::lang::IllegalArgumentException );

    /** Returns the length of the given sequence.

        @param array
               sequence instance
        @return
                length of sequence
    */
    long getLen( [in] any array )
        raises( com::sun::star::lang::IllegalArgumentException );

    /** Returns element at given index.

        @param aArray
               sequence instance
        @param nIndex
               index
        @return
                value

        @throws IllegalArgumentException
        if the specified object is not a sequence or if the specified object is null

        @throws ArrayIndexOutOfBoundsException
        if the specified index argument is negative, or if it is greater than or equal to the
        length of the specified sequence.
    */
    any get(
        [in] any aArray,
        [in] long nIndex )
        raises( com::sun::star::lang::IllegalArgumentException,
                com::sun::star::lang::ArrayIndexOutOfBoundsException );

    /** Sets a new value at given index.

        @param aArray
               sequence instance
        @param nIndex
               index
        @param aNewValue
               new value to be set

        @throws IllegalArgumentException
        if the specified object is not a sequence or if the specified object is null

        @throws ArrayIndexOutOfBoundsException
        if the specified index argument is negative, or if it is greater than or equal to the
        length of the specified sequence.
    */
    void set(
        [inout] any aArray,
        [in] long nIndex,
        [in] any aNewValue )
        raises( com::sun::star::lang::IllegalArgumentException,
                com::sun::star::lang::ArrayIndexOutOfBoundsException );
};

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

}; }; }; };

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

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