WT_Option Class Reference

#include <object.h>

Inheritance diagram for WT_Option:

Inheritance graph
[legend]
Collaboration diagram for WT_Option:

Collaboration graph
[legend]
List of all members.

Detailed Description

A dependent sub-object that always gets seralized inside of a parent object.

Definition at line 250 of file object.h.

Public Types

enum  
 Materialization stage.

Public Member Functions

virtual ~WT_Option ()
virtual WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Type object_type () const
 Returns the object type WT_Type::Option.
virtual WT_Result materialize (WT_Opcode const &, WT_File &)
 Provided to implement WT_Object, but not used (returns WT_Result::Toolkit_Usage_Error).
virtual WT_Result materialize (WT_Object &, WT_Optioncode const &, WT_File &)
 Materializes the dependent WT_Option of the parent object.
virtual WT_Result process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
virtual WT_Result serialize (WT_File &) const
 Provided to implement WT_Object, but not used (returns WT_Result::Toolkit_Usage_Error).
virtual WT_Result serialize (WT_Object const &, WT_File &) const
 Serializes this dependent WT_Option of the parent object.
virtual WT_Result skip_operand (WT_Optioncode const &optioncode, WT_File &file)
 Causes the file reading to proceed to the end of this option.

Public Attributes

int m_stage
 The current materialization stage.

Protected Member Functions

 WT_Option ()
 Constructs a WT_Option object.

Friends

class WT_W2D_Class_Factory
class WT_Text_Option_Scoring
class WT_Text_Option_Bounds
class WT_Text_Option_Reserved


Member Function Documentation

virtual WT_Result WT_Option::process WT_File file  )  [virtual]
 

Calls the configured action handler for this object (passes in the file reference.).

Warning:
This is used by the framework and should not be called by client code.

Implements WT_Object.

virtual WT_Result WT_Option::skip_operand WT_Optioncode const &  optioncode,
WT_File file
[virtual]
 

Causes the file reading to proceed to the end of this option.

Warning:
This is used by the framework and should not be called by client code.


Member Data Documentation

int WT_Option::m_stage
 

The current materialization stage.

For internal use only.

We don't use this directly as an enum since child object commandeer and overload the value.

Definition at line 268 of file object.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:23 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5