|
sl@0
|
1 |
// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// Definition of base class for all objects
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
#ifndef __OBJECT_H__
|
|
sl@0
|
19 |
#define __OBJECT_H__
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
#include <e32std.h>
|
|
sl@0
|
22 |
#include <e32base.h>
|
|
sl@0
|
23 |
#include "w32cmd.h"
|
|
sl@0
|
24 |
#include "screen.h"
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
class CWsClient;
|
|
sl@0
|
27 |
class CWsRootWindow;
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
/**
|
|
sl@0
|
30 |
CWsObject is the base class for the server-side objects that are visible to the client.
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
The client refers to these objects via a handle that is passed to it by the server.
|
|
sl@0
|
33 |
The association between handles and CWsObject instances is stored by the TWsObject class.
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
Derived classes must implement the CommandL() function so that it handles the requests
|
|
sl@0
|
36 |
the client sent.
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
Each client session has a list of all its CWsObject instances. When creating an instance of
|
|
sl@0
|
39 |
a class derived from CWsObject the NewObjL() function must be called to add the new
|
|
sl@0
|
40 |
object to the list. The CWsObject destructor takes care of removing the object from the list.
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
@see TWsObject
|
|
sl@0
|
43 |
@see CWsClient
|
|
sl@0
|
44 |
@internalComponent
|
|
sl@0
|
45 |
@released
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
class CWsObject : public CBase
|
|
sl@0
|
48 |
{
|
|
sl@0
|
49 |
public:
|
|
sl@0
|
50 |
CWsObject(CWsClient* aOwner,WH_HANDLES aType);
|
|
sl@0
|
51 |
~CWsObject();
|
|
sl@0
|
52 |
virtual void CommandL(TInt aOpcode, const TAny *aCmdData)=0;
|
|
sl@0
|
53 |
virtual void CloseObject();
|
|
sl@0
|
54 |
TInt LogHandle() const;
|
|
sl@0
|
55 |
void NewObjL();
|
|
sl@0
|
56 |
void RemoveFromIndex();
|
|
sl@0
|
57 |
inline WH_HANDLES Type() const;
|
|
sl@0
|
58 |
inline CWsClient *WsOwner() const;
|
|
sl@0
|
59 |
inline void SetWsOwner(CWsClient *aOwner);
|
|
sl@0
|
60 |
void OwnerPanic(TClientPanic aPanic) const;
|
|
sl@0
|
61 |
protected:
|
|
sl@0
|
62 |
void SetReply(TInt aReply);
|
|
sl@0
|
63 |
|
|
sl@0
|
64 |
private:
|
|
sl@0
|
65 |
WH_HANDLES iType;
|
|
sl@0
|
66 |
protected:
|
|
sl@0
|
67 |
/** Each client has a list of all its CWsObject instances. The CWsObject
|
|
sl@0
|
68 |
has a pointer to its owner so that it can update the list when it is created and
|
|
sl@0
|
69 |
when it is destroyed. */
|
|
sl@0
|
70 |
CWsClient *iWsOwner;
|
|
sl@0
|
71 |
};
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
class CWsScreenObject : public CWsObject
|
|
sl@0
|
74 |
{
|
|
sl@0
|
75 |
public:
|
|
sl@0
|
76 |
inline CWsScreenObject(CWsClient *aOwner,WH_HANDLES aType,CScreen* aScreen);
|
|
sl@0
|
77 |
inline CScreen* Screen() const;
|
|
sl@0
|
78 |
inline CWsRootWindow* RootWindow() const;
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
protected:
|
|
sl@0
|
81 |
CScreen* iScreen;
|
|
sl@0
|
82 |
};
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
//
|
|
sl@0
|
86 |
// inlines //
|
|
sl@0
|
87 |
//
|
|
sl@0
|
88 |
|
|
sl@0
|
89 |
//
|
|
sl@0
|
90 |
// CWsObject
|
|
sl@0
|
91 |
//
|
|
sl@0
|
92 |
inline CWsClient *CWsObject::WsOwner() const
|
|
sl@0
|
93 |
{return(iWsOwner);}
|
|
sl@0
|
94 |
inline void CWsObject::SetWsOwner(CWsClient *aOwner)
|
|
sl@0
|
95 |
{iWsOwner=aOwner;}
|
|
sl@0
|
96 |
inline WH_HANDLES CWsObject::Type() const
|
|
sl@0
|
97 |
{return(iType);}
|
|
sl@0
|
98 |
//
|
|
sl@0
|
99 |
// CWsScreenObject
|
|
sl@0
|
100 |
//
|
|
sl@0
|
101 |
inline CWsScreenObject::CWsScreenObject(CWsClient *aOwner,WH_HANDLES aType,CScreen* aScreen) : CWsObject(aOwner,aType), iScreen(aScreen)
|
|
sl@0
|
102 |
{}
|
|
sl@0
|
103 |
inline CScreen* CWsScreenObject::Screen() const
|
|
sl@0
|
104 |
{return iScreen;}
|
|
sl@0
|
105 |
inline CWsRootWindow* CWsScreenObject::RootWindow() const
|
|
sl@0
|
106 |
{return iScreen->RootWindow();}
|
|
sl@0
|
107 |
#endif
|