0
|
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 |
*** INSTRUCTIONS TO THE TEMPLATE USER:
|
|
25 |
|
|
26 |
*** This template follows the Symbian Foundation coding conventions.
|
|
27 |
*** Remove all unneeded declarations and definitions before checking
|
|
28 |
*** the file in! Also remove the template's usage instructions, that is,
|
|
29 |
*** everything that begins with "***".
|
|
30 |
|
|
31 |
*** The copyright years should be < the year of the file's creation >
|
|
32 |
*** - < the year of the file's latest update >.
|
|
33 |
|
|
34 |
*** Words that begin with "?" are for you to replace with your own
|
|
35 |
*** identifiers, filenames, or comments. ?IMPORT_C means either the
|
|
36 |
*** IMPORT_C visibility directive, or nothing, depending on whether
|
|
37 |
*** the function is to be exported or not.
|
|
38 |
|
|
39 |
*** To support building on Linux, use only forward slashes in include
|
|
40 |
*** directives. Also, all filenames and pathnames must be completely
|
|
41 |
*** in lowercase.
|
|
42 |
|
|
43 |
*** Indent four spaces per step, using spaces, not tabs, to display
|
|
44 |
*** the code consistently across different editors.
|
|
45 |
|
|
46 |
*** A T class differs from a C class only in the respect that it owns no
|
|
47 |
*** heap-allocated (dynamic) memory, and thus needs no explicit destructor.
|
|
48 |
*** A T class may be instantiated either on the heap or on the stack.
|
|
49 |
*** You must ensure that a T class is fully constructed before use.
|
|
50 |
*** A T class will derive from zero or one other T classes.
|
|
51 |
|
|
52 |
|
|
53 |
#ifndef ?T_CLASSNAME_H
|
|
54 |
#define ?T_CLASSNAME_H
|
|
55 |
|
|
56 |
|
|
57 |
*** system include files go here:
|
|
58 |
|
|
59 |
#include <?include_file>
|
|
60 |
|
|
61 |
*** user include files go here:
|
|
62 |
|
|
63 |
#include "?include_file"
|
|
64 |
|
|
65 |
*** forward declarations go here:
|
|
66 |
|
|
67 |
class ?forward_classname;
|
|
68 |
|
|
69 |
*** external data types go here:
|
|
70 |
|
|
71 |
/** ?description */
|
|
72 |
extern ?data_type;
|
|
73 |
|
|
74 |
*** constants go here:
|
|
75 |
|
|
76 |
const ?type ?constant_var = ?constant;
|
|
77 |
|
|
78 |
|
|
79 |
*** the class declaration goes here:
|
|
80 |
|
|
81 |
/**
|
|
82 |
* ?one_line_short_description
|
|
83 |
*
|
|
84 |
* ?more_complete_description
|
|
85 |
*
|
|
86 |
* @code
|
|
87 |
* ?good_class_usage_example(s)
|
|
88 |
* @endcode
|
|
89 |
*
|
|
90 |
* @lib ?library
|
|
91 |
* @since S60 ?S60_version *** for example, S60 v3.0
|
|
92 |
*/
|
|
93 |
class ?classname : public ?base_class_list
|
|
94 |
{
|
|
95 |
|
|
96 |
*** friend classes go here:
|
|
97 |
|
|
98 |
friend class ?class1;
|
|
99 |
friend class ?class2;
|
|
100 |
|
|
101 |
public:
|
|
102 |
|
|
103 |
*** data types go here:
|
|
104 |
|
|
105 |
/** ?description */
|
|
106 |
enum ?declaration
|
|
107 |
|
|
108 |
/** ?description */
|
|
109 |
typedef ?declaration
|
|
110 |
|
|
111 |
*** C++ constructors go here, starting with the default constructor.
|
|
112 |
*** No destructor is needed.
|
|
113 |
|
|
114 |
?classname();
|
|
115 |
|
|
116 |
/**
|
|
117 |
* Constructor.
|
|
118 |
*
|
|
119 |
* @since S60 ?S60_version
|
|
120 |
* @param ?arg1 ?description
|
|
121 |
* @param ?arg2 ?description
|
|
122 |
* @return ?description
|
|
123 |
*/
|
|
124 |
?classname( ?type1 ?arg1, ?type2 ?arg2 );
|
|
125 |
|
|
126 |
*** member functions go here:
|
|
127 |
|
|
128 |
/**
|
|
129 |
* ?description
|
|
130 |
*
|
|
131 |
* @since S60 ?S60_version
|
|
132 |
* @param ?arg1 ?description
|
|
133 |
* @param ?arg2 ?description
|
|
134 |
* @return ?description
|
|
135 |
*/
|
|
136 |
?IMPORT_C ?type ?member_function( ?type1 ?arg1, ?type2 ?arg2 );
|
|
137 |
|
|
138 |
// from base class ?base_class1
|
|
139 |
|
|
140 |
*** declarations of functions derived from base_class1 are grouped
|
|
141 |
*** together here:
|
|
142 |
|
|
143 |
/**
|
|
144 |
* From ?base_class1.
|
|
145 |
* ?description
|
|
146 |
*
|
|
147 |
* @since S60 ?S60_version
|
|
148 |
* @param ?arg1 ?description
|
|
149 |
*/
|
|
150 |
?IMPORT_C ?type ?member_function( ?type ?arg1 );
|
|
151 |
|
|
152 |
// from base class ?base_class2
|
|
153 |
|
|
154 |
*** function declarations as above
|
|
155 |
|
|
156 |
protected:
|
|
157 |
|
|
158 |
*** function declarations as above
|
|
159 |
|
|
160 |
// from base class ?base_class2
|
|
161 |
|
|
162 |
*** function declarations as above
|
|
163 |
|
|
164 |
// from base class ?base_class3
|
|
165 |
|
|
166 |
*** function declarations as above
|
|
167 |
|
|
168 |
|
|
169 |
private:
|
|
170 |
|
|
171 |
*** private, non-derived functions go here; function declarations as above
|
|
172 |
|
|
173 |
|
|
174 |
*** avoid the use of public or protected data; data should nearly
|
|
175 |
*** always be accessed through getter and setter functions
|
|
176 |
|
|
177 |
private: // data
|
|
178 |
|
|
179 |
/**
|
|
180 |
* ?description_of_member
|
|
181 |
*/
|
|
182 |
?type ?member_name;
|
|
183 |
|
|
184 |
};
|
|
185 |
|
|
186 |
|
|
187 |
*** put the inline functions, if any, in a file included here:
|
|
188 |
|
|
189 |
#include "?include_file.inl"
|
|
190 |
|
|
191 |
|
|
192 |
#endif // ?T_CLASSNAME_H
|