sftemplateswizard/com.nokia.s60tools.symbianfoundationtemplates/templates/source_template.cpp
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.cpp
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     4
*  Part of     : ?Subsystem_name / ?Module_name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     5
*  Description : ?Description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     6
*  Version     : %version: %
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     7
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     8
*  Copyright © ?year-?year ?Company_copyright.
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
*  ?Company_name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    20
* ============================================================================
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    21
* Template version: 4.1
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 Symbian Foundation coding conventions.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    27
*** Remove all unneeded declarations and definitions before checking 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    28
*** the file in!  Also remove the template's usage instructions, that is, 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    29
*** everything that begins with "***".
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    30
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    31
*** The copyright years should be < the year of the file's creation >
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    32
*** - < the year of the file's latest update >.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    33
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    34
*** Words that begin with "?" are for you to replace with your own
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    35
*** identifiers, filenames, comments, or code.  ?EXPORT_C means either
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    36
*** the EXPORT_C visibility directive, or nothing, depending on whether
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    37
*** the function is to be exported or not.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    38
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    39
*** To support building on Linux, use only forward slashes in include
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    40
*** directives.  Also, all filenames and pathnames must be completely
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    41
*** in lowercase.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    42
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    43
*** Indent four spaces per step, using spaces, not tabs, to display
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    44
*** the code consistently across different editors.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    45
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    46
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    47
*** Implement only one class in one file.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    48
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    49
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    50
*** system include files go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    51
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    52
#include <?include_file>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    53
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    54
*** user include files go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    55
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    56
#include "?include_file"
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    57
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    58
*** external function prototypes go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    59
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    60
extern ?external_function( ?arg_type, ?arg_type );
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    61
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    62
*** local constants go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    63
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    64
const ?type ?constant_var = ?constant;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    65
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    66
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    67
// ======== LOCAL FUNCTIONS ========
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    68
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    69
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    70
// ?description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    71
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    72
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    73
?type ?function_name( ?arg_type ?arg,
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    74
                      ?arg_type ?arg )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    75
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    76
    ?code  // ?implementation comment on this line
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    77
    // ?implementation comment on the following statement or block:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    78
    ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    79
    }
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
// ======== MEMBER FUNCTIONS ========
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    83
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    84
*** In the same order as defined in the header file.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    85
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    86
*** The first function includes examples of correct tabulation of some
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    87
*** commonly used statements, and some suggested places to put
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    88
*** implementation comments, if needed.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    89
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    90
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    91
// ?description_if_needed
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    92
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    93
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    94
?classname::?classname()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    95
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    96
    if ( ?condition )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    97
        {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    98
        // ?implementation_comment
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    99
        ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   100
        }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   101
    else
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   102
        {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   103
        // ?implementation_comment
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   104
        ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   105
        }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   106
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   107
    // ?implementation_comment
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   108
    while ( ?condition )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   109
        {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   110
        ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   111
        }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   112
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   113
    // ?implementation_comment
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   114
    for ( ?for_init_statement; ?condition; ?expression )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   115
        {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   116
        ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   117
        }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   118
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   119
    // ?implementation_comment
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   120
    switch ( ?condition )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   121
        {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   122
        case ?constant:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   123
            ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   124
            break;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   125
        case ?constant:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   126
            ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   127
            // fall-through intended here
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   128
        case ?constant:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   129
            ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   130
            break;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   131
        default:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   132
            ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   133
            break;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   134
        }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   135
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   136
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   137
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   138
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   139
// ?description_if_needed
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   140
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   141
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   142
void ?classname::ConstructL()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   143
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   144
    ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   145
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   146
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   147
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   148
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   149
// ?description_if_needed
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   150
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   151
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   152
EXPORT_C ?classname* ?classname::NewL()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   153
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   154
    ?classname* self = ?classname::NewLC();
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   155
    CleanupStack::Pop( self );
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   156
    return self;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   157
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   158
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   159
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   160
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   161
// ?description_if_needed
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   162
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   163
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   164
EXPORT_C ?classname* ?classname::NewLC()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   165
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   166
    ?classname* self = new( ELeave ) ?classname;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   167
    CleanupStack::PushL( self );
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   168
    self->ConstructL();
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   169
    return self;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   170
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   171
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   172
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   173
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   174
// ?description_if_needed
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   175
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   176
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   177
?classname::~?classname()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   178
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   179
    ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   180
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   181
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   182
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   183
*** Non-derived function:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   184
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   185
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   186
// ?implementation_description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   187
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   188
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   189
?EXPORT_C ?type ?classname::?member_function(
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   190
    ?really_really_really_really_long_arg_type_1 ?really_really_long_arg_1,
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   191
    ?really_really_really_really_long_arg_type_2 ?really_really_long_arg_2 )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   192
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   193
    ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   194
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   195
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   196
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   197
*** Derived function:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   198
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   199
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   200
// From class ?base_class.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   201
// ?implementation_description
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   202
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   203
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   204
?EXPORT_C ?type ?function_name( ?arg_type_1 ?arg_1, ?arg_type_2 ?arg_2 )
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   205
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   206
    ?code
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   207
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   208
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   209
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   210
// ======== GLOBAL FUNCTIONS ========
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   211
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   212
*** For an application's UiApp class, functions NewApplication and E32Main
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   213
*** should go here:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   214
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   215
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   216
// Constructs and returns an application object.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   217
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   218
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   219
EXPORT_C CApaApplication* NewApplication()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   220
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   221
    return new ?CMyApplication;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   222
    }
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   223
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   224
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   225
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   226
// Main function of the application executable.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   227
// ---------------------------------------------------------------------------
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   228
//
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   229
GLDEF_C TInt E32Main()
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   230
    {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   231
    return EikStart::RunApplication( NewApplication );
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   232
    }