diff -r 7b5e8f6c4370 -r b46382ab04d2 uidesigner/com.nokia.sdt.series60.componentlibrary/components/CommonMacros.inc.html --- a/uidesigner/com.nokia.sdt.series60.componentlibrary/components/CommonMacros.inc.html Tue Nov 10 17:08:19 2009 -0600 +++ b/uidesigner/com.nokia.sdt.series60.componentlibrary/components/CommonMacros.inc.html Thu Nov 12 14:50:22 2009 -0600 @@ -1,1393 +1,19 @@ - - - -Help for Macros in CommonMacros.inc - - -

-

Table of contents

-

-DeclareMethod -

- -

-GenerateDefaultFunctionBody -

- -

-DefineMethod -

- -

-GenerateMethod -

- -

-DefineMethodWithOwnedBody -

- -

-GenerateMethodWithOwnedBody -

- -

-GenerateMethodWithVariantArguments -

- -

-GenerateVirtualMethodOverrideForEventHandler -

- -

-GenerateUserEventHandlerFunction -

- -

-

- -

DeclareMethod

-

-

Declares a method, e.g., the prototype.

-

-

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
ReturnTypenovoid -

-

return type for function

-

-
IsStaticnofalse -

-

is the function static?

-

-
IsVirtualnofalse -

-

is the function virtual? (ignored if IsStatic)

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
ReturnTypenovoid -

-

return type for function

-

-
IsStaticnofalse -

-

is the function static?

-

-
IsVirtualnofalse -

-

is the function virtual? (ignored if IsStatic)

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
- - -

GenerateDefaultFunctionBody

-

-

Create the default body for a function. If FunctionBody is set, emits that. If ReturnType is not void and DefaultReturn is set, create a return statement using its value.

-

-

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
ReturnTypenovoid -

-

return type for function

-

-
FunctionBodyno  -

-

text inside function body (comment and/or code)

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
ReturnTypenovoid -

-

return type for function

-

-
FunctionBodyno  -

-

text inside function body (comment and/or code)

-

-
- - -

DefineMethod

-

-

Defines a method to one location, optionally generating body text, or a default return statement. The generated function is owned by default.

-

-

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
DefnLocationyes  -

-

name of location into which to add the function

-

-
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
ClassNameno${className} -

-

the class name

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
ClassNameno${className} -

-

the class name

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
-

Inherited from GenerateDefaultFunctionBody:

- - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
ReturnTypenovoid -

-

return type for function

-

-
FunctionBodyno  -

-

text inside function body (comment and/or code)

-

-
- - -

GenerateMethod

-

-

Declares and defines a method to one location and adds the prototype to another location.

-

-

Arguments

- - -
ArgumentReq'd?DefaultDescription
-

Inherited from DeclareMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
ReturnTypenovoid -

-

return type for function

-

-
IsStaticnofalse -

-

is the function static?

-

-
IsVirtualnofalse -

-

is the function virtual? (ignored if IsStatic)

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
-

Inherited from DefineMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
FunctionBodyno  -

-

text inside function body (comment and/or code)

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
ClassNameno${className} -

-

the class name

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
- - -

DefineMethodWithOwnedBody

-

-

Defines a method with an owned body section.

-

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

-

Also, no default function code is generated, so the provided StartFunctionBody, FunctionBody, and EndFunctionBody must account for any return statements.

-

-

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionBodyno  -

-

text inside owned part of function body

-

-
OwnedRegionLocationIdno$(FunctionLocationId)_BODY -

-

location id for enclosed body

-

-
OwnedRegionNamenoGenerated Contents -

-

region name for enclosed body

-

-
StartFunctionBodyno  -

-

text inside function body (comment and/or code) before the owned section

-

-
EndFunctionBodyno  -

-

text inside function body (comment and/or code) after the owned section

-

-
FunctionBodyno  -

-

text inside owned part of function body

-

-
OwnedRegionLocationIdno$(FunctionLocationId)_BODY -

-

location id for enclosed body

-

-
OwnedRegionNamenoGenerated Contents -

-

region name for enclosed body

-

-
StartFunctionBodyno  -

-

text inside function body (comment and/or code) before the owned section

-

-
EndFunctionBodyno  -

-

text inside function body (comment and/or code) after the owned section

-

-
-

Inherited from DefineMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
ReturnTypenovoid -

-

return type for function

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
ClassNameno${className} -

-

the class name

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
- - -

GenerateMethodWithOwnedBody

-

-

Declares and defines a method with an owned body section to one location and adds the prototype to another location.

-

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

-

-

Arguments

- - -
ArgumentReq'd?DefaultDescription
-

Inherited from DefineMethodWithOwnedBody:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
ReturnTypenovoid -

-

return type for function

-

-
FunctionBodyno  -

-

text inside owned part of function body

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
ClassNameno${className} -

-

the class name

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
OwnedRegionLocationIdno$(FunctionLocationId)_BODY -

-

location id for enclosed body

-

-
OwnedRegionNamenoGenerated Contents -

-

region name for enclosed body

-

-
StartFunctionBodyno  -

-

text inside function body (comment and/or code) before the owned section

-

-
EndFunctionBodyno  -

-

text inside function body (comment and/or code) after the owned section

-

-
-

Inherited from DeclareMethod:

- - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
IsStaticnofalse -

-

is the function static?

-

-
IsVirtualnofalse -

-

is the function virtual? (ignored if IsStatic)

-

-
- - -

GenerateMethodWithVariantArguments

-

-

Declares and defines an owned method with variant arguments to one location and adds the prototype to another location.

-

Variant arguments means design-time variable (not C varargs). The function has a non-empty list of fixed arguments followed by a non-empty list of variable arguments which are generated by a Javascript expression.

-

The generated function is owned by default. It doesn't make sense to use this non-owned, since this will introduce compile errors when the prototype changes and the old body remains behind.

-

-

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionArgsyes  -

-

canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma

-

-
FunctionVarArgsAllowEmptyyes  -

-

tell whether the varargs may be empty

-

-
FunctionVarArgsDeclExpryes  -

-

generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

-

-
FunctionVarArgsDefnExpryes  -

-

generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

-

-
FunctionArgsyes  -

-

canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma

-

-
FunctionVarArgsAllowEmptyyes  -

-

tell whether the varargs may be empty

-

-
FunctionVarArgsDeclExpryes  -

-

generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

-

-
FunctionVarArgsDefnExpryes  -

-

generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

-

-
IsOwnednotrue -

-

tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind.

-

-
IsOwnednotrue -

-

tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind.

-

-
-

Inherited from GenerateMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionNameyes  -

-

name of function

-

-
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
ReturnTypenovoid -

-

return type for function

-

-
IsStaticnofalse -

-

is the function static?

-

-
IsVirtualnofalse -

-

is the function virtual? (ignored if IsStatic)

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
FunctionBodyno  -

-

text inside function body (comment and/or code)

-

-
ClassNameno${className} -

-

the class name

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
- - -

GenerateVirtualMethodOverrideForEventHandler

-

-

Override a virtual method with a non-owned function with an owned body. This must be invoked in a templateGroup that has an ifEvents="..." attribute, so the 'event' variable is available.

-

-

Arguments

- - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
ClassNameno${handlerClassName} -

-

the name of the class

-

-
UserHandlerFunctionArgsno  -

-

the arguments passed to the user handler function (== FunctionArgs by default)

-

-
ClassNameno${handlerClassName} -

-

the name of the class

-

-
UserHandlerFunctionArgsno  -

-

the arguments passed to the user handler function (== FunctionArgs by default)

-

-
-

Inherited from GenerateMethodWithOwnedBody:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

name of the function location to define; body is named id+_BODY

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
FunctionNameyes  -

-

name of function

-

-
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
ReturnTypenovoid -

-

return type for function

-

-
FunctionBodyno  -

-

text inside owned part of function body

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
FunctionCommentno  -

-

comment appearing before function defn

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
OwnedRegionLocationIdno$(FunctionLocationId)_BODY -

-

location id for enclosed body

-

-
OwnedRegionNamenoGenerated Contents -

-

region name for enclosed body

-

-
StartFunctionBodyno  -

-

text inside function body (comment and/or code) before the owned section

-

-
EndFunctionBodyno  -

-

text inside function body (comment and/or code) after the owned section

-

-
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
- - -

GenerateUserEventHandlerFunction

-

-

Define a user handler declaration and function.

-

Provides a default header comment and body comment.

-

This is NOT conditional, so include it in a <templateGroup ifEvents="..." />

-

-

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionLocationIdyes  -

-

the id for the event handler function

-

-
FunctionLocationIdyes  -

-

the id for the event handler function

-

-
FunctionNameno${event.handlerName} -

-

the name of the function/method for the handler; generally the default should be used (the name specified in the Events view)

-

-
FunctionBodyno  -

-

the body of the function, which by default is a TODO comment

-

-
ClassNameno${handlerClassName} -

-

the name of the class that receives the handler

-

-
FunctionCommentno  -

-

the comment for the function

-

-
FunctionNameno${event.handlerName} -

-

the name of the function/method for the handler; generally the default should be used (the name specified in the Events view)

-

-
FunctionBodyno  -

-

the body of the function, which by default is a TODO comment

-

-
ClassNameno${handlerClassName} -

-

the name of the class that receives the handler

-

-
FunctionCommentno  -

-

the comment for the function

-

-
-

Inherited from GenerateMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentReq'd?DefaultDescription
FunctionArgsyes  -

-

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

-

-
DefnLocationyes  -

-

name of location into which to add the function

-

-
DeclLocationno  -

-

name of location into which to add the prototype (either this or DeclPhase must be defined)

-

-
DeclPhaseno  -

-

name of phase into which to add the prototype (either this or DeclLocation must be defined)

-

-
ReturnTypenovoid -

-

return type for function

-

-
IsConstnofalse -

-

add 'const' modifier to function?

-

-
DefaultReturnno  -

-

default value to return; overridden if FunctionBody is specified

-

-
IsOwnednotrue -

-

is the function body owned?

-

-
IsEventHandlernofalse -

-

is the function body the user event handler?

-

-
Initializersno  -

-

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

-

-
- -

- - +Help for Macros in CommonMacros.inc

Table of contents

DeclareMethod

+

GenerateDefaultFunctionBody

+

DefineMethod

+

GenerateMethod

+

DefineMethodWithOwnedBody

+

GenerateMethodWithOwnedBody

+

GenerateMethodWithVariantArguments

+

GenerateVirtualMethodOverrideForEventHandler

+

GenerateUserEventHandlerFunction

+

DeclareMethod

Declares a method, e.g., the prototype.

Arguments

ArgumentReq'd?DefaultDescription
FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

ReturnTypenovoid

return type for function

IsStaticnofalse

is the function static?

IsVirtualnofalse

is the function virtual? (ignored if IsStatic)

IsConstnofalse

add 'const' modifier to function?

DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

ReturnTypenovoid

return type for function

IsStaticnofalse

is the function static?

IsVirtualnofalse

is the function virtual? (ignored if IsStatic)

IsConstnofalse

add 'const' modifier to function?

+

GenerateDefaultFunctionBody

Create the default body for a function. If FunctionBody is set, emits that. If ReturnType is not void and DefaultReturn is set, create a return statement using its value.

Arguments

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

ReturnTypenovoid

return type for function

FunctionBodyno 

text inside function body (comment and/or code)

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

ReturnTypenovoid

return type for function

FunctionBodyno 

text inside function body (comment and/or code)

+

DefineMethod

Defines a method to one location, optionally generating body text, or a default return statement. The generated function is owned by default.

Arguments

ArgumentReq'd?DefaultDescription
DefnLocationyes 

name of location into which to add the function

FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DefnLocationyes 

name of location into which to add the function

FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

IsOwnednotrue

is the function body owned?

IsConstnofalse

add 'const' modifier to function?

ClassNameno${className}

the class name

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

IsOwnednotrue

is the function body owned?

IsConstnofalse

add 'const' modifier to function?

ClassNameno${className}

the class name

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

Inherited from GenerateDefaultFunctionBody:

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

ReturnTypenovoid

return type for function

FunctionBodyno 

text inside function body (comment and/or code)

+

GenerateMethod

Declares and defines a method to one location and adds the prototype to another location.

Arguments

ArgumentReq'd?DefaultDescription

Inherited from DeclareMethod:

ArgumentReq'd?DefaultDescription
FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

ReturnTypenovoid

return type for function

IsStaticnofalse

is the function static?

IsVirtualnofalse

is the function virtual? (ignored if IsStatic)

IsConstnofalse

add 'const' modifier to function?

Inherited from DefineMethod:

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefnLocationyes 

name of location into which to add the function

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

FunctionBodyno 

text inside function body (comment and/or code)

IsOwnednotrue

is the function body owned?

ClassNameno${className}

the class name

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

+

DefineMethodWithOwnedBody

Defines a method with an owned body section.

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

Also, no default function code is generated, so the provided StartFunctionBody, FunctionBody, and EndFunctionBody must account for any return statements.

Arguments

ArgumentReq'd?DefaultDescription
FunctionBodyno 

text inside owned part of function body

OwnedRegionLocationIdno$(FunctionLocationId)_BODY

location id for enclosed body

OwnedRegionNamenoGenerated Contents

region name for enclosed body

StartFunctionBodyno 

text inside function body (comment and/or code) before the owned section

EndFunctionBodyno 

text inside function body (comment and/or code) after the owned section

FunctionBodyno 

text inside owned part of function body

OwnedRegionLocationIdno$(FunctionLocationId)_BODY

location id for enclosed body

OwnedRegionNamenoGenerated Contents

region name for enclosed body

StartFunctionBodyno 

text inside function body (comment and/or code) before the owned section

EndFunctionBodyno 

text inside function body (comment and/or code) after the owned section

Inherited from DefineMethod:

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefnLocationyes 

name of location into which to add the function

FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

ReturnTypenovoid

return type for function

IsOwnednotrue

is the function body owned?

IsConstnofalse

add 'const' modifier to function?

ClassNameno${className}

the class name

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

+

GenerateMethodWithOwnedBody

Declares and defines a method with an owned body section to one location and adds the prototype to another location.

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

Arguments

ArgumentReq'd?DefaultDescription

Inherited from DefineMethodWithOwnedBody:

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefnLocationyes 

name of location into which to add the function

FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

ReturnTypenovoid

return type for function

FunctionBodyno 

text inside owned part of function body

IsOwnednotrue

is the function body owned?

IsConstnofalse

add 'const' modifier to function?

ClassNameno${className}

the class name

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

OwnedRegionLocationIdno$(FunctionLocationId)_BODY

location id for enclosed body

OwnedRegionNamenoGenerated Contents

region name for enclosed body

StartFunctionBodyno 

text inside function body (comment and/or code) before the owned section

EndFunctionBodyno 

text inside function body (comment and/or code) after the owned section

Inherited from DeclareMethod:

ArgumentReq'd?DefaultDescription
DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

IsStaticnofalse

is the function static?

IsVirtualnofalse

is the function virtual? (ignored if IsStatic)

+

GenerateMethodWithVariantArguments

Declares and defines an owned method with variant arguments to one location and adds the prototype to another location.

Variant arguments means design-time variable (not C varargs). The function has a non-empty list of fixed arguments followed by a non-empty list of variable arguments which are generated by a Javascript expression.

The generated function is owned by default. It doesn't make sense to use this non-owned, since this will introduce compile errors when the prototype changes and the old body remains behind.

Arguments

ArgumentReq'd?DefaultDescription
FunctionArgsyes 

canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma

FunctionVarArgsAllowEmptyyes 

tell whether the varargs may be empty

FunctionVarArgsDeclExpryes 

generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

FunctionVarArgsDefnExpryes 

generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

FunctionArgsyes 

canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma

FunctionVarArgsAllowEmptyyes 

tell whether the varargs may be empty

FunctionVarArgsDeclExpryes 

generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

FunctionVarArgsDefnExpryes 

generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma

IsOwnednotrue

tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind.

IsOwnednotrue

tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind.

Inherited from GenerateMethod:

ArgumentReq'd?DefaultDescription
FunctionNameyes 

name of function

FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefnLocationyes 

name of location into which to add the function

DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

ReturnTypenovoid

return type for function

IsStaticnofalse

is the function static?

IsVirtualnofalse

is the function virtual? (ignored if IsStatic)

IsConstnofalse

add 'const' modifier to function?

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

FunctionBodyno 

text inside function body (comment and/or code)

ClassNameno${className}

the class name

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

+

GenerateVirtualMethodOverrideForEventHandler

Override a virtual method with a non-owned function with an owned body. This must be invoked in a templateGroup that has an ifEvents="..." attribute, so the 'event' variable is available.

Arguments

ArgumentReq'd?DefaultDescription
ClassNameno${handlerClassName}

the name of the class

UserHandlerFunctionArgsno 

the arguments passed to the user handler function (== FunctionArgs by default)

ClassNameno${handlerClassName}

the name of the class

UserHandlerFunctionArgsno 

the arguments passed to the user handler function (== FunctionArgs by default)

Inherited from GenerateMethodWithOwnedBody:

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

name of the function location to define; body is named id+_BODY

DefnLocationyes 

name of location into which to add the function

FunctionNameyes 

name of function

FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

ReturnTypenovoid

return type for function

FunctionBodyno 

text inside owned part of function body

IsOwnednotrue

is the function body owned?

IsConstnofalse

add 'const' modifier to function?

FunctionCommentno 

comment appearing before function defn

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

OwnedRegionLocationIdno$(FunctionLocationId)_BODY

location id for enclosed body

OwnedRegionNamenoGenerated Contents

region name for enclosed body

StartFunctionBodyno 

text inside function body (comment and/or code) before the owned section

EndFunctionBodyno 

text inside function body (comment and/or code) after the owned section

DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

+

GenerateUserEventHandlerFunction

Define a user handler declaration and function.

Provides a default header comment and body comment.

This is NOT conditional, so include it in a <templateGroup ifEvents="..." />

Arguments

ArgumentReq'd?DefaultDescription
FunctionLocationIdyes 

the id for the event handler function

FunctionLocationIdyes 

the id for the event handler function

FunctionNameno${event.handlerName}

the name of the function/method for the handler; generally the default should be used (the name specified in the Events view)

FunctionBodyno 

the body of the function, which by default is a TODO comment

ClassNameno${handlerClassName}

the name of the class that receives the handler

FunctionCommentno 

the comment for the function

FunctionNameno${event.handlerName}

the name of the function/method for the handler; generally the default should be used (the name specified in the Events view)

FunctionBodyno 

the body of the function, which by default is a TODO comment

ClassNameno${handlerClassName}

the name of the class that receives the handler

FunctionCommentno 

the comment for the function

Inherited from GenerateMethod:

ArgumentReq'd?DefaultDescription
FunctionArgsyes 

canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")

DefnLocationyes 

name of location into which to add the function

DeclLocationno 

name of location into which to add the prototype (either this or DeclPhase must be defined)

DeclPhaseno 

name of phase into which to add the prototype (either this or DeclLocation must be defined)

ReturnTypenovoid

return type for function

IsConstnofalse

add 'const' modifier to function?

DefaultReturnno 

default value to return; overridden if FunctionBody is specified

IsOwnednotrue

is the function body owned?

IsEventHandlernofalse

is the function body the user event handler?

Initializersno 

provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically

Realizenofalse

If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

+

\ No newline at end of file