You may return to the Cvo Object Documenation Index from this document. This document contains the following sections describing the Cvo_Cursor object:

Class

Cvo_Cursor

Syntax

#include <Cvo/Cursor.h++>

Cvo_Cursor c( )
Cvo_Cursor c( Cvo_Object *object,
char *name )
Cvo_Cursor c( Cvo_Object *object,
unsigned index )
Cvo_Cursor c( Cvo_Cursor old_cursor )

Overview

The Cvo_Cursor object is used to store cursors in Cvo. A cursor can be created in one of several ways, as shown above. When a Cvo_Cursor is created with no arguments it starts in the empty state, which means none of its member functions will actually work. Typically it is created with either a set of the arguments shown above, or it is assigned the value of another Cvo_Cursor object.

If name is passed, it is the name of a standard X Cursor found in <X11/cursorfont.h> (i.e. "X_cursor", "arrow", "fleur"). The XC_ prefix is optional.

If index is passed, it must be one of the XC_ defines in <X11/cursorfont.h> (i.e. XC_Xcursor, XC_arrow, XC_fleur).

In both of these cases the object argument refers to the Cvo_Object for which this cursor will be used. The cursor will use the foreground color, background color, and display elements from object.

If old_cursor is passed, this object will be a copy of it.

Member Functions

This object defines the following member functions.

The Cvo_Cursor object is a smart pointer. This means that the Cvo_Cursor object actually indirectly accesses the data associated with it. This allows for many Cvo_Cursor objects to actually refer to the same cursor value. Due to this, the Cvo_Cursor object has a somewhat unique method of accessing most of its member functions. All the functions listed below assume the name of the Cvo_Cursor object is c. Note that c is not a pointer to a Cvo_Cursor object but the Cvo_Cursor object itself.


See the legend for information about the conventions used in this documentation.