idlehomescreen/inc/xnpointerarray.h
changeset 0 f72a12da539e
equal deleted inserted replaced
-1:000000000000 0:f72a12da539e
       
     1 /*
       
     2 * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Heap-allocated pointer array
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef CXNPOINTERARRAY_H
       
    21 #define CXNPOINTERARRAY_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 
       
    26 // CONSTANTS
       
    27 //const ?type ?constant_var = ?constant;
       
    28 
       
    29 // MACROS
       
    30 //#define ?macro ?macro_def
       
    31 
       
    32 // DATA TYPES
       
    33 //enum ?declaration
       
    34 //typedef ?declaration
       
    35 //extern ?data_type;
       
    36 
       
    37 // FUNCTION PROTOTYPES
       
    38 //?type ?function_name(?arg_list);
       
    39 
       
    40 // FORWARD DECLARATIONS
       
    41 //class ?FORWARD_CLASSNAME;
       
    42 // CLASS DECLARATION
       
    43 
       
    44 /**
       
    45 *  @ingroup group_xnutils
       
    46 * 
       
    47 *  Heap-allocated pointer array which does not own its objects
       
    48 *  @since Series 60 3.1
       
    49 */
       
    50 class CXnPointerArray : public CBase
       
    51     {
       
    52     public:  // Constructors and destructor
       
    53         
       
    54         /**
       
    55         * Two-phased constructor.
       
    56         */
       
    57         IMPORT_C static CXnPointerArray* NewL();
       
    58 
       
    59         /**
       
    60         * Destructor.
       
    61         */
       
    62         virtual ~CXnPointerArray();
       
    63         
       
    64     public: // New functions
       
    65         
       
    66         /**
       
    67         * Get the underlying container
       
    68         * @since Series 60 3.1
       
    69         * @return Underlying container
       
    70         */
       
    71 
       
    72         IMPORT_C RPointerArray<CBase>& Container();
       
    73 
       
    74     public: // Functions from base classes
       
    75 
       
    76         /**
       
    77         * From ?base_class ?member_description.
       
    78         * @since Series ?XX ?SeriesXX_version
       
    79         * @param ?arg1 ?description
       
    80         * @return ?description
       
    81         */
       
    82         //?type ?member_function( ?type ?arg1 );
       
    83         
       
    84     protected:  // New functions
       
    85         
       
    86         /**
       
    87         * ?member_description.
       
    88         * @since Series ?XX ?SeriesXX_version
       
    89         * @param ?arg1 ?description
       
    90         * @return ?description
       
    91         */
       
    92         //?type ?member_function( ?type ?arg1 );
       
    93 
       
    94 
       
    95     protected:  // Functions from base classes
       
    96         
       
    97         /**
       
    98         * From ?base_class ?member_description
       
    99         */
       
   100         //?type ?member_function();
       
   101 
       
   102     private:
       
   103 
       
   104         /**
       
   105         * C++ default constructor.
       
   106         */
       
   107         CXnPointerArray();
       
   108 
       
   109         /**
       
   110         * 2nd phase constructor.
       
   111         */
       
   112         void ConstructL();
       
   113 
       
   114         // Prohibit copy constructor if not deriving from CBase.
       
   115         // ?classname( const ?classname& );
       
   116         // Prohibit assigment operator if not deriving from CBase.
       
   117         // ?classname& operator=( const ?classname& );
       
   118 
       
   119     public:     // Data
       
   120         // ?one_line_short_description_of_data
       
   121         //?data_declaration;
       
   122     
       
   123     protected:  // Data
       
   124         // ?one_line_short_description_of_data
       
   125         //?data_declaration;
       
   126 
       
   127     private:    // Data
       
   128         // ?one_line_short_description_of_data
       
   129         //?data_declaration;
       
   130         // Reserved pointer for future extension
       
   131         //TAny* iReserved;
       
   132         // Internal container
       
   133         RPointerArray<CBase> iContainer;
       
   134     public:     // Friend classes
       
   135         //?friend_class_declaration;
       
   136     protected:  // Friend classes
       
   137         //?friend_class_declaration;
       
   138     private:    // Friend classes
       
   139         //?friend_class_declaration;
       
   140 
       
   141     };
       
   142 
       
   143 #endif      // CXnPOINTERARRAY_H
       
   144             
       
   145 // End of File