|
1 /* |
|
2 * ============================================================================ |
|
3 * Name : TestFileName.h |
|
4 * Part of : TestSubSystem / TestModule *** Info from the SWAD |
|
5 * Description : TestDescription |
|
6 * |
|
7 * continues |
|
8 * |
|
9 * --- |
|
10 * still |
|
11 * Version : %version: % << Don't touch! Updated by Synergy at check-out. |
|
12 * |
|
13 * Copyright © 2000-2001 Nokia Corporation and/or its subsidiary(-ies). |
|
14 * All rights reserved. |
|
15 * This component and the accompanying materials are made available |
|
16 * under the terms of "Eclipse Public License v1.0" |
|
17 * which accompanies this distribution, and is available |
|
18 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
19 * |
|
20 * Initial Contributors: |
|
21 * Nokia Corporation - initial contribution. |
|
22 * |
|
23 * Contributors: |
|
24 * |
|
25 * ============================================================================ |
|
26 * Template version: 4.2 |
|
27 */ |
|
28 |
|
29 *** INSTRUCTIONS TO THE TEMPLATE USER: |
|
30 |
|
31 *** This template follows the S60 coding conventions |
|
32 *** (S60_Coding_Conventions.doc). Remove all unneeded declarations |
|
33 *** and definitions before checking the file in! Also remove the |
|
34 *** template's usage instructions, that is, everything that begins |
|
35 *** with "***". |
|
36 |
|
37 *** The copyright years should be < the year of the file's creation > |
|
38 *** - < the year of the file's latest update >. |
|
39 |
|
40 *** Words that begin with "?" are for you to replace with your own |
|
41 *** identifiers, filenames, or comments. ?IMPORT_C means either the |
|
42 *** IMPORT_C visibility directive, or nothing, depending on whether |
|
43 *** the function is to be exported or not. |
|
44 |
|
45 *** To support building on Linux, use only forward slashes in include |
|
46 *** directives. Also, all filenames and pathnames must be completely |
|
47 *** in lowercase. |
|
48 |
|
49 *** Indent four spaces per step, using spaces, not tabs, to display |
|
50 *** the code consistently across different editors. |
|
51 |
|
52 *** An R class denotes a client-side handle to a resource, owned typically by |
|
53 *** a Symbian OS server elsewhere on the device. Generally R classes are |
|
54 *** instantiated either on the stack, or nested within C classes, then opened |
|
55 *** in some way, usually to a call such as Open() or Connect(). When they |
|
56 *** are finished with, it is essential to use the appropriate function to |
|
57 *** dispose of the class, usually Close(). An R class will derive from zero |
|
58 *** or one other R classes. |
|
59 |
|
60 |
|
61 #ifndef R_TESTCLASSNAME_H |
|
62 #define R_TESTCLASSNAME_H |
|
63 |
|
64 |
|
65 *** system include files go here: |
|
66 |
|
67 #include <?include_file> |
|
68 |
|
69 *** user include files go here: |
|
70 |
|
71 #include "?include_file" |
|
72 |
|
73 *** forward declarations go here: |
|
74 |
|
75 class ?forward_classname; |
|
76 |
|
77 *** external data types go here: |
|
78 |
|
79 /** ?description */ |
|
80 extern ?data_type; |
|
81 |
|
82 *** constants go here: |
|
83 |
|
84 /** ?description */ |
|
85 const ?type ?constant_var = ?constant; |
|
86 |
|
87 |
|
88 *** the class declaration goes here: |
|
89 |
|
90 /** |
|
91 * ?one_line_short_description |
|
92 * |
|
93 * ?more_complete_description |
|
94 * @code |
|
95 * ?good_class_usage_example(s) |
|
96 * @endcode |
|
97 * |
|
98 * @lib ?library |
|
99 * @since S60 ?S60_version *** for example, S60 v3.0 |
|
100 */ |
|
101 class TestClassName : public ?base_class_list |
|
102 { |
|
103 |
|
104 *** friend classes go here: |
|
105 |
|
106 friend class ?class1; |
|
107 friend class ?class2; |
|
108 |
|
109 public: |
|
110 |
|
111 *** data types go here: |
|
112 |
|
113 /** ?description */ |
|
114 enum ?declaration |
|
115 |
|
116 /** ?description */ |
|
117 typedef ?declaration |
|
118 |
|
119 *** C++ constructors go here, starting with the default constructor: |
|
120 |
|
121 TestClassName(); |
|
122 |
|
123 /** |
|
124 * Constructor. |
|
125 * |
|
126 * @since S60 ?S60_version |
|
127 * @param ?arg1 ?description |
|
128 * @param ?arg2 ?description |
|
129 * @return ?description |
|
130 */ |
|
131 TestClassName( ?type1 ?arg1, ?type2 ?arg2 ); |
|
132 |
|
133 *** member functions go here: |
|
134 |
|
135 /** |
|
136 * ?description |
|
137 * |
|
138 * @since S60 ?S60_version |
|
139 * @param ?arg1 ?description |
|
140 * @param ?arg2 ?description |
|
141 * @return ?description |
|
142 */ |
|
143 ?IMPORT_C ?type ?member_function( ?type1 ?arg1, ?type2 ?arg2 ); |
|
144 |
|
145 // from base class ?base_class |
|
146 |
|
147 *** declarations of functions derived from base_class are grouped |
|
148 *** together here: |
|
149 |
|
150 /** |
|
151 * From ?base_class. |
|
152 * ?description |
|
153 * |
|
154 * @since S60 ?S60_version |
|
155 * @param ?arg1 ?description |
|
156 */ |
|
157 ?IMPORT_C ?type ?member_function( ?type ?arg1 ); |
|
158 |
|
159 protected: |
|
160 |
|
161 *** function declarations as above |
|
162 |
|
163 // from base class ?base_class |
|
164 |
|
165 *** function declarations as above |
|
166 |
|
167 private: |
|
168 |
|
169 *** private, non-derived functions go here; function declarations as above |
|
170 |
|
171 |
|
172 *** avoid the use of public or protected data; data should nearly |
|
173 *** always be accessed through getter and setter functions |
|
174 |
|
175 private: // data |
|
176 |
|
177 /** |
|
178 * ?description_of_member |
|
179 */ |
|
180 ?type ?member_name; |
|
181 |
|
182 }; |
|
183 |
|
184 |
|
185 *** put the inline functions, if any, in a file included here: |
|
186 |
|
187 #include "?include_file.inl" |
|
188 |
|
189 |
|
190 #endif // R_TESTCLASSNAME_H |