Inside Macintosh: OpenDoc Cookbook /

Preface - About This Book

Typographic Conventions

This book uses various conventions to present certain types of information.

Special Font

All code listings, reserved words, and the names of data structures, classes constants, fields, parameters, methods, and functions are shown in Letter Gothic (this is Letter Gothic).

Types of Notes

There are two types of notes used in this book, which are formatted like the following two paragraphs.

Note

A note formatted like this contains information that is interesting but possibly not essential to an understanding of the main text.

IMPORTANT

A note like this contains information that is especially important.

Coding Conventions

Following are some conventions that apply to the code samples in this book.

Identifier Names

The listings that appear in this book embody certain naming conventions designed to indicate the type and usage of identifiers. These conventions and examples of each are as follows:

OpenDoc classes begin with OD ODFrame

Locally defined classes begin with C CFocus

Virtual base classes begin with V VMyVirtualClass

Members begin with f fDisplayFrames

Constants begin with k kODSmallIconSize

Functions begin with a capital LoadIcons

Getter and setter methods
begin with Set, Get, or Is GetViewType

Static variables begin with g gMenuBar

Static data members begin with fg fgGlobalVar
(includes class globals)

Enumeration types begin with E EColorType

Class Definitions

Class definitions appearing in header files contain only the data members and method declarations; they contain no implementation. Inline methods for getters and setters, however, appear in the header file.

Main | Top of Section | What's New | Apple Computer, Inc. | Find It | Feedback | Help