epoc32/include/ct/rcpointerarray.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
/**
williamr@2
    22
 @file
williamr@2
    23
 @publishedAll
williamr@2
    24
 @released
williamr@2
    25
*/
williamr@2
    26
williamr@2
    27
williamr@2
    28
#ifndef __RCPOINTERARRAY_H
williamr@2
    29
#define __RCPOINTERARRAY_H
williamr@2
    30
#include <e32cmn.h>
williamr@2
    31
williamr@2
    32
/** 
williamr@2
    33
 * An array of pointers to objects, that adds close type behaviour.
williamr@2
    34
 *
williamr@2
    35
 * For use with C class pointers that are owned by the array. 
williamr@2
    36
 * @see RCPointerArray
williamr@2
    37
 * @since v7.0 
williamr@2
    38
 */
williamr@2
    39
template<class T> class RCPointerArray : public RPointerArray<T>
williamr@2
    40
	{
williamr@2
    41
 public:
williamr@2
    42
	/** Constructor */
williamr@2
    43
	inline RCPointerArray();
williamr@2
    44
	/** Closes the array and frees all resources (including deleting objects in the array). */
williamr@2
    45
	inline void Close();
williamr@2
    46
	};
williamr@2
    47
williamr@2
    48
/** Default constructor. */
williamr@2
    49
template <class T>
williamr@2
    50
inline RCPointerArray<T>::RCPointerArray()
williamr@2
    51
	{
williamr@2
    52
	}
williamr@2
    53
williamr@2
    54
/**
williamr@2
    55
 * Closes the array and frees all resources; this includes deleting the objects 
williamr@2
    56
 * whose pointers are held by the array (i.e. it's the same as ResetAndDestroy()).
williamr@2
    57
 */
williamr@2
    58
template <class T>
williamr@2
    59
inline void RCPointerArray<T>::Close()
williamr@2
    60
	{
williamr@2
    61
	this->ResetAndDestroy();
williamr@2
    62
	}
williamr@2
    63
williamr@2
    64
#endif