<?xml version="1.0" encoding="UTF-8"?>

<!-- Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). -->

<!-- All rights reserved. -->

<!-- This component and the accompanying materials are made available -->

<!-- under the terms of the License "Eclipse Public License v1.0" -->

<!-- which accompanies this distribution, and is available -->

<!-- at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

<componentDefinition xmlns="http://www.nokia.com/sdt/emf/component" 

xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" 

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >

	<component baseComponent="com.nokia.sdt.series60.ContainerBase" 

			friendlyName="%friendlyName" 

			qualifiedName="com.nokia.sdt.series60.CCoeControl" 

			category="Basic"

			instanceNameRoot="container"

			version="1.2">

		<documentation>

			<information>%information</information>

			<wizardDescription>%information</wizardDescription>

		</documentation>

		<symbian sdkName="com.nokia.series60" minSDKVersion="2.0" 

			className="CCoeControl" classHelpTopic="" />

		<designerImages 

			smallIconFile="CCoeControl_sm.png" 

			largeIconFile="CCoeControl.png"/>

		<attributes>

			<attribute key="is-top-level-content-container">true</attribute>

			<attribute key="container-background-color-property-name">backColor</attribute>

			<attribute key="event-handler-target">true</attribute>

			<attribute key="base-container-class">CCoeControl</attribute>

			<attribute key="associated-palette-drawer">Controls</attribute>

		</attributes>

		<properties>

			<property category="Appearance" name="backColor" displayName="%backColor" type="string" 

				editorClass="com.nokia.sdt.symbian.ui.editors.RGBEditorFactoryWithSystemColorCombo"

				descriptionKey="backColorDescription" />

			<componentReferenceProperty category="Behavior" scope="children" 

				constraint="com.nokia.sdt.series60.CCoeControlBase" name="initialFocus"

				descriptionKey="initialFocusDescription" />

		</properties>

		<extensionProperties name="default">

			<componentReferenceProperty category="Behavior" 

				constraint="com.nokia.sdt.series60.MenuBar" name="contextMenu"

				descriptionKey="contextMenuDescription" />

			<property category="Behavior" name="exitsApp" type="boolean" 

				default="true"

				descriptionKey="exitsAppDescription" />

		</extensionProperties>

		<implementations>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.IVisualAppearance"/>

				<script file="CCoeControl.js" prototype="CCoeControlVisual"/>

			</implementation>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.ILayout"/>

				<script file="CCoeControl.js" prototype="CCoeControlLayout"/>

			</implementation>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.IPropertyExtenders"/>

				<script file="CCoeControl.js" prototype="CCoeControlPropertyExtenders"/>

			</implementation>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.IQueryContainment"/>

				<script file="CCoeControl.js" prototype="CCoeControlQueryContainment"/>

			</implementation>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.IComponentInstancePropertyListener"/>

				<script file="CCoeControl.js" prototype="CCoeControlPropertyListener"/>

			</implementation>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.IComponentInstanceChildListener"/>

				<script file="CCoeControl.js" prototype="CCoeControlChildListener"/>

			</implementation>

			<implementation>

				<interface id="com.nokia.sdt.datamodel.adapter.IComponentEventInfo"/>

				<script file="CCoeControl.js" prototype="CCoeControlEventInfo"/>

			</implementation>

		</implementations>

		<sourceGen forms="AppUi AknView RootAppUi">

			<inline scope="prototype">

include("containerLibrary.js");

			</inline>

		<templateGroup id="HeaderFile">

			<!-- contributions as container -->		

			<defineLocation id="HEADER_FILE" domain="cpp" dir="${inc}" 

				file="${instanceName}.h"

				owned="false"

				location="">

			</defineLocation>

			<template id="InclGuard0" location="HEADER_FILE">

#ifndef ${instanceName.toUpperCase()}_H

#define ${instanceName.toUpperCase()}_H

			</template>

			<defineLocation id="HEADER_INCLUDES" baseLocation="HEADER_FILE"

				location="region(Generated Includes)"

				filter="unique-includes">

				<template><![CDATA[

#include <coecntrl.h>		

]]>				</template>

			</defineLocation>

			<template id="RealizeHeaderIncludes" location="HEADER_INCLUDES"/>

			<defineLocation id="EVENT_INCLUDES" baseLocation="HEADER_FILE"

				owned="false"

				filter="unique-includes"

				location="region(Event Handler Includes)" />

			<template id="RealizeEventIncludes" location="EVENT_INCLUDES" />

			<defineLocation id="HEADER_FORWARD_DECLARATIONS" baseLocation="HEADER_FILE"

				location="region(Generated Forward Declarations)">

				<template><![CDATA[

class MEikCommandObserver;		

]]>				</template>

			</defineLocation>	

			<template id="RealizeHeaderFwdDecls" location="HEADER_FORWARD_DECLARATIONS"/>

			<defineLocation id="CLASS" baseLocation="HEADER_FILE"

				owned="false"

				location="class(${className})">

				<template><![CDATA[

/**

 * Container class for ${instanceName}

 * 

 * @class	${className} ${instanceName}.h

 */

class ${className} : public CCoeControl

	{

public:

	// constructors and destructor

	${className}();

	static ${className}* NewL( 

		const TRect& aRect, 

		const CCoeControl* aParent, 

		MEikCommandObserver* aCommandObserver );

	static ${className}* NewLC( 

		const TRect& aRect, 

		const CCoeControl* aParent, 

		MEikCommandObserver* aCommandObserver );

	void ConstructL( 

		const TRect& aRect, 

		const CCoeControl* aParent, 

		MEikCommandObserver* aCommandObserver );

	virtual ~${className}();

public:

	// from base class CCoeControl

	TInt CountComponentControls() const;

	CCoeControl* ComponentControl( TInt aIndex ) const;

	TKeyResponse OfferKeyEventL( 

			const TKeyEvent& aKeyEvent, 

			TEventCode aType );

	void HandleResourceChange( TInt aType );

protected:

	// from base class CCoeControl

	void SizeChanged();

private:

	// from base class CCoeControl

	void Draw( const TRect& aRect ) const;

private:

	void InitializeControlsL();

	void LayoutControls();

	CCoeControl* iFocusControl;

	MEikCommandObserver* iCommandObserver;

	};

]]>				

				</template>

			</defineLocation>

			<template id="RealizeClass" location="CLASS"/>

			<defineLocation id="CLASS_METHODS" baseLocation="CLASS"

				filter="unique-prototypes"

				location="region(Generated Methods)">

				<template><![CDATA[

public: <% contrib.indentAdjust(-1); %>

]]>				</template>

			</defineLocation>

			<template id="RealizeClassMethods" location="CLASS_METHODS"/>

		<defineLocation id="CLASS_TYPES" baseLocation="CLASS"

			location="region(Generated Type Declarations)">

				<template><![CDATA[

public: <% contrib.indentAdjust(-1); %>

]]>				</template>

			</defineLocation>

			<template id="RealizeClassTypes" location="CLASS_TYPES"/>

			<defineLocation id="CLASS_IVARS" baseLocation="CLASS"

			location="region(Generated Instance Variables)">

				<template><![CDATA[

private: <% contrib.indentAdjust(-1); %>

]]>				</template>

			</defineLocation>

			<template id="RealizeClassIvars" location="CLASS_IVARS"/>

			<defineLocation id="BASE_CLASS_LIST" baseLocation="CLASS"

				owned="false"

				filter="unique-bases"

				location="bases()">

			</defineLocation>

			<template id="RealizeBaseClassList" location="BASE_CLASS_LIST" />

			<defineLocation id="CLASS_OVERRIDES" baseLocation="CLASS"

				owned="false"

				filter="unique-prototypes"

				location="region(Overridden Methods)">

				<template><![CDATA[

protected: <% contrib.indentAdjust(-1); %>

]]>				</template>

			</defineLocation>			

			<template id="RealizeClassOverrides" location="CLASS_OVERRIDES"/>

			<defineLocation id="CLASS_USERHANDLERS" baseLocation="CLASS"

				owned="false"

				filter="unique-prototypes"

				location="region(User Handlers)">

				<template><![CDATA[

protected: <% contrib.indentAdjust(-1); %>

]]>				</template>

			</defineLocation>				

			<template id="RealizeClassUserHandlers" location="CLASS_USERHANDLERS"/>

			<template id="IncludeGuardEnd" location="HEADER_FILE">

#endif // ${instanceName.toUpperCase()}_H

			</template>

			<defineLocation id="CHILD_ENUMS" baseLocation="CLASS"

				owned="false"

				location="enum(TControls)">

				<template><![CDATA[

public: <% contrib.indentAdjust(-1); %>

enum TControls

	{

	};

]]>				</template>

			</defineLocation>

			<defineLocation id="CHILD_ENUMS_CONTENTS" baseLocation="CHILD_ENUMS"

				location="region(Generated Contents)">

			</defineLocation>

			<template id="GetChildEnums" location="CHILD_ENUMS_CONTENTS"><![CDATA[<%

	// each control must contribute enumerators

	if (Engine.formMatches(form, ["AppUi", "AknView"])) {

		var enumContribs = Engine.generateChildContributions("HandleCCoeControlEnums");

		Engine.assignLocationsForPhase(enumContribs, "ChildEnumsContents", "CHILD_ENUMS_CONTENTS");

		contribs.addAll(enumContribs);

	}

%>]]>

			</template>

			<template id="AddLastChildEnum" location="CHILD_ENUMS">

// add any user-defined entries here...

ELastControl

			</template>

		</templateGroup>

		<templateGroup id="SourceFile">

			<defineLocation id="MAIN_FILE" domain="cpp" dir="${src}" 

				file="${instanceName}.cpp"

				owned="false"

				location="">

			</defineLocation>

			<template id="RealizeMainFile" location="MAIN_FILE"/>

			<defineLocation id="MAIN_SYSTEM_INCLUDES" baseLocation="MAIN_FILE"

				location="region(Generated System Includes)"

				filter="unique-includes">

			</defineLocation>

			<template id="RealizeSystemIncludes" location="MAIN_SYSTEM_INCLUDES" />

			<template id="ViewAppUiHeaderIncl" form="AknView" location="MAIN_SYSTEM_INCLUDES"><![CDATA[

#include <aknviewappui.h>

]]>			</template>

<!-- need to add in two steps to get uniqueness checking -->

			<template id="ContextMenuEikmenubInclude" 

				location="MAIN_SYSTEM_INCLUDES"><![CDATA[

<% if (properties.contextMenu != "") { %>		

#include <eikmenub.h>

<% } %>]]></template>

			<template id="ContextMenuEikcmobsInclude" 

				location="MAIN_SYSTEM_INCLUDES"><![CDATA[

<% if (properties.contextMenu != "") { %>		

#include <eikcmobs.h>

<% } %>]]></template>

			<defineLocation id="MAIN_USER_INCLUDES" baseLocation="MAIN_FILE"

				location="region(Generated User Includes)"

				filter="unique-includes">

				<template><![CDATA[

#include "${instanceName}.h"

]]>				</template>

			</defineLocation>		

			<template id="RealizeMainUserIncludes" location="MAIN_USER_INCLUDES"/>

			<template id="IncludeParentHeaderFile" location="MAIN_USER_INCLUDES"><![CDATA[

#include "${instance.parent.name}.h"

]]></template>

			<defineLocation id="CONSTANTS" baseLocation="MAIN_FILE"

				location="region(Generated Constants)">

			</defineLocation>

			<template id="RealizeConstants" location="CONSTANTS" />

			<defineLocation id="CONSTRUCTOR" baseLocation="MAIN_FILE"

				location="function(${className}::${className}())"

				owned="false">

				<template>

/**

 * First phase of Symbian two-phase construction. Should not 

 * contain any code that could leave.

 */

${className}::${className}()

	{

	}

				</template>

			</defineLocation>

			<template id="RealizeConstructor" location="CONSTRUCTOR" />

			<defineLocation id="CONSTRUCTOR_BODY" baseLocation="CONSTRUCTOR"

				location="region(Generated Contents)">

			</defineLocation>

			<template id="RealizeConstructorBody" location="CONSTRUCTOR_BODY"/>

			<defineLocation id="DESTRUCTOR" baseLocation="MAIN_FILE"

				owned="false"

				location="function(${className}::~${className}())">

				<template><![CDATA[

/** 

 * Destroy child controls.

 */

${className}::~${className}()

	{

	}

]]>				

				</template>			

			</defineLocation>

			<template id="RealizeDestructor" location="DESTRUCTOR"/>

			<defineLocation id="DESTRUCTOR_BODY" baseLocation="DESTRUCTOR"

				location="region(Generated Contents)">

			</defineLocation>

			<template id="RealizeDestructorBody" location="DESTRUCTOR_BODY"/>

			<template id="GetNewlImpls" location="MAIN_FILE"><![CDATA[

/**

 * Construct the control (first phase).

 *  Creates an instance and initializes it.

 *  Instance is not left on cleanup stack.

 * @param aRect bounding rectangle

 * @param aParent owning parent, or NULL

 * @param aCommandObserver command observer

 * @return initialized instance of ${className}

 */

${className}* ${className}::NewL( 

		const TRect& aRect, 

		const CCoeControl* aParent, 

		MEikCommandObserver* aCommandObserver )

	{

	${className}* self = ${className}::NewLC( 

			aRect, 

			aParent, 

			aCommandObserver );

	CleanupStack::Pop( self );

	return self;

	}

/**

 * Construct the control (first phase).

 *  Creates an instance and initializes it.

 *  Instance is left on cleanup stack.

 * @param aRect The rectangle for this window

 * @param aParent owning parent, or NULL

 * @param aCommandObserver command observer

 * @return new instance of ${className}

 */

${className}* ${className}::NewLC( 

		const TRect& aRect, 

		const CCoeControl* aParent, 

		MEikCommandObserver* aCommandObserver )

	{

	${className}* self = new ( ELeave ) ${className}();

	CleanupStack::PushL( self );

	self->ConstructL( aRect, aParent, aCommandObserver );

	return self;

	}

]]>			

			</template>

			<!-- note: this method is declared one-time when the class is created, and the definition

				is editable by the user.  The user has the freedom to modify the parameter list as well.

				We add '...' here to the function arguments *in the location only* to allow sourcegen to

				locate the method with added parameters, without regenerating it. -->

			<defineLocation id="CONSTRUCTL" baseLocation="MAIN_FILE"

				owned="false"

				location="function(${className}::ConstructL(const TRect&, const CCoeControl*, MEikCommandObserver*, ...))">

				<template><![CDATA[

/**

 * Construct the control (second phase).

 *  Creates a window to contain the controls and activates it.

 * @param aRect bounding rectangle

 * @param aCommandObserver command observer

 * @param aParent owning parent, or NULL

 */ 

void ${className}::ConstructL( 

		const TRect& aRect, 

		const CCoeControl* aParent, 

		MEikCommandObserver* aCommandObserver )

	{

	if ( aParent == NULL )

	    {

		CreateWindowL();

	    }

	else

	    {

	    SetContainerWindowL( *aParent );

	    }

	iFocusControl = NULL;

	iCommandObserver = aCommandObserver;

	InitializeControlsL();

	SetRect( aRect );

	ActivateL();

	}

]]>			

				</template>

			</defineLocation>

			<template id="RealizeConstructL" location="CONSTRUCTL"/>

			<defineLocation id="CONSTRUCTL_BODY" baseLocation="CONSTRUCTL"

				location="region(Post-ActivateL initializations)">

			</defineLocation>

			<template id="RealizeConstructLBody" location="CONSTRUCTL_BODY" />

			<defineLocation id="COUNT_COMPONENT_CONTROLS" baseLocation="MAIN_FILE"

				owned="false"

				location="function(${className}::CountComponentControls())">

				<template><![CDATA[

/**

* Return the number of controls in the container (override)

* @return count

*/

TInt ${className}::CountComponentControls() const

	{

	return ( int ) ELastControl;

	}

]]>				

				</template>

			</defineLocation>

			<template id="RealizeCountComponentControls" 

				location="COUNT_COMPONENT_CONTROLS" />

			<defineLocation id="COMPONENT_CONTROL" baseLocation="MAIN_FILE"

				owned="false"

				location="function(${className}::ComponentControl(TInt))">

				<template><![CDATA[

/**

* Get the control with the given index (override)

* @param aIndex Control index [0...n) (limited by #CountComponentControls)

* @return Pointer to control

*/

CCoeControl* ${className}::ComponentControl( TInt aIndex ) const

	{

	}

]]>				

				</template>

			</defineLocation>

			<template id="RealizeComponentControl" location="COMPONENT_CONTROL"/>

			<defineLocation id="COMPONENT_CONTROL_BODY" baseLocation="COMPONENT_CONTROL"

				location="region(Generated Contents)">

			</defineLocation>

			<template id="ComponentControlSwitch1" location="COMPONENT_CONTROL_BODY"><![CDATA[

switch ( aIndex )

	{

]]>			</template>

			<template id="GetChildSwitchCases" location="COMPONENT_CONTROL_BODY"><![CDATA[<%

	// each control must contribute switch cases

	if (Engine.formMatches(form, ["AppUi", "AknView"])) {

		var switchContribs = Engine.generateChildContributions("HandleComponentSwitchDispatch");

		Engine.assignLocationsForPhase(switchContribs, "ComponentControlBody", "COMPONENT_CONTROL_BODY");

		contribs.addAll(switchContribs);

	}