summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/container/XIndexAccess.idl
blob: 44ea079fb619ec7dd62ae330723f1554df8ac474 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XIndexAccess.idl,v $
 * $Revision: 1.12 $
 *
 * 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_container_XIndexAccess_idl__ 
#define __com_sun_star_container_XIndexAccess_idl__ 
 
#ifndef __com_sun_star_container_XElementAccess_idl__ 
#include <com/sun/star/container/XElementAccess.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 
#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 
#include <com/sun/star/lang/WrappedTargetException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module container {  
 
//============================================================================= 
 
/** provides access to the elements of a collection through an
    index.
    
    <p>This interface should only be used if the data structure, itself,
    is indexed.</p>
 */
published interface XIndexAccess: com::sun::star::container::XElementAccess
{ 
    //------------------------------------------------------------------------- 
     
    /** @returns  
                the number of elements in this container.
     */
    long getCount(); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex
    /** @returns  
            the element at the specified index.
                 
        @param Index	 
            specifies the position in the array. The first index is 0. 
                 
        @throws com::sun::star::lang::IndexOutOfBoundException 
            if the index is not valid. 
                 
        @throws  com::sun::star::lang::WrappedTargetException  
            If the implementation has internal reasons for exceptions,  
            then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type> 
            exception.
     */
    any getByIndex( [in] long Index ) 
            raises( com::sun::star::lang::IndexOutOfBoundsException, 
                    com::sun::star::lang::WrappedTargetException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif