1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22#ifndef OOO_VBA_XOLLECTIONBASE_IDL
23#define OOO_VBA_XOLLECTIONBASE_IDL
24
25#include <com/sun/star/container/XEnumerationAccess.idl>
26#include <com/sun/star/script/XDefaultMethod.idl>
27
28//=============================================================================
29
30module ooo { module vba {
31
32//=============================================================================
33
34/** Base interface for VBA collections.
35
36    Every VBA collection provides the number of items, an enumeration access of
37    all collection items (e.g. for the "For Each" loop), and a way to access
38    single items, usually via the method "Item".
39
40    The various VBA collection objects expect a specific number of arguments in
41    the "Item" method, therefore this method is not part of this base interface
42    but has to be specified separately in every derived interface.
43 */
44interface XCollectionBase
45{
46    //-------------------------------------------------------------------------
47    /** Provides an enumeration of all items in this collection.
48     */
49    interface ::com::sun::star::container::XEnumerationAccess;
50
51    //-------------------------------------------------------------------------
52    /** Provides the name of the default item access method.
53
54        Usually this method is called "Item". The access method has to be
55        specified and implemented separately by every derived class.
56     */
57    interface ::com::sun::star::script::XDefaultMethod;
58
59    //-------------------------------------------------------------------------
60    /** Returns the number of items contained in this collection.
61     */
62    [attribute, readonly] long Count;
63
64    //-------------------------------------------------------------------------
65};
66
67//=============================================================================
68
69}; };
70
71#endif
72