oovbaapi/ooo/vba/XCollectionBase.idl

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