Pointer cursor. More...
#include <w32std.h>
Public Member Functions | |
| IMPORT_C | RWsPointerCursor () |
| Default C++ constructor. | |
| IMPORT_C | RWsPointerCursor (RWsSession &aWs) |
| Constructs a pointer cursor initialised with a window server session. | |
| IMPORT_C TInt | Construct (TInt aFlags) |
| Completes pointer cursor construction. | |
 Public Member Functions inherited from RWsSpriteBase | |
| IMPORT_C TInt | Activate () |
| Activates the sprite or pointer cursor. | |
| IMPORT_C TInt | AppendMember (const TSpriteMember &aMemberData) |
| Adds a sprite member to a sprite or pointer cursor. | |
| IMPORT_C void | UpdateMember (TInt aIndex) |
| Updates the displayed sprite, taking into account any change to the content of the bitmaps for the specified member. | |
| IMPORT_C TInt | UpdateMember (TInt aIndex, const TSpriteMember &aMemberData) |
| Replaces one of a sprite's members. | |
| IMPORT_C void | Close () |
| Destroys the sprite or pointer cursor in the window server, and frees client-side resources used by the sprite. | |
| Public Member Functions inherited from MWsClientClass | |
| MWsClientClass () | |
| MWsClientClass (RWsBuffer *aBuffer) | |
| TInt | WsHandle () const |
| Gets the server side handle for the object. | |
Additional Inherited Members | |
| Protected Member Functions inherited from RWsSpriteBase | |
| IMPORT_C | RWsSpriteBase () |
| Protected constructor. | |
| IMPORT_C | RWsSpriteBase (RWsSession &aWs) |
| Protected constructor with a window server session. | |
| 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
Pointer cursor.
The pointer cursor is created in a similar way to a sprite. After creating it, one or more sprite members containing the bitmaps to be displayed are added.
After a pointer cursor has been created and activated, it does not become visible until the application calls RWindowTreeNode::SetPointerCursor() or RWindowTreeNode::SetCustomPointerCursor(). The pointer cursor's origin automatically tracks the position of the pointing device, or position of emulated single pointer if there are more pointers in the system (see documentation of RWindowBase::EnableAdvancedPointers() for more details), and the origin forms the pointer cursor's "hot spot", i.e., the point whose co-ordinates are sent to the client if a pointer event occurs. If the pointer cursor's bitmap needs to extend to the left or upwards from the pointer position, its sprite member should be given a negative offset in TSpriteMember::iOffset.
Note:
Pointer cursors are rarely used in pure pen architectures, but they are supported for mouse or tablet use.
- API status
- Published to all clients. Released API.
Constructor & Destructor Documentation
◆ RWsPointerCursor() [1/2]
| IMPORT_C RWsPointerCursor::RWsPointerCursor | ( | ) |
Default C++ constructor.
Use this constructor to allow classes that contain an RWsPointerCursor to be constructed before an RWsSession exists.
Note: do not use this version of the constructor on its own. Before an RWsPointerCursor object can be used, it must be constructed using the RWsPointerCursor(RWsSession) constructor. An example of this might be as follows:
(generated from Symbian Developer Library)
◆ RWsPointerCursor() [2/2]
| IMPORT_C RWsPointerCursor::RWsPointerCursor | ( | RWsSession & | aWs | ) |
Constructs a pointer cursor initialised with a window server session.
Initialisation must be completed using the Construct() function before the sprite can be activated using RWsSpriteBase::Activate().
Once initialisation is complete, the pointer cursor can be passed as an argument to RWsSession::SetSystemPointerCursor() or RWindowTreeNode::SetCustomPointerCursor().
- Parameters
-
aWs The window server session owning the pointer cursor.
(generated from Symbian Developer Library)
Member Function Documentation
◆ Construct()
| IMPORT_C TInt RWsPointerCursor::Construct | ( | TInt | aFlags | ) |
Completes pointer cursor construction.
This function must be called before the pointer cursor is activated.
It always causes a flush of the window server buffer.
- Parameters
-
aFlags ESpriteFlash to flash the sprite on and off or 0 for a non-flashing cursor. Note that pointer cursors always behave as if ESpriteNoChildClip and ESpriteNoShadows are set.
(generated from Symbian Developer Library)
The documentation for this class was generated from the following files:
