// Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

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

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// Tests interface between container control and component controls.\n

// 

//

/**

 @file

 @internalComponent - Internal Symbian test code

*/

#include <coeaui.h>

#include <coemain.h>

#include <coedef.h>

#include <coesndpy.h>

#include <basched.h>

#include <bassnd.h>

#include <ecom/ecom.h>

#include "TCone6Step.h"

#include <gdi.h>

/**   Constructor fo CCtlBase class.\n */

CCtlBase::CCtlBase()

	{

	}

/**

  Second phase constructor for CCtlBase Class.\n

  Creates a font for the default graphics device, based on the specified TFontSpec.\n

  Initiazes the screen font for the control.\n

*/	

void CCtlBase::ConstructL()

	{

	TFontSpec spec(_L("Arial"),240);

	iFont = iCoeEnv->CreateScreenFontL( spec ) ;

	}

/**   Destructor for CCtlBase class.\n */	

CCtlBase::~CCtlBase()

	{

 	iCoeEnv->ReleaseScreenFont(iFont);

	}

/**

  Writes the text "aText" on the control.\n

  Sets the font,pen colour,brush style used for writing the text.\n

  Draws the text uisng Draw Text function of Graphics context.\n

*/	

void CCtlBase::WriteName( CWindowGc& aGc, const TDesC& aText ) const 

	{

    TRect rect = Rect() ;

    rect.Shrink( 3, 3 ) ;

    aGc.UseFont( iFont ) ;

    TInt ascent = ( rect.iBr.iY - rect.iTl.iY-iFont->HeightInPixels() ) / 2 + iFont->AscentInPixels() ;

    aGc.SetPenColor( KRgbBlack ) ;

    aGc.SetBrushStyle( CGraphicsContext::ESolidBrush ) ;

    aGc.DrawText( aText, rect, ascent, CGraphicsContext::ECenter ) ;	

	}

/**

  Draw function for the CCtlBase class.\n

*/	

void CCtlBase::DoDraw( CWindowGc& aGc, TRect aRect ) const

	{

	aGc.DrawRect( aRect ) ;

	aRect.Shrink( 1, 1 ) ;

	aGc.SetBrushStyle( CGraphicsContext::ESolidBrush ) ;

	aGc.DrawRect( aRect ) ;

	WriteName( aGc, *iName ) ;

	}

/** 

  Constructor for CTestMCoeFocusObserver class.\n

*/

CTestMCoeFocusObserver::CTestMCoeFocusObserver(CCoeControl& aContainer) : iCtlContainer(aContainer)

	{

	}

/** 

  Destructor for CTestMCoeFocusObserver class.\n

*/

CTestMCoeFocusObserver::~CTestMCoeFocusObserver()

	{

	}

void CTestMCoeFocusObserver::HandleChangeInFocus()

	{

	}

/**

  Handles destruction of any control. It is called by framework if any control is destroyed.\n

  Accesses the component controls to make sure the components are not removed from

  CCoeControlArray before notifying the observer.\n

*/

void CTestMCoeFocusObserver::HandleDestructionOfFocusedItem()

	{

	TInt cnt = iCtlContainer.CountComponentControls();

	while(cnt--)

		{

		CCoeControl* child = iCtlContainer.ComponentControl(cnt);

		child->SetFocus(ETrue); // use control to make sure its not deleted

		}

	}

/**

  Constructor for the CCtlContainer class.\n

*/

CCtlContainer::CCtlContainer()

	{	

	}

/**

  Destructor for CCtlContainer class.\n

  Deletes the iName member variable.\n

*/	

CCtlContainer::~CCtlContainer()

	{

	// kids should be destroyed automatically	

	delete iName ;

	}

/**

  Second phase constructor for CCtlContainer class.\n

  Invokes the base class "CCtlBase" second phase constructor.\n

  Adds three  objects each of CCtlContainee class as component controls.\n

  The first two are added using a component Id while the same is not provided for the third control.\n

  The container control window is activated.\n

*/	

void CCtlContainer::ConstructL( const TDesC& aName )

	{

	CCtlBase::ConstructL() ;

	// construct the kids, add them to the array.	

	iName = aName.AllocL() ;

	CreateWindowL() ;

	InitComponentArrayL();

	CCtlContainee* child = NULL ;

	child = new (ELeave) CCtlContainee ;

	Components().AppendLC( child, KChildOneID ) ;

	child->ConstructL( _L("child1") ) ;

	CleanupStack::Pop( child ) ;

	child = new (ELeave) CCtlContainee ;

	Components().AppendLC( child, KChildTwoID ) ;

	child->ConstructL( _L("child2") ) ;

	CleanupStack::Pop( child ) ;

	CCtlContainee* temp = new (ELeave) CCtlContainee ;

	Components().AppendLC( temp ) ;

	temp ->ConstructL( _L("orphan") ) ;

	CleanupStack::Pop( temp ) ;	

	iOrphan = temp ;		

	ActivateL() ;

	}

/**

  Sets the size of the component objects based on the present size of the container window.\n

  Calculates the present size of the container control and also the number of component objects.\n

  Sets the component object dimensions accordingly.\n

*/	

void CCtlContainer::SizeChanged() 

	{

	// set the size of the children

	TRect rect = Rect() ;

	TSize size = rect.Size() ;

	TPoint tl = rect.iTl ;

	TInt childCount = CountComponentControls() ;

	if ( childCount > 0 )

		{

		size.iWidth = size.iWidth/childCount ;

		size.iHeight = size.iHeight/childCount ;

		CCoeControl* child ;

		for ( TInt ii = 0; ii < childCount ; ++ii )

			{

			child = ComponentControl( ii ) ;

			child->SetRect( TRect( tl, size ) ) ;

			tl.iX += size.iWidth ;

			tl.iY += size.iHeight ;

			}

		}

	}

/**

  Draw function to draw the container control.\n

  Gets a handle to the Windows Graphic context.\n

  Calculates the present dimensions of the control and invokes the DoDraw function.\n

*/

void CCtlContainer::Draw( const TRect& /*aRect*/ ) const

	{

	// get a graphics contect - outline the control

	CWindowGc& gc=SystemGc();

	TRect rect=Rect();

	gc.SetBrushColor( KRgbBlue ) ;

	DoDraw( gc, rect ) ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestRemoveControlById

  @SYMPREQ

  @SYMTestCaseDesc Removes a component with Id KChildTwoID using API RemoveComponentById.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Removes a component control using Component Id.\n

  Removes a component with Id KChildTwoID using API RemoveComponentById.\n

  The API removes a component control from a component array.

  It also sets the component's parent to <code>NULL</code>.\n

  The component control is later deleted.\n

  @SYMTestExpectedResults : Boolean, True if Component control is deleted.\n

  @SYMTestType : CIT 

*/

TBool CCtlContainer::TestRemoveControlById() 

	{

	TBool seemsOK ;

	TInt count = CountComponentControls() ;

	CCoeControl* runt = NULL ;

	runt = Components().RemoveById( KChildTwoID ) ;

	seemsOK = ( ( runt != NULL ) && ( CountComponentControls() == (count - 1) )) ;

	// So far, so good.  This is a good time to test RemoveComponent() for non-existant

	if ( seemsOK )

		{

		TInt err =  Components().Remove( runt ) ; // should return KErrNotFound

		seemsOK = ( err == KErrNotFound ) ;

		}

	delete runt ;

	return seemsOK  ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestCleanupL

  @SYMPREQ

  @SYMTestCaseDesc The functions tests clean up after forced memory fail.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : The functions tests clean up after forced memory fail.\n

  The present number of component controls is obtained  using CountComponentControls.\n

  The next memory allocation is caused to fail using macro "__UHEAP_FAILNEXT".\n

  A new component is added using AddComponentByIdLC API.\n

  The number of component controls should remain the same after memory allocation failure also .\n

  @SYMTestExpectedResults : Boolean, True if Clean up is successful after memory allocation failure.\n

  @SYMTestType : CIT 

*/	

TBool CCtlContainer::TestCleanupL()

	{

	TBool seemsOK = EFalse ;

	// Initial count of controls

	TInt count = CountComponentControls() ;	

	// Create a new control to add to the array

	CCtlContainee* child = NULL ;	

	child = new (ELeave) CCtlContainee ;

 	// Set memory allocation to fail 

	__UHEAP_MARK ;

	__UHEAP_SETFAIL((RHeap::EDeterministic),1);

 	// Expect addition of the control to the array to fail

	TRAPD(err, 

		{

		Components().AppendLC( child );

		CleanupStack::Pop(child);

		} );

   	// Re-align the heap

	__UHEAP_RESET ;

	__UHEAP_MARKEND ;

	// The no of controls should be the same as at the start 

	// as appending should have failed with KErrNoMemory

	seemsOK = ( (count == CountComponentControls()) && 

								(err == KErrNoMemory)) ;

	return seemsOK ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestGetControlL

  @SYMPREQ

  @SYMTestCaseDesc Tests the ability to obtain handle to the component control using Component Id.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Third component control is added using AddComponentByIdLC API with KChildThreeID as component ID.\n

  Later the ID is passed to ComponentById API which returns the pointer to the component control.\n

  The name of the control obtained  is verified against the one set.\n

  @SYMTestExpectedResults : Boolean, True if names match.\n

  @SYMTestType : CIT

*/

TBool CCtlContainer::TestGetControlL()

	{

	_LIT( KNameDes, "childx") ;

	// construct a control, add it.  Get one back.  is it the same one?

	CCtlContainee* child = NULL ;

	child = new (ELeave) CCtlContainee ;

	Components().AppendLC( child, KChildThreeID ) ;

	child->ConstructL( KNameDes ) ;

	CleanupStack::Pop( child ) ;

	CCoeControl* anotherChild = NULL ;

 	anotherChild = Components().ControlById<CCtlContainee>(KChildThreeID);

	TInt match = 1 ;

	if ( anotherChild )

		{

		match = KNameDes().Compare( static_cast<CCtlContainee*>(anotherChild)->WhoAmI() ) ;

		}

	return ( match == 0 ) ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestGetControlConstL

  @SYMPREQ

  @SYMTestCaseDesc Gets a constant handle to the component control.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Gets a constant handle to the component control.\n

  Handle to component with Id KChildThreeID is obtained using ComponentById API.\n

  The name of the control obtained  is verified against the KNameDes descriptor.\n

  @SYMTestExpectedResults : Boolean, True if names match.\n

  @SYMTestType : CIT

*/	

TBool CCtlContainer::TestGetControlConstL()  const

	{ // dependant on TestGetControlL()

	_LIT( KNameDes, "childx") ;

 	const  CCtlContainee* anotherChild = NULL ;

 	anotherChild = Components().ControlById<CCtlContainee>(KChildThreeID);

	TInt match = 1 ;

	if ( anotherChild )

		{

		match = KNameDes().Compare((anotherChild)->WhoAmI() ) ;	

		}

	return ( match == 0 ) ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestGetUnknownControlConstL

  @SYMPREQ

  @SYMTestCaseDesc Gets a constant handle to the non existant component control .\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Component control with ID KChildTwoID does not exist.\n

  Handle to component with Id KChildTwoID is obtained using ComponentById API.\n

  @SYMTestExpectedResults : Boolean, True if obtained component control pointer is NULL.\n

  @SYMTestType : CIT

*/	

TBool CCtlContainer::TestGetUnknownControlConstL() const 

	{ // dependant on TestGetControlL and TestRemoveControl which removes child2

	const CCoeControl* anotherChild = NULL ;

	anotherChild = Components().ControlById<CCoeControl>( KChildTwoID ) ; 

	return ( anotherChild == NULL ) ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestAddDuplicateControlL

  @SYMPREQ

  @SYMTestCaseDesc Tests adding a component control using an already used Id.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Tests adding a component control using an already used Id.\n

  A component is created and added with Id 'KChildThreeID' which is already used.\n

  @SYMTestExpectedResults : Boolean, True if addition of duplicate control fails.\n

  @SYMTestType : CIT

*/	

TBool CCtlContainer::TestAddDuplicateControlL() 

	{

	_LIT( KNameDes, "childx") ;

	// construct a control, add it using an already used ID.  Dependant on TestGetControlL()

	CCtlContainee* child = NULL ;

	child = new (ELeave) CCtlContainee ;

	TInt err ;

	__UHEAP_MARK ;

	TRAP( err, Components().AppendLC( child, KChildThreeID ) ) ;

	__UHEAP_MARKEND ;

	if ( err == KErrNone )

		{

		child->ConstructL( KNameDes ) ;

		CleanupStack::Pop( child ) ;

		return EFalse ; // test failed

		}

	else 

		{

		return ETrue ; 

		}

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestRemoveNonExistantById

  @SYMPREQ

  @SYMTestCaseDesc Tests removal of a control using a non existant component ID.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Tests removal of a control using a non existant component ID.\n

  The number  of component controls is obtained uisng CountComponentControls.\n

  The a control with Id '99' which is non existant is removed using API 'RemoveComponentById'.\n

  @SYMTestExpectedResults : Boolean, True if the number of controls remains the same and object pointer returned by 

  RemoveComponentById is NULL.\n

  @SYMTestType : CIT

*/	

TBool CCtlContainer::TestRemoveNonExistantById() 

	{

	TBool seemsOK ;

	TInt count = CountComponentControls() ;

	CCoeControl* runt = NULL ;

	runt = Components().RemoveById( 99 ) ;

	TInt postCount = CountComponentControls() ;

	seemsOK = ( ( runt == NULL ) && ( CountComponentControls() == count ) ) ;

	return seemsOK  ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestRemoveControlL

  @SYMPREQ

  @SYMTestCaseDesc  Tests removal of a control without using a control ID.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions :  Tests removal of a control without using a control ID.\n

  A new component control is created and is added to the container control using API 'AddComponentByIdLC'.\n

  The number of component controls is obtained using 'CountComponentControls' API.\n

  The newly added component control is removed using API 'RemoveComponent' passing the pointer as argument.\n

  @SYMTestExpectedResults : Boolean, True if RemoveComponent returns KErrNone and 

  number of component control is decreased by One.\n

  @SYMTestType : CIT

*/	

TBool CCtlContainer::TestRemoveControlL() // See also TestRemoveControById()

	{

	_LIT( KNameDes, "child4") ;

	// construct a control, add it.  Remove it.  Is it removed?  

	CCtlContainee* child = NULL ;

	child = new (ELeave) CCtlContainee ;

	Components().AppendLC( child, KChildFourID ) ;

	child->ConstructL( KNameDes ) ;

	CleanupStack::Pop( child ) ;

	TInt count = CountComponentControls() ;

	TInt err =  Components().Remove( child ) ; // should return KErrNone

	TInt seemsOK = ( ( err == KErrNone ) && ( CountComponentControls() == (count - 1) )) ;

	delete child ;

	return seemsOK ;

	}

/**

  @SYMTestCaseID UIF-TCone6Step-TestGetUnsetUniqueHandle

  @SYMPREQ

  @SYMTestCaseDesc Tests getting a unique handle to a component control without prior setting.\n

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions : Gets the handle to a component control with ID (KChildOneID).\n

  A unique handle(KUniqueId) is not set to the above control using 'SetUniqueHandle' API prior to calling the get function.\n

  @SYMTestExpectedResults : Boolean, True if the obtained handle is equal to Zero.\n

  @SYMTestType : CIT

*/

TBool CCtlContainer::TestGetUnsetUniqueHandle() 

	{

	// will panic in debug

	TInt  handle = Components().ControlById<CCoeControl>( KChildOneID )->UniqueHandle() ;

	// ignore error

	return ( handle == KErrNotFound ) ;

	}

//! Unique Id used to identify a component control.\n