uifw/AvKon/src/akndiscreetpopup.cpp
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 19 Feb 2010 23:04:46 +0200
branchRCL_3
changeset 4 8ca85d2f0db7
parent 0 2f259fa3e83a
child 55 aecbbf00d063
permissions -rw-r--r--
Revision: 201003 Kit: 201007

/*
* Copyright (c) 2009 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:  Discreet popup
*
*/

#include <akndiscreetpopup.h>
#include <AknPanic.h>
#include <AknTasHook.h>
#include <eiksrvs.h>

#include "akndiscreetpopupcontrol.h"
#include "akndiscreetpopupserverhandler.h"
#include "akntrace.h"

const TUid KDiscreetPopupSingleton = { 537001156 };
const TInt KInitialPopupId( 1 );

// ======== MEMBER FUNCTIONS ========

// ---------------------------------------------------------------------------
// CAknDiscreetPopup::~CAknDiscreetPopup
// ---------------------------------------------------------------------------
//
CAknDiscreetPopup::~CAknDiscreetPopup()
    {
    _AKNTRACE_FUNC_ENTER;
    if ( iUseCoeEnv )
        {
        AKNTASHOOK_REMOVE();
        }
    CAknDiscreetPopupControl* popup( NULL );
    for ( TInt j = 0; j < iLocalPopups.Count(); j++ )
        {
        popup = iLocalPopups[ j ];
        delete popup;
        popup = NULL;
        }
    iLocalPopups.Close();
    delete iServerHandler;
    _AKNTRACE_FUNC_EXIT;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::ShowLocalPopupL
// ---------------------------------------------------------------------------
//
EXPORT_C TInt CAknDiscreetPopup::ShowLocalPopupL( 
    const TDesC& aTitle,
    const TDesC& aText,
    CGulIcon* aIcon,
    const TAknsItemID& aSkinId,
    const TDesC& aBitmapFile,
    const TInt aBitmapId,
    const TInt aMaskId,
    const TInt aFlags,
    const TInt aCommand,
    MEikCommandObserver* aCommandObserver )
    {
    _AKNTRACE( "CAknDiscreetPopup::ShowLocalPopupL, Created by given parameters" );
    __ASSERT_ALWAYS( CCoeEnv::Static(), Panic( EAknPanicNotSupported ) );
    TInt popupId = 0;
    CAknDiscreetPopup* instance = InstanceL();
    if( instance )
        {
        popupId = instance->DoShowLocalL( aTitle, 
                                          aText, 
                                          aIcon,
                                          aSkinId,
                                          aBitmapFile,
                                          aBitmapId,
                                          aMaskId,
                                          aFlags, 
                                          aCommand, 
                                          aCommandObserver );
        }
    return popupId;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::ShowLocalPopupL
// ---------------------------------------------------------------------------
//
EXPORT_C TInt CAknDiscreetPopup::ShowLocalPopupL(
    const TInt aResourceId, 
    const TInt aCommand,
    MEikCommandObserver* aCommandObserver )
    {
    _AKNTRACE( "CAknDiscreetPopup::ShowLocalPopupL, Created by given resource" );
    __ASSERT_ALWAYS( CCoeEnv::Static(), Panic( EAknPanicNotSupported ) );
    TInt popupId = 0;
    CAknDiscreetPopup* instance = InstanceL();
    if( instance )
        {
        popupId = instance->DoShowLocalL( aResourceId, KNullDesC, aCommand, aCommandObserver );
        }
    return popupId;    
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::ShowGlobalPopupL
// ---------------------------------------------------------------------------
//
EXPORT_C TInt CAknDiscreetPopup::ShowGlobalPopupL(
    const TDesC& aTitle,
    const TDesC& aText,
    const TAknsItemID& aSkinId,
    const TDesC& aBitmapFile,
    const TInt aBitmapId,
    const TInt aMaskId,
    const TInt aFlags,
    const TInt aCommandId,
    MEikCommandObserver* aCommandObserver,
    const TUid& aAppUid,
    const TUid& aViewUid )
    {
    _AKNTRACE( "CAknDiscreetPopup::ShowGlobalPopupL, Created by given parameters" );
    TInt popupId = 0;
    CAknDiscreetPopup* instance = InstanceL();
    if ( instance )
        {
        popupId = instance->DoShowGlobalL(aTitle, aText, aSkinId, aBitmapFile, 
            aBitmapId, aMaskId, aFlags, aCommandId, aCommandObserver, aAppUid,
            aViewUid);
        }
    return popupId;    
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::ShowGlobalPopupL
// ---------------------------------------------------------------------------
//
EXPORT_C TInt CAknDiscreetPopup::ShowGlobalPopupL( 
    const TInt aResourceId,
    const TDesC& aResourceFile,
    const TInt aCommandId,
    MEikCommandObserver* aCommandObserver,
    const TUid& aAppUid,
    const TUid& aViewUid )
    {
    _AKNTRACE( "CAknDiscreetPopup::ShowGlobalPopupL, Created by given resource" );
    TInt popupId = 0;
    CAknDiscreetPopup* instance = InstanceL();
    if( instance )
        {
        popupId = instance->DoShowGlobalL( aResourceId,
                                           aResourceFile,
                                           aCommandId,
                                           aCommandObserver,
                                           aAppUid,
                                           aViewUid );
        }
    return popupId;    
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::InitL
// ---------------------------------------------------------------------------
//
EXPORT_C void CAknDiscreetPopup::InitL()
    {
    _AKNTRACE_FUNC_ENTER;
    __ASSERT_ALWAYS( !CCoeEnv::Static(), Panic( EAknPanicNotSupported ) );

    // Create popup instance and store it to TLS
    if ( !Dll::Tls() )
        {
        CAknDiscreetPopup* instance = new ( ELeave ) CAknDiscreetPopup;
        CleanupStack::PushL( instance );
        instance->ConstructL();
        User::LeaveIfError( Dll::SetTls( instance ) );
        CleanupStack::Pop( instance );
        }
    _AKNTRACE_FUNC_EXIT;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::Release
// ---------------------------------------------------------------------------
//
EXPORT_C void CAknDiscreetPopup::Release()
    {
    _AKNTRACE_FUNC_ENTER;
    __ASSERT_ALWAYS( !CCoeEnv::Static(), Panic( EAknPanicNotSupported ) );

    // Delete popup instance from TLS
    CAknDiscreetPopup* instance =
        static_cast<CAknDiscreetPopup*>( Dll::Tls() );
    if ( instance )
        {
        delete instance;
        instance = NULL;
        Dll::SetTls( NULL );
        }
    _AKNTRACE_FUNC_EXIT;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::CAknDiscreetPopup
// ---------------------------------------------------------------------------
//
CAknDiscreetPopup::CAknDiscreetPopup()
    {
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::CAknDiscreetPopup
// ---------------------------------------------------------------------------
//
CAknDiscreetPopup::CAknDiscreetPopup( TBool aUseCoeEnv )
    : CCoeStatic( KDiscreetPopupSingleton, CCoeStatic::EThread ),
    iUseCoeEnv( aUseCoeEnv )
    {
    AKNTASHOOK_ADD( this, "CAknDiscreetPopup" );
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::ConstructL
// ---------------------------------------------------------------------------
//
void CAknDiscreetPopup::ConstructL()
    {
    iServerHandler = CAknDiscreetPopupServerHandler::NewL();
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::InstanceL
// ---------------------------------------------------------------------------
//
CAknDiscreetPopup* CAknDiscreetPopup::InstanceL()
    {
    CAknDiscreetPopup* instance( NULL );
    if ( CCoeEnv::Static() )
        {
        instance = static_cast< CAknDiscreetPopup* >
            ( CCoeEnv::Static( KDiscreetPopupSingleton ) );
        if ( !instance )
            {
            instance = new ( ELeave ) CAknDiscreetPopup( ETrue );
            CleanupStack::PushL( instance );
            instance->ConstructL();
            CleanupStack::Pop( instance );
            }
        }
    else
        {
        instance = static_cast<CAknDiscreetPopup*>( Dll::Tls() );
        }
    return instance;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::DoShowLocalL
// ---------------------------------------------------------------------------
//
TInt CAknDiscreetPopup::DoShowLocalL(
        const TDesC& aTitle, 
        const TDesC& aText, 
        CGulIcon* aIcon, 
        const TAknsItemID& aSkinId,
        const TDesC& aBitmapFile,
        const TInt& aBitmapId,
        const TInt& aMaskId,
        const TInt& aFlags, 
        const TInt& aCommand, 
        MEikCommandObserver* aCommandObserver )
    {
    TInt popupId( NextPopupId() );
    CAknDiscreetPopupControl* popup = CAknDiscreetPopupControl::NewL(
            EFalse, aTitle, aText, aIcon, aSkinId, aBitmapFile,
            aBitmapId, aMaskId, aFlags, aCommand, popupId, aCommandObserver );
    CleanupStack::PushL( popup );
    ShowPopupL( popup );
    CleanupStack::Pop( popup );
    return popupId;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::DoShowLocalL
// ---------------------------------------------------------------------------
//
TInt CAknDiscreetPopup::DoShowLocalL( 
    const TInt& aResourceId,
    const TDesC& aResourceFile,
    const TInt& aCommand,
    MEikCommandObserver* aCommandObserver )
    {
    TInt popupId( NextPopupId() );
    CAknDiscreetPopupControl* popup = CAknDiscreetPopupControl::NewL(
            EFalse, aResourceId, aResourceFile, 
            aCommand, popupId, aCommandObserver );
    CleanupStack::PushL( popup );
    ShowPopupL( popup );
    CleanupStack::Pop( popup );
    return popupId;
    }

// ---------------------------------------------------------------------------
// CAknDiscreetPopup::DoShowGlobalL
// ---------------------------------------------------------------------------
//
TInt CAknDiscreetPopup::DoShowGlobalL(
        const TDesC& aTitle, 
        const TDesC& aText, 
        const TAknsItemID& aSkinId,
        const TDesC& aBitmapFile,
        const TInt& aBitmapId,
        const TInt& aMaskId,
        const TInt& aFlags,
        const TInt& aCommandId,
        MEikCommandObserver* aCommandObserver,
        const TUid& aAppUid,
        const TUid& aViewUid )
    {
    TInt popupId;
    RThread thread;
    if ( thread.Name() != EIKAPPUI_SERVER_THREAD_NAME && iServerHandler )
        {
        popupId = NextPopupId();
        iServerHandler->LaunchGlobalPopupL(
                aTitle,
                aText,
                aSkinId,
                aBitmapFile,
                aBitmapId,
                aMaskId,
                aFlags,
                aCommandId,
                popupId,
                aCommandObserver,
                aAppUid,
                aViewUid );
        }
    else
    	{
    	CGulIcon* icon = NULL;
    	DoShowLocalL( aTitle, aText, icon, aSkinId, aBitmapFile, 
    			aBitmapId, aMaskId, aFlags, aCommandId, aCommandObserver );
        }
    return popupId;    
    }
    
// ---------------------------------------------------------------------------
// CAknDiscreetPopup::DoShowGlobalL
// ---------------------------------------------------------------------------
//
TInt CAknDiscreetPopup::DoShowGlobalL( 
        const TInt& aResourceId,
        const TDesC& aResourceFile,
        const TInt& aCommandId,
        MEikCommandObserver* aCommandObserver,
        const TUid& aAppUid,
        const TUid& aViewUid )
    {
    TInt popupId;
    RThread thread;
    if ( thread.Name() != EIKAPPUI_SERVER_THREAD_NAME && iServerHandler )
        {
        popupId = NextPopupId();
        iServerHandler->LaunchGlobalPopupL(
                aResourceId,
                aResourceFile,
                aCommandId,
                popupId,
                aCommandObserver,
                aAppUid,
                aViewUid );
        }
    else
    	{
    	DoShowLocalL( aResourceId, aResourceFile, 
    			aCommandId, aCommandObserver );
        }
    return popupId;
    }

// ---------------------------------------------------------------------------
// CAknDiscreetPopup::ShowPopupL
// ---------------------------------------------------------------------------
//
void CAknDiscreetPopup::ShowPopupL( CAknDiscreetPopupControl* aControl )
    {
    _AKNTRACE_FUNC_ENTER;
    if ( !aControl )
        {
        _AKNTRACE( "CAknDiscreetPopup::ShowPopupL, return (aControl is NULL)" );
        return;
        }
        
    // Inform other popups that new popup is launched
    for ( TInt i = 0; i < iLocalPopups.Count(); i++ )
        {
        iLocalPopups[ i ]->HandleDiscreetPopupActionL( 
                CAknDiscreetPopupControl::EAknDiscreetPopupAnotherLaunched );
        }
    // Show popup and add it to popup list
    aControl->SetObserver( this );
    aControl->HandleDiscreetPopupActionL( 
        CAknDiscreetPopupControl::EAknDiscreetPopupShow );
    iLocalPopups.AppendL( aControl );
    _AKNTRACE_FUNC_EXIT;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::DeletePopup
// ---------------------------------------------------------------------------
//
void CAknDiscreetPopup::DeletePopup( CAknDiscreetPopupControl* aControl )
    {
    _AKNTRACE_FUNC_ENTER;
    if ( !aControl )
        {
        _AKNTRACE( "CAknDiscreetPopup::DeletePopup, return (aControl is NULL)" );
        return;
        }

    TInt index = iLocalPopups.Find( aControl );
    iLocalPopups.Remove( index );
    delete aControl;
    aControl = NULL;
    _AKNTRACE_FUNC_EXIT;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::NextPopupId
// ---------------------------------------------------------------------------
//
TInt CAknDiscreetPopup::NextPopupId()
    {
    TInt popupId( KInitialPopupId );
    while ( PopupIdInUse( popupId ) )
        {
        popupId++;
        }
    if ( iServerHandler )
        {
        popupId = iServerHandler->CheckPopupId( popupId );
        }
    return popupId;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::PopupIdInUse
// ---------------------------------------------------------------------------
//
TBool CAknDiscreetPopup::PopupIdInUse( const TInt& aPopupId )
    {
    for ( TInt i = 0; i < iLocalPopups.Count(); i++ )
        {
        if ( iLocalPopups[ i ]->PopupId() == aPopupId )
            {
            return ETrue;
            }
        }
    return EFalse;
    }


// ---------------------------------------------------------------------------
// CAknDiscreetPopup::HandleControlEventL
// ---------------------------------------------------------------------------
//
void CAknDiscreetPopup::HandleControlEventL( 
        CCoeControl* aControl, TCoeEvent aEventType )
    {
    _AKNTRACE( "CAknDiscreetPopup::HandleControlEventL, aEventType : %d", aEventType );
    if ( aEventType == EEventRequestExit || aEventType == EEventRequestCancel )
        {
        DeletePopup( static_cast<CAknDiscreetPopupControl*>( aControl ) );
        }
    }