// Copyright (c) 1999-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:
//
#ifndef __VIEWCLI_H__
#define __VIEWCLI_H__
#include <e32base.h>
#include <gdi.h>
#include <vwsdef.h>
//
// Forward declarations.
//
class RVwsSession;
class CVwsSessionEventHandler;
class MVwsAppStarter;
class TVwsViewEvent;
class MVwsSessionWrapperObserver
/**
The MVwsSessionObserver specifies an interface through which server events to be handled by the owner of
a client session are notified
@publishedAll
@deprecated
*/
//@internalTechnology @released
{
public:
/**
* Handles the view event aEvent for a view added through the client session being observed.
* Handles events for all the views added by the client.
*/
virtual void HandleViewEventL(const TVwsViewEvent& aEvent)=0;
};
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
class CVwsSessionWrapper : public CBase
/**
The CVwsSessionWrapper class mediates access to the view server client session which it creates, and wraps in
support for notification of server events. A session observer will be called back with server events if
it maintains an outstanding request for asynchronous event notification.
@publishedPartner
@released
*/
//@internalTechnology @released
{
public:
IMPORT_C static CVwsSessionWrapper* NewL();
IMPORT_C static CVwsSessionWrapper* NewLC();
IMPORT_C static CVwsSessionWrapper* NewL(MVwsSessionWrapperObserver& aObserver);
IMPORT_C static CVwsSessionWrapper* NewLC(MVwsSessionWrapperObserver& aObserver);
IMPORT_C ~CVwsSessionWrapper();
IMPORT_C static TInt StartViewServer(MVwsAppStarter& aAppStarter);
IMPORT_C TInt ShutdownViewServer();
IMPORT_C TInt AddView(const TVwsViewId& aViewId);
IMPORT_C TInt RemoveView(const TVwsViewId& aViewId) const;
IMPORT_C TInt SetSystemDefaultView(const TVwsViewId& aViewId,TInt aMode);
IMPORT_C TInt SetSystemDefaultView(const TVwsViewId& aViewId);
IMPORT_C TInt ActivateView(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage);
IMPORT_C TInt ActivateViewViaViewEvent(const TVwsViewIdAndMessage& aViewIdAndMessage);
IMPORT_C TInt RequestCustomMessage(TDes8& aMessageBufPtr) const;
IMPORT_C void QueueAsyncRequest();
IMPORT_C TInt StartApp(TUid aAppToStart);
IMPORT_C TInt DeactivateActiveView();
IMPORT_C TInt DeactivateActiveViewIfOwnerMatch();
IMPORT_C TInt NotifyNextDeactivation(const TVwsViewId& aViewId);
IMPORT_C TInt NotifyNextDeactivation();
IMPORT_C TInt NotifyNextActivation(const TVwsViewId& aViewId);
IMPORT_C TInt NotifyNextActivation();
IMPORT_C TInt SetDefaultView(const TVwsViewId& aViewId,TInt aMode) const;
IMPORT_C TInt SetDefaultView(const TVwsViewId& aViewId) const;
IMPORT_C TInt GetSystemDefaultView(TVwsViewId& aViewId);
IMPORT_C TInt CreateActivateViewEvent(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage);
IMPORT_C TInt SetClientRequestTimeOut(TTimeIntervalMicroSeconds32 aDuration);
IMPORT_C TInt SetServerEventTimeOut(TTimeIntervalMicroSeconds32 aDuration);
IMPORT_C TInt EnableServerEventTimeOut(TBool aEnable);
IMPORT_C TInt CheckSourceOfViewSwitch(TBool& aResult,const TSecurityPolicy& aSecurityPolicy,const char* aDiagnostic);
IMPORT_C TInt EnableServerBlankScreen(TBool aEnable);
IMPORT_C TInt EnableExternalViewSwitches(TBool aEnable);
IMPORT_C void ActivateView(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage, TRequestStatus& aStatus);
IMPORT_C TInt SetCrossCheckUid(const TUid& aCrossCheckUid);
IMPORT_C TInt SetWindowBackgroundColor(const TRgb& aBgColor);
public:
/**
@internalComponent
@released
*/
IMPORT_C TInt ActivateView(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage, TInt aCustomControl);
/**
@internalComponent
@released
*/
IMPORT_C void ActivateView(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage, TRequestStatus& aStatus, TInt aCustomControl);
/**
@internalComponent
@released
*/IMPORT_C TInt CreateActivateViewEvent(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage, TInt aCustomControl);
/**
@internalComponent
@released
*/
IMPORT_C TInt GetCurrentActiveViewInSystem(TVwsViewId& aActiveViewId);
private:
CVwsSessionWrapper();
CVwsSessionWrapper(MVwsSessionWrapperObserver& aObserver);
void ConstructL();
TInt CheckCreateViewServerSession();
TBool IsSchedulerRunning();
private:
RVwsSession* iVwsSession;
CVwsSessionEventHandler* iViewEventHandler;
MVwsSessionWrapperObserver* iObserver;
};
//
// Panic.
//
/**
@internalComponent
*/
enum TVwsPanic
{
EVwsCreateScheduler=1,
EVwsThreadRename
};
/**
@internalComponent
*/
GLREF_C void Panic(TVwsPanic aPanic);
/**
Server thread start.
@internalComponent
*/
GLDEF_C TInt ViewServerThreadStart(TAny* aPtr);
/**
@internalComponent
*/
struct SVwsCommandLine
{
MVwsAppStarter* iAppStarter;
};
#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
#endif