summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/reflection/XIdlArray.idl
blob: a32ca9dcdacbb718b1de3c2299dec1810a8a578d (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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/*************************************************************************
 *
 *  $RCSfile: XIdlArray.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 09:44:39 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_reflection_XIdlArray_idl__ 
#define __com_sun_star_reflection_XIdlArray_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__ 
#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module reflection {  
 
//============================================================================= 
// DOCUMENTATION CHANGED FOR XIdlArray 
 
// DocMerge from xml: interface com::sun::star::reflection::XIdlArray
/** provides methods to dynamically access arrays.
    
    <p>Array permits widening conversions to occur during a get or set
    operation, but throws an IllegalArgumentException if a narrowing
    conversion would occur.
    
    </p>@see			IdlClass 
     *
 */
[ uik(E227A3A4-33D6-11D1-AABE00A0-249D5590), ident( "XIdlArray", 1.0 ) ]
interface XIdlArray: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
    // DOCUMENTATION CHANGED FOR XIdlArray::realloc 
     
    // DocMerge from xml: method com::sun::star::reflection::XIdlArray::realloc
    /** Change the size of the array to the new size.
        If the new length is greater, the additional
        elements are default constructed, otherwise
        the elements are destructed.
     */
    void realloc( [inout] any array, 
             [in] long length ) 
            raises( com::sun::star::lang::IllegalArgumentException ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::reflection::XIdlArray::getLen
    /** @returns  
                the number of elements in the array.
     */
    long getLen( [in] any array ) 
            raises( com::sun::star::lang::IllegalArgumentException ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::reflection::XIdlArray::get
    /** @returns  
                the value of the indexed component in the specified array object.  
                 
                @throws IllegalArgumentException  
                if the specified object is not an array 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 array.
     */
    any get( [in] any aArray, 
             [in] long nIndex ) 
            raises( com::sun::star::lang::IllegalArgumentException, 
                    com::sun::star::lang::ArrayIndexOutOfBoundsException ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::reflection::XIdlArray::set
    /** sets the value of the indexed component of the specified array object
        to the specified new value.
     */
    void set( [inout] any aArray, 
             [in] long nIndex, 
             [in] any aNewValue ) 
            raises( com::sun::star::lang::IllegalArgumentException, 
                    com::sun::star::lang::ArrayIndexOutOfBoundsException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:32  hjs
    initial import
    
    Revision 1.6  2000/09/11 11:52:36  mi
    documentation merged from XML
     
    Revision 1.4  2000/04/20 14:09:39  mm 
    #74031# better documentation 
     
    Revision 1.3  2000/03/20 09:53:38  mi 
    missing documentation marked 
     
    Revision 1.2  2000/02/07 11:24:44  mi 
    zu #70728# missing documentation marked 
     
    Revision 1.1.1.1  1999/11/11 09:48:44  jsc 
    new 
     
 
=============================================================================*/ 
#endif