summaryrefslogtreecommitdiff
path: root/oovbaapi/ooo/vba/XCollectionBase.idl
blob: cd76766da8d0ebf247f573bf6711b683aabc36fe (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef OOO_VBA_XOLLECTIONBASE_IDL
#define OOO_VBA_XOLLECTIONBASE_IDL

#include <com/sun/star/container/XEnumerationAccess.idl>
#include <com/sun/star/script/XDefaultMethod.idl>



module ooo { module vba {



/** Base interface for VBA collections.

    Every VBA collection provides the number of items, an enumeration access of
    all collection items (e.g. for the "For Each" loop), and a way to access
    single items, usually via the method "Item".

    The various VBA collection objects expect a specific number of arguments in
    the "Item" method, therefore this method is not part of this base interface
    but has to be specified separately in every derived interface.
 */
interface XCollectionBase
{

    /** Provides an enumeration of all items in this collection.
     */
    interface ::com::sun::star::container::XEnumerationAccess;


    /** Provides the name of the default item access method.

        Usually this method is called "Item". The access method has to be
        specified and implemented separately by every derived class.
     */
    interface ::com::sun::star::script::XDefaultMethod;


    /** Returns the number of items contained in this collection.
     */
    [attribute, readonly] long Count;


};



}; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */