Notation Conventions

The following conventions are covered in this topic:

• Typographic Conventions

• Naming Conventions

Typographic Conventions

The following typographic conventions apply throughout the Views documentation:

• Code extracts and file names are written in a "code" typeface.

• Entries to be made by the user, such as in dialog boxes, are written in a "code" typeface.

• Command variables to be supplied by the user are written in italics.

• Some words in italics, when seen for the first time, may be found in the glossary.

Naming Conventions

Throughout the documentation, the following naming conventions apply to the API.

• The names of types, classes, functions, and macros defined in the Views library begin with Ilv, for example IlvGraphic.

• The names of types and macros not specific to Views begin with Il, for example IlBoolean.

• The names of classes as well as global functions are written as concatenated words with each initial letter capitalized. For example:

  class IlvDrawingView;

• The names of virtual and regular methods begin with a lowercase letter; the names of static methods start with an uppercase letter. For example:

  virtual IlvClassInfo* getClassInfo() const;

  static IlvClassInfo* ClassInfo*() const;

A Note on Examples

The documentation offers examples and explanations of how to use Views effectively. Moreover, some examples are extracted from the source code delivered with Views, which is in the samples directory, just below the directory where Views is installed.