LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
cppu::OInterfaceIteratorHelper Class Reference

This is the iterator of a InterfaceContainerHelper. More...

#include <interfacecontainer.h>

Public Member Functions

 OInterfaceIteratorHelper (OInterfaceContainerHelper &rCont)
 Create an iterator over the elements of the container. More...
 
 ~OInterfaceIteratorHelper ()
 Releases the connection to the container. More...
 
bool hasMoreElements () const
 Return true, if there are more elements in the iterator. More...
 
css::uno::XInterface * next ()
 Return the next element of the iterator. More...
 
void remove ()
 Removes the current element (the last one returned by next()) from the underlying container. More...
 

Detailed Description

This is the iterator of a InterfaceContainerHelper.

Typically one constructs an instance on the stack for one firing session. It is not allowed to assign or copy an instance of this class.

See Also
OInterfaceContainerHelper

Constructor & Destructor Documentation

cppu::OInterfaceIteratorHelper::OInterfaceIteratorHelper ( OInterfaceContainerHelper rCont)

Create an iterator over the elements of the container.

The iterator copies the elements of the container. A change to the container during the lifetime of an iterator is allowed and does not affect the iterator-instance. The iterator and the container take cares themself for concurrent access, no additional guarding is necessary.

Remark: The copy is on demand. The iterator copy the elements only if the container change the contents. It is not allowed to destroy the container as long as an iterator exist.

Parameters
rContthe container of the elements.
cppu::OInterfaceIteratorHelper::~OInterfaceIteratorHelper ( )

Releases the connection to the container.

Member Function Documentation

bool cppu::OInterfaceIteratorHelper::hasMoreElements ( ) const
inline

Return true, if there are more elements in the iterator.

css::uno::XInterface* cppu::OInterfaceIteratorHelper::next ( )

Return the next element of the iterator.

Calling this method if hasMoreElements() has returned false, is an error. Cast the returned pointer to the

void cppu::OInterfaceIteratorHelper::remove ( )

Removes the current element (the last one returned by next()) from the underlying container.

Calling this method before next() has been called or calling it twice with no next() inbetween is an error.


The documentation for this class was generated from the following file: