1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/windowing/windowserver/inc/Graphics/WSGRAPHICDRAWER.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,218 @@
1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Server-side base-classes for graphic drawer plugins
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __WSGRAPHICDRAWER_H__
1.22 +#define __WSGRAPHICDRAWER_H__
1.23 +
1.24 +#include <e32base.h>
1.25 +#include <e32std.h>
1.26 +
1.27 +#include <graphics/wsgraphicdrawerinterface.h>
1.28 +
1.29 +class CFbsBitGc;
1.30 +class TSurfaceId;
1.31 +
1.32 +NONSHARABLE_STRUCT(TGraphicDrawerId)
1.33 +/** Represents a graphic drawer on the window-server side
1.34 +A much-abridged version of TWsGraphicId, with trivial constructor
1.35 +@publishedPartner
1.36 +@released
1.37 +*/ {
1.38 + TInt iId;
1.39 + TBool iIsUid;
1.40 + IMPORT_C TInt Compare(const TGraphicDrawerId& aOther) const;
1.41 + IMPORT_C static TInt Compare(const TGraphicDrawerId& aFirst,const TGraphicDrawerId& aSecond);
1.42 + };
1.43 +
1.44 +/** Wserv event representation to plugin side
1.45 +
1.46 +@publishedPartner
1.47 +@released
1.48 +*/
1.49 +NONSHARABLE_STRUCT(TWservCrEvent)
1.50 + {
1.51 +public:
1.52 + /** Type of wserv events which plugin can listen to. It is a mask that can be combined
1.53 + when subscribing to notification. */
1.54 + enum
1.55 + {
1.56 + EScreenSizeModeChanged = 0x00000001,
1.57 + EWindowVisibilityChanged = 0x00000002,
1.58 + EDsaDrawingBegin = 0x00000004,
1.59 + EDsaDrawingEnd = 0x00000008,
1.60 + EScreenSizeModeAboutToChange= 0x00000010,
1.61 + EScreenUpdated = 0x00000020,
1.62 + EScreenDrawing = 0x00000040,
1.63 + EWindowGroupChanged = 0x00000080,
1.64 + EScreenOrientationChanged = 0x00000100,
1.65 + EDeviceOrientationChanged = 0x00000200,
1.66 + EWindowClosing = 0x00000400,
1.67 + ESurfaceUnreferenced = 0x00000800,
1.68 + };
1.69 +public:
1.70 + IMPORT_C TWservCrEvent(TUint32 aType);
1.71 + IMPORT_C TWservCrEvent(TUint32 aType, TUint32 aInfo);
1.72 + IMPORT_C TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData);
1.73 + IMPORT_C TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData, MWsWindow* aWindow);
1.74 +
1.75 + /** Returns wserv event type */
1.76 + IMPORT_C TUint32 Type() const;
1.77 + /** Returns current wserv screen size mode as the result of event EScreenSizeModeChanged.
1.78 + Screen mode is 0,1,2,...
1.79 + */
1.80 + IMPORT_C TInt SizeMode() const;
1.81 + /** Returns visibile region as the result of event EWindowVisibilityChanged, this region represents
1.82 + full or some part of window which is changing visibility. NULL if window is becoming not visible
1.83 + completely.
1.84 + */
1.85 + IMPORT_C const RRegion* VisibleRegion() const;
1.86 + /** Returns screen number where a DSA, screen updated or window group changed event occurs
1.87 + */
1.88 + IMPORT_C TInt ScreenNumber() const;
1.89 + /** Returns the drawing region which is referred to by an EScreenDrawing
1.90 + */
1.91 + IMPORT_C const TRegion* DrawingRegion() const;
1.92 + /** Returns the new window group identifier where a window group changed event occurs
1.93 + */
1.94 + IMPORT_C TInt WindowGroupIdentifier() const;
1.95 + /** Returns the new window server display oriention
1.96 + */
1.97 + IMPORT_C CFbsBitGc::TGraphicsOrientation Orientation() const;
1.98 + /** Returns whether or not a window was already visible before a visibility event occurred
1.99 + */
1.100 + IMPORT_C TBool WasVisible() const;
1.101 + /** Returns the window this event is for. This may be null.
1.102 + @prototype
1.103 + */
1.104 + IMPORT_C MWsWindow* Window() const;
1.105 + /** Returns the released surface ID
1.106 + */
1.107 + IMPORT_C const TSurfaceId* SurfaceId() const;
1.108 +
1.109 +private:
1.110 + TWservCrEvent() {}
1.111 +
1.112 +private:
1.113 + TUint32 iType;
1.114 + TUint32 iInfo;
1.115 + TAny* iData;
1.116 + MWsWindow* iWindow;
1.117 + TInt iReserved[7];
1.118 + };
1.119 +
1.120 +/** Event notification callback. Need to be implemented to allow CWsGraphicDrawer to listen to
1.121 +wserv events.
1.122 +
1.123 +@publishedPartner
1.124 +@released
1.125 +*/
1.126 +class MWsEventHandler
1.127 + {
1.128 +public:
1.129 + /** Plugin event handler, will be called once for each event.
1.130 + */
1.131 + virtual void DoHandleEvent(const TWservCrEvent& aEvent) = 0;
1.132 + };
1.133 +
1.134 +/**
1.135 +Implementing this interface will give a callback notification wheater a
1.136 +graphic message which was sent has either failed or succeded.
1.137 +@publishedPartner
1.138 +@prototype
1.139 +*/
1.140 +class MWsGraphicMessageCallback : public MWsObjectProvider
1.141 + {
1.142 +public:
1.143 + DECLARE_WS_TYPE_ID(KWsGraphicMessageCallbackInterfaceId)
1.144 +
1.145 +public:
1.146 + /**
1.147 + Called with unique ID of the message, aError will be set to KErrNone if message delivery is
1.148 + successful, otherwise one of the system-wide error code.
1.149 + */
1.150 + virtual void HandleMessageDelivery(TInt aMessageId, TInt aError) = 0;
1.151 + };
1.152 +
1.153 +/**
1.154 +Implementing this interface will give you the possibility to send synchron messages with a returnvalue to the client.
1.155 +@publishedPartner
1.156 +@prototype
1.157 +*/
1.158 +class MWsGraphicHandleSynchronMessage: public MWsObjectProvider
1.159 + {
1.160 +public:
1.161 + DECLARE_WS_TYPE_ID(KWsGraphicHandleSynchronMessageId)
1.162 +
1.163 +public:
1.164 + /**
1.165 + Synchron handlemessage method.
1.166 + */
1.167 + virtual TInt HandleSynchronMessage(const TDesC8& aData) = 0;
1.168 + };
1.169 +
1.170 +
1.171 +class CWsGraphicDrawer: public CBase, public MWsObjectProvider
1.172 +/** A window-server-side peer to a CWsGraphic
1.173 +@publishedPartner
1.174 +@released
1.175 +*/ {
1.176 +public:
1.177 + /** This function should be overriden by all derived classes. The first call the implementation of this function
1.178 + should make is to BaseConstructL().
1.179 + @param aEnv the environment this drawer exists in
1.180 + @param aId the ID of this drawer
1.181 + @param aOwner the client session that owns this drawer
1.182 + @param aData arbitrary data for constructing this instance, sent from the client.
1.183 + */
1.184 + virtual void ConstructL(MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,MWsClient& aOwner,const TDesC8& aData) = 0;
1.185 + IMPORT_C ~CWsGraphicDrawer();
1.186 + IMPORT_C const TGraphicDrawerId& Id() const;
1.187 + IMPORT_C const MWsClient& Owner() const;
1.188 + IMPORT_C TBool IsSharedWith(TSecureId aClientId) const;
1.189 + IMPORT_C TInt ShareGlobally();
1.190 + IMPORT_C TInt UnShareGlobally();
1.191 + IMPORT_C TInt Share(TSecureId aClientId);
1.192 + IMPORT_C TInt UnShare(TSecureId aClientId);
1.193 + IMPORT_C void Draw(MWsGc& aGc,const TRect& aRect,const TDesC8& aData) const;
1.194 + IMPORT_C TBool Contains(const TArray<TGraphicDrawerId>& aIds) const;
1.195 + virtual void HandleMessage(const TDesC8& aData) = 0;
1.196 + IMPORT_C void HandleEvent(const TWservCrEvent& aEvent);
1.197 + IMPORT_C void SetEventHandler(MWsEventHandler* aHandler);
1.198 + IMPORT_C TBool HasEventHandler() const;
1.199 +protected:
1.200 + IMPORT_C CWsGraphicDrawer();
1.201 + IMPORT_C void BaseConstructL(MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,MWsClient& aOwner);
1.202 + IMPORT_C MWsGraphicDrawerEnvironment& Env();
1.203 + IMPORT_C const MWsGraphicDrawerEnvironment& Env() const;
1.204 + IMPORT_C TInt SendMessage(const TDesC8& aData);
1.205 + IMPORT_C TInt SendMessage(CWsMessageData& aData);
1.206 + IMPORT_C void Invalidate();
1.207 +private:
1.208 + IMPORT_C virtual TBool HasAsChild(const TArray<TGraphicDrawerId>& aIds) const;
1.209 + virtual void DoDraw(MWsGc& aGc,const TRect& aRect,const TDesC8& aData) const = 0;
1.210 +private:
1.211 + class CPimpl;
1.212 + friend class CPimpl;
1.213 + CPimpl* iPimpl;
1.214 + TInt iWsGraphicDrawerSpare[3];
1.215 +private:
1.216 + friend class WsGraphicDrawer;
1.217 + TUid iDtor_ID_Key;
1.218 + };
1.219 +
1.220 +
1.221 +#endif //#ifndef __WSGRAPHICDRAWER_H__