xref: /aoo41x/main/oovbaapi/ooo/vba/XCollectionBase.idl (revision 841807c9)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/

#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 seperately 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