CList_adaptor_base Class Template Reference
[Collections Library]

#include <mfcstl/collections/clist_adaptors.hpp>

Inheritance diagram for CList_adaptor_base:

List of all members.

---

Detailed Description

template<typename L, typename I, typename T>
class mfcstl::CList_adaptor_base< L, I, T >

Adaptor class, providing implementation for CList_cadaptor and CList_iadaptor classes.

Parameters:

	L	The list class, e.g. CObList, CList<long>, etc.
	I	The interface specialisation, e.g. CList_cadaptor<CObList>, CList_iadaptor<CList<long> >, etc.
	T	The traits class, e.g. CList_traits<CObList>

Member Types
typedef L	list_type
	The type of the underlying MFC list.
typedef list_traits_type::value_type	value_type
	The value type.
typedef afx_allocator< value_type >	allocator_type
	The allocator type.
typedef allocator_type::reference	reference
	The mutating (non-const) reference type.
typedef allocator_type::const_reference	const_reference
	The non-mutating (const) reference type.
typedef allocator_type::pointer	pointer
	The mutating (non-const) pointer type.
typedef allocator_type::const_pointer	const_pointer
	The non-mutating (const) pointer type.
typedef size_t	size_type
	The size type.
typedef ms_ptrdiff_t	difference_type
	The difference type.
typedef CList_adaptor_base< L, I, T >	class_type
	The instantiation of the current type.
Construction
allocator_type	get_allocator () const
	Returns a copy of the allocator used by the container.
	CList_adaptor_base ()
	Default constructor.
	~CList_adaptor_base () throw ()
	Destructor.
Public Member Functions
Underlying Container Access
list_type &	get_CList ()
	Returns a mutating (non-const) reference to the underlying list.
list_type const &	get_CList () const
	Returns a non-mutating (const) reference to the underlying list.
Size and Capacity
size_type	size () const
	Returns the number of elements in the sequence.
size_type	max_size () const
	The maximum number of items that can be stored in the list.
bool	empty () const
	Indicates whether the search sequence is empty.
Modifiers
void	push_back (value_type const &val)
Iteration
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
Classes
class	const_iterator
	Non-mutating (const) iterator for the CList_adaptor_base class. More...

---

Member Typedef Documentation

typedef L list_type

The type of the underlying MFC list.

Reimplemented in CList_iadaptor.

typedef list_traits_type::value_type value_type

The value type.

Note:

If the compiler report "use of undefined type" when you're using the adaptor class(es) with CList<>, ensure that you've included afxtempl before you include this file.

Reimplemented in CList_iadaptor.

typedef afx_allocator<value_type> allocator_type

The allocator type.

Reimplemented in CList_iadaptor.

typedef allocator_type::reference reference

The mutating (non-const) reference type.

Reimplemented in CList_iadaptor.

typedef allocator_type::const_reference const_reference

The non-mutating (const) reference type.

Reimplemented in CList_iadaptor.

typedef allocator_type::pointer pointer

The mutating (non-const) pointer type.

Reimplemented in CList_iadaptor.

typedef allocator_type::const_pointer const_pointer

The non-mutating (const) pointer type.

Reimplemented in CList_iadaptor.

typedef size_t size_type

The size type.

Reimplemented in CList_iadaptor.

typedef ms_ptrdiff_t difference_type

The difference type.

Reimplemented in CList_iadaptor.

typedef CList_adaptor_base<L, I, T> class_type

The instantiation of the current type.

Reimplemented in CList_iadaptor.

---

Constructor & Destructor Documentation

CList_adaptor_base

(

)

[inline, protected]

Default constructor.

This is protected, because CList_adaptor_base serves as an abstract base for CList_cadaptor and CList_iadaptor

~CList_adaptor_base

(

)

throw () [inline, protected]

Destructor.

---

Member Function Documentation

list_type& get_CList

(

)

[inline]

Returns a mutating (non-const) reference to the underlying list.

list_type const& get_CList

(

)

const [inline]

Returns a non-mutating (const) reference to the underlying list.

allocator_type get_allocator

(

)

const [inline]

Returns a copy of the allocator used by the container.

size_type size

(

)

const [inline]

Returns the number of elements in the sequence.

size_type max_size

(

)

const [inline]

The maximum number of items that can be stored in the list.

bool empty

(

)

const [inline]

Indicates whether the search sequence is empty.

const_iterator begin

(

)

const [inline]

Begins the iteration.

Returns:

An iterator representing the start of the sequence

const_iterator end

(

)

const [inline]

Ends the iteration.

Returns:

An iterator representing the end of the sequence

---

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

• mfcstl/collections/clist_adaptors.hpp