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 it's memory. More... | |
virtual status_t | Archive (BMessage *archive, bool deep=true) const |
Archive the object into a BMessage. More... | |
BCursor describes a view-wide or application-wide cursor.
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.
cursorData | The cursor data. |
BCursor::BCursor | ( | const BCursor & | other | ) |
Initializes a new cursor object from another cursor object.
other | The cursor object to initialize from. |
BCursor::BCursor | ( | BCursorID | id | ) |
Initializes a new cursor object from a predefined cursor id.
id | The predefined id to initialize to. |
BCursor::BCursor | ( | BMessage * | data | ) |
Initializes a new cursor object from a message archive.
data | The message data to initialize from. |
|
virtual |
Destroy the cursor and free it's memory.
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.
into | The message you store your object in. |
deep | If true , all children of this object should be archived as well. |
B_OK | The archive operation was successful. |
B_BAD_VALUE | NULL archive message. |
B_ERROR | The archive operation failed. |
Reimplemented from BArchivable.