Public Member Functions | List of all members
BCursor Class Reference

BCursor describes a view-wide or application-wide cursor. More...

Inherits BArchivable.

Public Member Functions

 BCursor (const void *cursorData)
 Initializes a new cursor object. More...
 
 BCursor (const BCursor &other)
 Initializes a new cursor object from another cursor object. More...
 
 BCursor (BCursorID id)
 Initializes a new cursor object from a predefined cursor id. More...
 
 BCursor (BMessage *data)
 Initializes a new cursor object from a message archive. More...
 
virtual ~BCursor ()
 Destroy the cursor and free its memory. More...
 
virtual status_t Archive (BMessage *archive, bool deep=true) const
 Archive the object into a BMessage. More...
 

Detailed Description

BCursor describes a view-wide or application-wide cursor.

Note
As BeOS only supports 16x16 monochrome cursors, to see a nice shadowed one we will need to extend this.
Since
BeOS R5

Constructor & Destructor Documentation

◆ BCursor() [1/4]

BCursor::BCursor ( const void *  cursorData)

Initializes a new cursor object.

If the cursorData parameter is not NULL then the cursor is initialized with the cursor data.

Parameters
cursorDataThe cursor data.
Since
BeOS R5

◆ BCursor() [2/4]

BCursor::BCursor ( const BCursor other)

Initializes a new cursor object from another cursor object.

Parameters
otherThe cursor object to initialize from.
Since
BeOS R5

◆ BCursor() [3/4]

BCursor::BCursor ( BCursorID  id)

Initializes a new cursor object from a predefined cursor id.

Parameters
idThe predefined id to initialize to.
Since
BeOS R5

◆ BCursor() [4/4]

BCursor::BCursor ( BMessage data)

Initializes a new cursor object from a message archive.

Parameters
dataThe message data to initialize from.
Since
BeOS R5

◆ ~BCursor()

BCursor::~BCursor ( )
virtual

Destroy the cursor and free its memory.

Since
BeOS R5

Member Function Documentation

◆ Archive()

virtual status_t BCursor::Archive ( BMessage into,
bool  deep = true 
) const
virtual

Archive the object into a BMessage.

You should call this method from your derived implementation as it adds the data needed to instantiate your object to the message.

Parameters
intoThe message you store your object in.
deepIf true, all children of this object should be archived as well.
Return values
B_OKThe archive operation was successful.
B_BAD_VALUENULL archive message.
B_ERRORThe archive operation failed.
Since
BeOS R3

Reimplemented from BArchivable.