sftemplateswizard/com.nokia.s60tools.templates.tests/data/templates/m_class_header_template.h
author dpodwall
Tue, 12 Jan 2010 13:17:53 -0600
changeset 0 61163b28edca
permissions -rw-r--r--
initial EPL conversion
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     1
/*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     2
* ============================================================================
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     3
*  Name        : ?filename.h
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     4
*  Part of     : ?Subsystem_name / ?Module_name       *** Info from the SWAD
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     5
*  Description : ?Description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     6
*  Version     : %version: % << Don't touch! Updated by Synergy at check-out.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     7
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     8
*  Copyright © ?year-?year Nokia Corporation and/or its subsidiary(-ies).
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     9
*  All rights reserved.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    10
*  This component and the accompanying materials are made available
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    11
*  under the terms of the License "?License"
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    12
*  which accompanies this distribution, and is available
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    13
*  at the URL "?LicenseUrl".
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    14
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    15
*  Initial Contributors:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    16
*  ?Company_name - initial contribution.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    17
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    18
*  Contributors:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    19
* 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    20
* ============================================================================
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    21
* Template version: 4.2
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    22
*/
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    23
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    24
*** INSTRUCTIONS TO THE TEMPLATE USER:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    25
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    26
*** This template follows the S60 coding conventions
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    27
*** (S60_Coding_Conventions.doc).  Remove all unneeded declarations
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    28
*** and definitions before checking the file in!  Also remove the
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    29
*** template's usage instructions, that is, everything that begins
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    30
*** with "***".
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    31
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    32
*** The copyright years should be < the year of the file's creation >
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    33
*** - < the year of the file's latest update >.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    34
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    35
*** Words that begin with "?" are for you to replace with your own
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    36
*** identifiers, filenames, or comments.  ?IMPORT_C means either the
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    37
*** IMPORT_C visibility directive, or nothing, depending on whether
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    38
*** the function is to be exported or not.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    39
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    40
*** To support building on Linux, use only forward slashes in include
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    41
*** directives.  Also, all filenames and pathnames must be completely
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    42
*** in lowercase.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    43
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    44
*** Indent four spaces per step, using spaces, not tabs, to display
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    45
*** the code consistently across different editors.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    46
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    47
*** An M class defines only pure virtual functions, therefore, is an
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    48
*** abstract base class.  An M class will derive from zero or more
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    49
*** other M classes.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    50
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    51
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    52
#ifndef ?M_CLASSNAME_H
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    53
#define ?M_CLASSNAME_H
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    54
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    55
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    56
*** system include files go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    57
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    58
#include <?include_file>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    59
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    60
*** user include files go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    61
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    62
#include "?include_file"
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    63
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    64
*** external data types go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    65
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    66
/**  ?description */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    67
extern ?data_type;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    68
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    69
*** forward declarations go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    70
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    71
class ?forward_classname;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    72
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    73
*** constants go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    74
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    75
/**  ?description */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    76
const ?type ?constant_var = ?constant;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    77
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    78
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    79
*** the class declaration goes here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    80
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    81
/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    82
 *  ?one_line_short_description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    83
 *
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    84
 *  ?more_complete_description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    85
 *  @code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    86
 *   ?good_class_usage_example(s)
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    87
 *  @endcode
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    88
 *
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    89
 *  @lib ?library
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    90
 *  @since S60 ?S60_version *** for example, S60 v3.0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    91
 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    92
class ?classname : public ?base_class_list
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    93
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    94
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    95
public:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    96
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    97
*** data types go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    98
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    99
    /**  ?description */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   100
    enum ?declaration
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   101
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   102
    /**  ?description */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   103
    typedef ?declaration
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   104
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   105
*** pure virtual functions go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   106
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   107
    /**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   108
     * ?description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   109
     *
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   110
     * @since S60 ?S60_version
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   111
     * @param ?arg1 ?description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   112
     * @param ?arg2 ?description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   113
     * @return ?description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   114
     */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   115
    ?IMPORT_C virtual ?type ?member_function( ?type1 ?arg1, ?type2 ?arg2 ) = 0;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   116
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   117
protected:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   118
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   119
*** function declarations as above
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   120
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   121
    };
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   122
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   123
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   124
#endif // ?M_CLASSNAME_H