LibreOffice Module sw (master)  1
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
sw::RingIterator< value_type > Class Template Reference

#include <ring.hxx>

Inheritance diagram for sw::RingIterator< value_type >:
[legend]
Collaboration diagram for sw::RingIterator< value_type >:
[legend]

Public Member Functions

 RingIterator ()
 
 RingIterator (nonconst_value_type *pRing, bool bStart=true)
 

Private Types

typedef std::remove_const< value_type >::type nonconst_value_type
 

Private Member Functions

void increment ()
 
bool equal (RingIterator const &other) const
 
value_type & dereference () const
 

Private Attributes

nonconst_value_typem_pCurrent
 value_type is: More...
 
nonconst_value_typem_pStart
 the first item of the iteration More...
 

Friends

class boost::iterator_core_access
 

Detailed Description

template<typename value_type>
class sw::RingIterator< value_type >

Definition at line 32 of file ring.hxx.

Member Typedef Documentation

template<typename value_type >
typedef std::remove_const<value_type>::type sw::RingIterator< value_type >::nonconst_value_type
private

Definition at line 201 of file ring.hxx.

Constructor & Destructor Documentation

template<typename value_type >
sw::RingIterator< value_type >::RingIterator ( )
inline

Definition at line 203 of file ring.hxx.

template<typename value_type >
sw::RingIterator< value_type >::RingIterator ( nonconst_value_type pRing,
bool  bStart = true 
)
inlineexplicit

Member Function Documentation

template<typename value_type >
value_type& sw::RingIterator< value_type >::dereference ( ) const
inlineprivate
template<typename value_type >
bool sw::RingIterator< value_type >::equal ( RingIterator< value_type > const &  other) const
inlineprivate
template<typename value_type >
void sw::RingIterator< value_type >::increment ( )
inlineprivate

Friends And Related Function Documentation

template<typename value_type >
friend class boost::iterator_core_access
friend

Definition at line 216 of file ring.hxx.

Member Data Documentation

template<typename value_type >
nonconst_value_type* sw::RingIterator< value_type >::m_pCurrent
private

value_type is:

  • pointing to the current item in the iteration in general
  • nullptr if on the first item (begin())
  • m_pStart when beyond the last item (end())

Definition at line 234 of file ring.hxx.

Referenced by sw::RingIterator< value_type >::dereference(), sw::RingIterator< value_type >::equal(), sw::RingIterator< value_type >::increment(), and sw::RingIterator< value_type >::RingIterator().

template<typename value_type >
nonconst_value_type* sw::RingIterator< value_type >::m_pStart
private

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