/*************************************************************************
 *
 *  $RCSfile: XEnumeration.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_container_XEnumeration_idl__ 
#define __com_sun_star_container_XEnumeration_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_container_NoSuchElementException_idl__ 
#include <com/sun/star/container/NoSuchElementException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 
#include <com/sun/star/lang/WrappedTargetException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module container {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::container::XEnumeration
/** provides functionality to enumerate the contents of a container.
    
    <p>An object that implements the <type>XEnumeration</type> interface
    generates a series of elements, one at a time. Successive calls to
    the <code>XEnumeration::nextElement</code> method return successive 
    elements of the series.  </p>

    <p>For example (Java), to print all elements of a vector <var>aVect</var>: 
    </p>

    <listing>
    for ( XEnumeration xEnum = aVect.elements() ; 
    xEnum.hasMoreElements() ; ) 
    {
    System.out.println( xEnum.nextElement() );
    }
    </listing>
    
    
    <p> If the object changed, the behavior of the enumeration is 
    not specified. This is not a remote interface.  </p>
 */
[ uik(E227A397-33D6-11D1-AABE00A0-249D5590), ident( "XEnumeration", 1.0 ) ]
interface XEnumeration: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::container::XEnumeration::hasMoreElements
    /** tests whether this enumeration contains more elements.
     */
    boolean hasMoreElements(); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::container::XEnumeration::nextElement
    /** @returns      
            the next element of this enumeration.  
                 
        @throws  NoSuchElementException   
            if no more elements exist. 
                 
        @throws  com::sun::star::lang::WrappedTargetException  
            If the implementation has internal reasons for exceptions,  
            then wrap these in a <type>WrappedTargetException</type> 
            exception.
     */
    any nextElement() 
            raises( com::sun::star::container::NoSuchElementException, 
                    com::sun::star::lang::WrappedTargetException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.4  2000/11/08 12:28:31  mi
    moved from api
    
    Revision 1.2  2000/10/09 14:24:54  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
    
    Revision 1.1.1.1  2000/09/18 23:35:04  hjs
    initial import
    
    Revision 1.5  2000/09/11 11:52:17  mi
    documentation merged from XML
     
    Revision 1.3  2000/02/23 11:41:15  mi 
    results from proofreading in layouted version 
     
    Revision 1.2  2000/01/03 12:03:19  mi 
    reference manual 
     
    Revision 1.1.1.1  1999/11/11 09:48:41  jsc 
    new 
     
 
=============================================================================*/ 
#endif