|
<NAME>
|
The
Name title is a case sensitive string used to identify the
C++ coclass. Coclasses are used in conjunction with
C++ interface classes, called simply interfaces.
|
|
|
Interfaces are used for coclass communication. Interfaces are the services. Coclasses don't care about other coclasses, but rather they care about the services. Interfaces are pure abstract base classes. They provide the definition of the interface only.
|
|
|
Purpose:
|
The
Purpose field summarizes the intended purpose of the coclass.
|
|
|
Derivation:
|
The
Derivation field specifies the derivation of the coclass. The class described by the template is always listed on the left, followed by its parent, grandparent, etc. The last class in the list is always a base class, indicated by a trailing hyphen (-). Classes with no parents (base classes) show only the class name and a trailing hyphen (-).
|
|
|
GUID:
|
The
GUID field specifies the Globally Unique Identifier for the coclass. This is a long hexidecimal number that uniquely identifies the interface to the operating system. It is used in Microsoft COM to provide the handle to this coclass.
|
|
|
SAT Identifier:
|
The
SAT Identifier field contains either a quoted identifier string or the word "None".
|
|
|
|
The
quoted identifier string is the word relating to the class that is written to the SAT save file in addition to the saved data for this class. This string is the same as that returned by the class method
type_name.
|
|
|
|
The word "None" in this field means that there is no identifier written to the save file for this class. However, the class may have data that is written to the SAT save file.
|
|
|
Filename:
|
The
Filename field specifies the name of the header file, including the directory path, containing the prototype of the class. To use this class, applications should include this header file. The first element of the file path is the component's top-level installation directory.
|
|
|
Description:
|
The
Description field describes the class, its use, and its structure. This field may provide other general information that applies to the entire class.
|
|
|
Data:
|
The
Data field describes public and protected data items used by the coclass. Public data can generally be accessed by any other function. Protected data can generally be referenced only by this class and derived classes. Private data is never shown.
|
|
|
Interfaces:
|
The
Interfaces field lists the interface classes that this coclass references. The interface classes define the services that are available to a coclass object and specify the manner in which those services are accessed.
|
|
|
Constructor:
|
The
Constructor field lists public and protected constructors. Generally, coclass constructors are never called directly. Instead, class factories are used to create the coclass object instance.
|
|
|
Destructor:
|
The
Destructor field lists public and protected destructors. Generally, coclass destructors are never called directly. Instead
release tools are provided which clean up associated data and pointers.
|
|
|
Methods:
|
The
Methods field alphabetically lists the public and protected coclass methods (member functions) which are not already specified by an interface class and are not already marked for internal use only.
|
|
|
Internal Use:
|
The
Internal Use field alphabetically lists class methods that are internal to
ACIS and not intended for direct usage. These are public or protected coclass methods which are declared in the class header file, are not already specified by an interface class, and may be needed for coclass derivation. If required, refer to the header file and other sources for more detailed information.
|
|
|
Related Fncs:
|
The
Related Fncs field lists other useful functions declared in the class header file that are not class methods. If the class has
friend operator related functions, their prototypes are provided after this list.
|