office-gobmx/oovbaapi/ooo/vba/XCollectionBase.idl
Michael Meeks b6db3e3acc re-base on ALv2 code.
Change-Id: Ice06e639213aeb6f7f23cbf4634947dd25613db1
2012-06-21 13:11:06 +01:00

68 lines
2.6 KiB
Text

/*
* 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 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