C++ Visual Objects Documentation Legend

Each object documentation page contains several sections. Most include a section describing the usage syntax of the object, unless the object is not one the user is intended to create.

The following sections describe the various sections of the object documentation pages which are not self-explanatory.

Document Links

At the top of each Cvo object documentation page is a link to the Cvo object index. Also, a list of the sections available in the particular documentation page is displayed. Each line of the list is a link to the particular section specified.

Base

This is the base object from which the object being documented is derived. This will almost always be a link to the base object's own documentation.

Syntax

This section describes the invocation syntax for the documented object. The header file to include is listed first. Next, the construction method for the object is shown. Arguments surrounded by brackets ( [ ... ] ) are optional. Arguments surrounded by braces ( { ... } ) or brackets, and separated by a vertical bar ( | ), indicate that of the two or more arguments grouped within the braces or brackets, only one is permitted.

For example, in the following:

#include <Cvo/Window.h++>
new Cvo_Window ( char *resource_name
[ char *class_name ]
{ Cvo_Object *parent | Display *display } )

The file Cvo/Window.h++ must be included. The Cvo_Window object should be created as a pointer variable (Cvo_Window *). The argument resource_name is required. The argument class_name is optional. Of the two arguments parent and display, one is required.

Public Data Members

This section lists those data members in a object which are publicly accessible.

Member Functions

This section lists the public member functions of an object. Each member function will be listed with its required and optional arguments. The notation used to indicate which arguments are optional, and which arguments are mutually exclusive, is identical to that method explained above under the Syntax heading.

Member functions will generally have a description beneath its syntax summary. However, there are some cases where multiple members share a single descriptive section.

Cvo Events

This section lists the Cvo events which the documented object defines. Each listed Cvo event first has the name of the event, such as CvoMovedEvent. Next, the event structure associated with the Cvo event is identified, such as Cvo_MovedEvent. If this event structure includes any data members specific to this event, they are listed. Each event is then followed by a descriptive section.

Keyboard Translations

This section lists each event translation which is defined for the documented object. The translation binding is shown, in standard X translation format. A descriptive section follows.

Children Objects

When a Cvo object is composed of other Cvo objects, those other objects are listed in this section. This permits the user to gain access to the X resources of those children objects. Each Cvo object listed is a link to its documentation, and is followed by the X resource name for the object.

New X Resources

This section identifies those X resources which this object uses, and which are unique to this object. Each resource has its default value listed, if it has one. Also, each resource has a description.

Modified X Resources

This section identifies those X resources used by the object's ancestor objects, which this object has modified from the default values assigned by ancestor objects.