Client-side interface to the server-side animation DLL. More...
#include <w32std.h>
Public Member Functions | |
| IMPORT_C | RAnimDll () |
| Default constructor. | |
| virtual IMPORT_C | ~RAnimDll () |
| Empty virtual destructor. | |
| IMPORT_C | RAnimDll (RWsSession &aWs) |
| Valid constructor. | |
| IMPORT_C TInt | Load (const TDesC &aFileName) |
| Instructs the server to load an animation DLL. | |
| IMPORT_C void | Destroy () |
| Closes and deletes a previously loaded polymorphic DLL. | |
| virtual IMPORT_C void | Close () |
| Closes an animation DLL. | |
 Public Member Functions inherited from MWsClientClass | |
| MWsClientClass () | |
| MWsClientClass (RWsBuffer *aBuffer) | |
| TInt | WsHandle () const |
| Gets the server side handle for the object. | |
Friends | |
| class | RAnim |
Additional Inherited Members | |
| Protected Member Functions inherited from MWsClientClass | |
| void | Write (const TAny *aData1, TInt aLength1, TInt aLength2, TUint aOpcode) const |
| void | Write (const TAny *aData, TInt aLength, const TAny *aData2, TInt aLength2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const |
| void | Write (const TAny *aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const |
| void | Write (TUint aOpcode) const |
| void | WriteInt (TInt aInt, TUint aOpcode) const |
| void | WriteRect (const TRect &aRect, TUint aOpcode) const |
| void | WritePoint (const TPoint &aPoint, TUint aOpcode) const |
| void | WriteSize (const TSize &aSize, TUint aOpcode) const |
| TInt | WriteReply (TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const |
| TInt | WriteReplyInt (TInt aInt, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const |
| TInt | WriteReply (const TAny *aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const |
| TInt | WriteReply (const TAny *aBuf, TInt aBufLen, const TAny *aBuf2, TInt aBuflen2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const |
| TInt | WriteReplyP (const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const |
| TInt | WriteReplyIntP (TInt aInt, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const |
| TInt | WriteReplyP (const TAny *aBuf, TInt aBufLen, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const |
| TInt | WriteReplyP (const TAny *aBuf, TInt aBufLen, const TAny *aBuf2, TInt aBuflen2, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const |
| TInt | WriteReplyByProvidingRemoteReadAccess (const TAny *aBuf, TInt aBufLen, const TReadDescriptorType &aRemoteReadBuffer, TUint aOpcode) const |
| void | AddToBitmapArray (const TInt aBitmapHandle) const |
| void | AsyncRequest (TRequestStatus &aStatus, TUint aOpcode) const |
| TBool | WindowSizeCacheEnabled () const |
| void | MarkWindowSizeCacheDirty () |
| void | RefreshWindowSizeCache (const TSize &aNewSize) const |
| TInt | CachedWindowSize (TSize &aSize) const |
| void | DestroyWindowSizeCacheEntry () |
| Protected Attributes inherited from MWsClientClass | |
| TInt32 | iWsHandle |
| WARNING: Member variable for internal use ONLY. | |
| RWsBuffer * | iBuffer |
| WARNING: Member variable for internal use ONLY. | |
Detailed Description
Client-side interface to the server-side animation DLL.
This is the client side class matching the server side CAnimDLL class. It provides functions to create, load, close and destroy a server-side CAnimDll object.
- See also
- CreateCAnimDllL()
- CAnimDll
- API status
- Published to all clients. Released API.
Constructor & Destructor Documentation
◆ RAnimDll() [1/2]
| IMPORT_C RAnimDll::RAnimDll | ( | ) |
Default constructor.
RAnimDll is a lightweight class which can be allocated as a non-pointer member. This constructor is provided to allow such a member to be instantiated while its owner is constructed.
Note that an RAnimDll constructed without a reference to a window server session is invalid.
(generated from Symbian Developer Library)
◆ ~RAnimDll()
|
virtual |
Empty virtual destructor.
Destroy() should be used to instead of this function to destroy both this object and the server-side CAnimDll object.
(generated from Symbian Developer Library)
◆ RAnimDll() [2/2]
| IMPORT_C RAnimDll::RAnimDll | ( | RWsSession & | aWs | ) |
Valid constructor.
To be useable, an animation DLL should always be constructed with a reference to a window server session as argument.
- Parameters
-
aWs Window server session to use.
(generated from Symbian Developer Library)
Member Function Documentation
◆ Close()
|
virtual |
Closes an animation DLL.
Use this function to close a polymorphic DLL which was previously loaded on the server. Cleans up and frees all resources belonging to the DLL but does not delete it. Closing is in accordance with the RLibrary mechanism.
Load() and Close() are symmetrical operations. A DLL can be re-loaded after a close has been called on it.
To both close and delete a previously loaded DLL, use Destroy().
(generated from Symbian Developer Library)
◆ Destroy()
| IMPORT_C void RAnimDll::Destroy | ( | ) |
Closes and deletes a previously loaded polymorphic DLL.
This function is equivalent to calling this->Close() followed by delete this, in accordance with the RLibrary mechanism provided for managing polymorphic DLLs.
(generated from Symbian Developer Library)
◆ Load()
| IMPORT_C TInt RAnimDll::Load | ( | const TDesC & | aFileName | ) |
Instructs the server to load an animation DLL.
Use this function to pass the name of a polymorphic DLL, the animation DLL, for loading on the server side. Loading is in accordance with the RLibrary mechanism. The DLL must conform to the interface defined by the window server, otherwise an error will result. For requirements, see the description of CAnimDll.
Load() and Close() are symmetrical operations. A DLL can be re-loaded after a close has been called on it.
This function always causes a flush of the window server buffer.
- Parameters
-
aFileName Filename of the DLL to load.
Panic condition: TW32Panic 17 in debug builds if called on an already constructed object.
(generated from Symbian Developer Library)
Friends And Related Symbol Documentation
◆ RAnim
The documentation for this class was generated from the following files:
