sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // Server-side base-classes for graphic drawer plugins sl@0: // sl@0: // sl@0: sl@0: #ifndef __WSGRAPHICDRAWER_H__ sl@0: #define __WSGRAPHICDRAWER_H__ sl@0: sl@0: #include sl@0: #include sl@0: sl@0: #include sl@0: sl@0: class CFbsBitGc; sl@0: class TSurfaceId; sl@0: sl@0: NONSHARABLE_STRUCT(TGraphicDrawerId) sl@0: /** Represents a graphic drawer on the window-server side sl@0: A much-abridged version of TWsGraphicId, with trivial constructor sl@0: @publishedPartner sl@0: @released sl@0: */ { sl@0: TInt iId; sl@0: TBool iIsUid; sl@0: IMPORT_C TInt Compare(const TGraphicDrawerId& aOther) const; sl@0: IMPORT_C static TInt Compare(const TGraphicDrawerId& aFirst,const TGraphicDrawerId& aSecond); sl@0: }; sl@0: sl@0: /** Wserv event representation to plugin side sl@0: sl@0: @publishedPartner sl@0: @released sl@0: */ sl@0: NONSHARABLE_STRUCT(TWservCrEvent) sl@0: { sl@0: public: sl@0: /** Type of wserv events which plugin can listen to. It is a mask that can be combined sl@0: when subscribing to notification. */ sl@0: enum sl@0: { sl@0: EScreenSizeModeChanged = 0x00000001, sl@0: EWindowVisibilityChanged = 0x00000002, sl@0: EDsaDrawingBegin = 0x00000004, sl@0: EDsaDrawingEnd = 0x00000008, sl@0: EScreenSizeModeAboutToChange= 0x00000010, sl@0: EScreenUpdated = 0x00000020, sl@0: EScreenDrawing = 0x00000040, sl@0: EWindowGroupChanged = 0x00000080, sl@0: EScreenOrientationChanged = 0x00000100, sl@0: EDeviceOrientationChanged = 0x00000200, sl@0: EWindowClosing = 0x00000400, sl@0: ESurfaceUnreferenced = 0x00000800, sl@0: }; sl@0: public: sl@0: IMPORT_C TWservCrEvent(TUint32 aType); sl@0: IMPORT_C TWservCrEvent(TUint32 aType, TUint32 aInfo); sl@0: IMPORT_C TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData); sl@0: IMPORT_C TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData, MWsWindow* aWindow); sl@0: sl@0: /** Returns wserv event type */ sl@0: IMPORT_C TUint32 Type() const; sl@0: /** Returns current wserv screen size mode as the result of event EScreenSizeModeChanged. sl@0: Screen mode is 0,1,2,... sl@0: */ sl@0: IMPORT_C TInt SizeMode() const; sl@0: /** Returns visibile region as the result of event EWindowVisibilityChanged, this region represents sl@0: full or some part of window which is changing visibility. NULL if window is becoming not visible sl@0: completely. sl@0: */ sl@0: IMPORT_C const RRegion* VisibleRegion() const; sl@0: /** Returns screen number where a DSA, screen updated or window group changed event occurs sl@0: */ sl@0: IMPORT_C TInt ScreenNumber() const; sl@0: /** Returns the drawing region which is referred to by an EScreenDrawing sl@0: */ sl@0: IMPORT_C const TRegion* DrawingRegion() const; sl@0: /** Returns the new window group identifier where a window group changed event occurs sl@0: */ sl@0: IMPORT_C TInt WindowGroupIdentifier() const; sl@0: /** Returns the new window server display oriention sl@0: */ sl@0: IMPORT_C CFbsBitGc::TGraphicsOrientation Orientation() const; sl@0: /** Returns whether or not a window was already visible before a visibility event occurred sl@0: */ sl@0: IMPORT_C TBool WasVisible() const; sl@0: /** Returns the window this event is for. This may be null. sl@0: @prototype sl@0: */ sl@0: IMPORT_C MWsWindow* Window() const; sl@0: /** Returns the released surface ID sl@0: */ sl@0: IMPORT_C const TSurfaceId* SurfaceId() const; sl@0: sl@0: private: sl@0: TWservCrEvent() {} sl@0: sl@0: private: sl@0: TUint32 iType; sl@0: TUint32 iInfo; sl@0: TAny* iData; sl@0: MWsWindow* iWindow; sl@0: TInt iReserved[7]; sl@0: }; sl@0: sl@0: /** Event notification callback. Need to be implemented to allow CWsGraphicDrawer to listen to sl@0: wserv events. sl@0: sl@0: @publishedPartner sl@0: @released sl@0: */ sl@0: class MWsEventHandler sl@0: { sl@0: public: sl@0: /** Plugin event handler, will be called once for each event. sl@0: */ sl@0: virtual void DoHandleEvent(const TWservCrEvent& aEvent) = 0; sl@0: }; sl@0: sl@0: /** sl@0: Implementing this interface will give a callback notification wheater a sl@0: graphic message which was sent has either failed or succeded. sl@0: @publishedPartner sl@0: @prototype sl@0: */ sl@0: class MWsGraphicMessageCallback : public MWsObjectProvider sl@0: { sl@0: public: sl@0: DECLARE_WS_TYPE_ID(KWsGraphicMessageCallbackInterfaceId) sl@0: sl@0: public: sl@0: /** sl@0: Called with unique ID of the message, aError will be set to KErrNone if message delivery is sl@0: successful, otherwise one of the system-wide error code. sl@0: */ sl@0: virtual void HandleMessageDelivery(TInt aMessageId, TInt aError) = 0; sl@0: }; sl@0: sl@0: /** sl@0: Implementing this interface will give you the possibility to send synchron messages with a returnvalue to the client. sl@0: @publishedPartner sl@0: @prototype sl@0: */ sl@0: class MWsGraphicHandleSynchronMessage: public MWsObjectProvider sl@0: { sl@0: public: sl@0: DECLARE_WS_TYPE_ID(KWsGraphicHandleSynchronMessageId) sl@0: sl@0: public: sl@0: /** sl@0: Synchron handlemessage method. sl@0: */ sl@0: virtual TInt HandleSynchronMessage(const TDesC8& aData) = 0; sl@0: }; sl@0: sl@0: sl@0: class CWsGraphicDrawer: public CBase, public MWsObjectProvider sl@0: /** A window-server-side peer to a CWsGraphic sl@0: @publishedPartner sl@0: @released sl@0: */ { sl@0: public: sl@0: /** This function should be overriden by all derived classes. The first call the implementation of this function sl@0: should make is to BaseConstructL(). sl@0: @param aEnv the environment this drawer exists in sl@0: @param aId the ID of this drawer sl@0: @param aOwner the client session that owns this drawer sl@0: @param aData arbitrary data for constructing this instance, sent from the client. sl@0: */ sl@0: virtual void ConstructL(MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,MWsClient& aOwner,const TDesC8& aData) = 0; sl@0: IMPORT_C ~CWsGraphicDrawer(); sl@0: IMPORT_C const TGraphicDrawerId& Id() const; sl@0: IMPORT_C const MWsClient& Owner() const; sl@0: IMPORT_C TBool IsSharedWith(TSecureId aClientId) const; sl@0: IMPORT_C TInt ShareGlobally(); sl@0: IMPORT_C TInt UnShareGlobally(); sl@0: IMPORT_C TInt Share(TSecureId aClientId); sl@0: IMPORT_C TInt UnShare(TSecureId aClientId); sl@0: IMPORT_C void Draw(MWsGc& aGc,const TRect& aRect,const TDesC8& aData) const; sl@0: IMPORT_C TBool Contains(const TArray& aIds) const; sl@0: virtual void HandleMessage(const TDesC8& aData) = 0; sl@0: IMPORT_C void HandleEvent(const TWservCrEvent& aEvent); sl@0: IMPORT_C void SetEventHandler(MWsEventHandler* aHandler); sl@0: IMPORT_C TBool HasEventHandler() const; sl@0: protected: sl@0: IMPORT_C CWsGraphicDrawer(); sl@0: IMPORT_C void BaseConstructL(MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,MWsClient& aOwner); sl@0: IMPORT_C MWsGraphicDrawerEnvironment& Env(); sl@0: IMPORT_C const MWsGraphicDrawerEnvironment& Env() const; sl@0: IMPORT_C TInt SendMessage(const TDesC8& aData); sl@0: IMPORT_C TInt SendMessage(CWsMessageData& aData); sl@0: IMPORT_C void Invalidate(); sl@0: private: sl@0: IMPORT_C virtual TBool HasAsChild(const TArray& aIds) const; sl@0: virtual void DoDraw(MWsGc& aGc,const TRect& aRect,const TDesC8& aData) const = 0; sl@0: private: sl@0: class CPimpl; sl@0: friend class CPimpl; sl@0: CPimpl* iPimpl; sl@0: TInt iWsGraphicDrawerSpare[3]; sl@0: private: sl@0: friend class WsGraphicDrawer; sl@0: TUid iDtor_ID_Key; sl@0: }; sl@0: sl@0: sl@0: #endif //#ifndef __WSGRAPHICDRAWER_H__