sftemplateswizard/com.nokia.s60tools.symbianfoundationtemplates/templates/empty_c_class_header_template.h
changeset 0 61163b28edca
equal deleted inserted replaced
-1:000000000000 0:61163b28edca
       
     1 /*
       
     2 * ============================================================================
       
     3 *  Name        : ?filename.h
       
     4 *  Part of     : ?Subsystem_name / ?Module_name
       
     5 *  Description : ?Description
       
     6 *  Version     : %version: %
       
     7 *
       
     8 *  Copyright © ?year-?year ?Company_copyright.
       
     9 *  All rights reserved.
       
    10 *  This component and the accompanying materials are made available
       
    11 *  under the terms of the License "?License"
       
    12 *  which accompanies this distribution, and is available
       
    13 *  at the URL "?LicenseUrl".
       
    14 *
       
    15 *  Initial Contributors:
       
    16 *  ?Company_name - initial contribution.
       
    17 *
       
    18 *  Contributors:
       
    19 *  ?Company_name
       
    20 * ============================================================================
       
    21 * Template version: 4.2
       
    22 */
       
    23 
       
    24 #ifndef ?C_CLASSNAME_H
       
    25 #define ?C_CLASSNAME_H
       
    26 
       
    27 
       
    28 #include <?include_file>
       
    29 
       
    30 #include "?include_file"
       
    31 
       
    32 class ?forward_classname;
       
    33 
       
    34 /**  ?description */
       
    35 extern ?data_type;
       
    36 
       
    37 /**
       
    38  * ?description
       
    39  *
       
    40  * @since S60 ?S60_version
       
    41  * @param ?arg1 ?description
       
    42  * @return ?description
       
    43  */
       
    44 ?type ?function_name( ?arg_list );
       
    45 
       
    46 /**  ?description */
       
    47 const ?type ?constant_var = ?constant;
       
    48 
       
    49 
       
    50 /**
       
    51  *  ?one_line_short_description
       
    52  *  ?more_complete_description
       
    53  *
       
    54  *  @code
       
    55  *   ?good_class_usage_example(s)
       
    56  *  @endcode
       
    57  *
       
    58  *  @lib ?library
       
    59  *  @since S60 ?S60_version *** for example, S60 v3.0
       
    60  */
       
    61 class ?classname : public ?base_class_list
       
    62     {
       
    63 
       
    64     friend class ?class1;
       
    65     friend class ?class2;
       
    66 
       
    67 public:
       
    68 
       
    69     /**  ?description */
       
    70     enum ?declaration
       
    71 
       
    72     /**  ?description */
       
    73     typedef ?declaration
       
    74 
       
    75     ?IMPORT_C static ?classname* NewL();
       
    76     ?IMPORT_C static ?classname* NewLC();
       
    77 
       
    78     /**
       
    79      * Two-phased constructor.
       
    80      * @param ?arg1 ?description
       
    81      * @param ?arg2 ?description
       
    82      */
       
    83     ?IMPORT_C static ?classname* NewL(?type1 ?arg1, ?type2 ?arg2);
       
    84     
       
    85 
       
    86     /**
       
    87     * Destructor.
       
    88     */
       
    89     virtual ~?classname();
       
    90 
       
    91     /**
       
    92      * ?description
       
    93      *
       
    94      * @since S60 ?S60_version
       
    95      * @param ?arg1 ?description
       
    96      * @param ?arg2 ?description
       
    97      * @return ?description
       
    98      */
       
    99     ?IMPORT_C ?type ?member_function( ?type1 ?arg1, ?type2 ?arg2 );
       
   100 
       
   101 // from base class ?base_class1
       
   102 
       
   103     /**
       
   104      * From ?base_class1.
       
   105      * ?description
       
   106      *
       
   107      * @since S60 ?S60_version
       
   108      * @param ?arg1 ?description
       
   109      */
       
   110     ?IMPORT_C ?type ?member_function( ?type ?arg1 );
       
   111 
       
   112 // from base class ?base_class2
       
   113 
       
   114 protected:
       
   115 
       
   116 // from base class ?base_class2
       
   117 
       
   118 // from base class ?base_class3
       
   119 
       
   120 private:
       
   121 
       
   122     ?classname();
       
   123 
       
   124     void ConstructL();
       
   125 
       
   126 private: // data
       
   127 
       
   128     /**
       
   129      * ?description_of_member
       
   130      */
       
   131     ?type ?member_name;
       
   132 
       
   133     /**
       
   134      * ?description_of_pointer_member
       
   135      * Own.  *** Write "Own" if this class owns the object pointed to; in
       
   136                  other words, if this class is responsible for deleting it.
       
   137      */
       
   138     ?type* ?member_name;
       
   139 
       
   140     /**
       
   141      * ?description_of_pointer_member
       
   142      * Not own.  *** Write "Not own" if some other class owns this object.
       
   143      */
       
   144     ?type* ?member_name;
       
   145 
       
   146     };
       
   147 
       
   148 #include "?include_file.inl"
       
   149 
       
   150 
       
   151 #endif // ?C_CLASSNAME_H