|
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 M class defines only pure virtual functions, therefore, is an |
|
53 *** abstract base class. An M class will derive from zero or more |
|
54 *** other M classes. |
|
55 |
|
56 |
|
57 #ifndef M_TESTCLASSNAME_H |
|
58 #define M_TESTCLASSNAME_H |
|
59 |
|
60 |
|
61 *** system include files go here: |
|
62 |
|
63 #include <?include_file> |
|
64 |
|
65 *** user include files go here: |
|
66 |
|
67 #include "?include_file" |
|
68 |
|
69 *** external data types go here: |
|
70 |
|
71 /** ?description */ |
|
72 extern ?data_type; |
|
73 |
|
74 *** forward declarations go here: |
|
75 |
|
76 class ?forward_classname; |
|
77 |
|
78 *** constants go here: |
|
79 |
|
80 /** ?description */ |
|
81 const ?type ?constant_var = ?constant; |
|
82 |
|
83 |
|
84 *** the class declaration goes here: |
|
85 |
|
86 /** |
|
87 * ?one_line_short_description |
|
88 * |
|
89 * ?more_complete_description |
|
90 * @code |
|
91 * ?good_class_usage_example(s) |
|
92 * @endcode |
|
93 * |
|
94 * @lib ?library |
|
95 * @since S60 ?S60_version *** for example, S60 v3.0 |
|
96 */ |
|
97 class TestClassName : public ?base_class_list |
|
98 { |
|
99 |
|
100 public: |
|
101 |
|
102 *** data types go here: |
|
103 |
|
104 /** ?description */ |
|
105 enum ?declaration |
|
106 |
|
107 /** ?description */ |
|
108 typedef ?declaration |
|
109 |
|
110 *** pure virtual functions go here: |
|
111 |
|
112 /** |
|
113 * ?description |
|
114 * |
|
115 * @since S60 ?S60_version |
|
116 * @param ?arg1 ?description |
|
117 * @param ?arg2 ?description |
|
118 * @return ?description |
|
119 */ |
|
120 ?IMPORT_C virtual ?type ?member_function( ?type1 ?arg1, ?type2 ?arg2 ) = 0; |
|
121 |
|
122 protected: |
|
123 |
|
124 *** function declarations as above |
|
125 |
|
126 }; |
|
127 |
|
128 |
|
129 #endif // M_TESTCLASSNAME_H |