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 *** An M class defines only pure virtual functions, therefore, is an

    47 *** abstract base class.  An M class will derive from zero or more

    48 *** other M classes.

    49 

    50 

    51 #ifndef ?M_CLASSNAME_H

    52 #define ?M_CLASSNAME_H

    53 

    54 

    55 *** system include files go here:

    56 

    57 #include <?include_file>

    58 

    59 *** user include files go here:

    60 

    61 #include "?include_file"

    62 

    63 *** external data types go here:

    64 

    65 /**  ?description */

    66 extern ?data_type;

    67 

    68 *** forward declarations go here:

    69 

    70 class ?forward_classname;

    71 

    72 *** constants go here:

    73 

    74 /**  ?description */

    75 const ?type ?constant_var = ?constant;

    76 

    77 

    78 *** the class declaration goes here:

    79 

    80 /**

    81  *  ?one_line_short_description

    82  *

    83  *  ?more_complete_description

    84  *  @code

    85  *   ?good_class_usage_example(s)

    86  *  @endcode

    87  *

    88  *  @lib ?library

    89  *  @since S60 ?S60_version *** for example, S60 v3.0

    90  */

    91 class ?classname : public ?base_class_list

    92     {

    93 

    94 public:

    95 

    96 *** data types go here:

    97 

    98     /**  ?description */

    99     enum ?declaration

   100 

   101     /**  ?description */

   102     typedef ?declaration

   103 

   104 *** pure virtual functions go here:

   105 

   106     /**

   107      * ?description

   108      *

   109      * @since S60 ?S60_version

   110      * @param ?arg1 ?description

   111      * @param ?arg2 ?description

   112      * @return ?description

   113      */

   114     ?IMPORT_C virtual ?type ?member_function( ?type1 ?arg1, ?type2 ?arg2 ) = 0;

   115 

   116 protected:

   117 

   118 *** function declarations as above

   119 

   120     };

   121 

   122 

   123 #endif // ?M_CLASSNAME_H