WT_View Class Reference
[Rendering attributes]

#include <view.h>

Inheritance diagram for WT_View:

Inheritance graph
[legend]
Collaboration diagram for WT_View:

Collaboration graph
[legend]
List of all members.

Detailed Description

Describes the initial view. Should be serialized before any drawables (if possible).

WHIP! data authors wishing to persist view other than the initial view should use the WT_Named_View object.

See also:
WT_Rendering_Options, WT_Named_View
Examples:

WhipExamples/View.cpp.

Definition at line 40 of file view.h.

Public Member Functions

 WT_View ()
 Constructs a WT_View object.
 WT_View (WT_Logical_Box view)
 Constructs a WT_View object with the given bounds.
 WT_View (char *name)
 Constructs a WT_View object with the given name.
 WT_View (WT_View const &view)
 Constructs a WT_View object. Copy constructor.
virtual ~WT_View ()
WT_String const & name () const
 Returns the view name.
void set (char const *name)
 Sets the view name.
void set (WT_Unsigned_Integer16 const *name)
 Sets the view name.
void set (WT_String const &name)
 Sets the view name.
void set (WT_Logical_Box const &view)
 Sets the view bounds.
WT_Logical_Box const & view () const
WT_View const & operator= (WT_View const &view)
 Assignment operator. Copies the give view data to this one.
WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Result materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_Result process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
WT_Result skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
WT_Result serialize (WT_File &file) const
 Forces the serialization of the object to the file.
WT_Result sync (WT_File &file) const
 Serializes the attribute out to the file, if necessary.
WT_Boolean operator== (WT_Attribute const &attrib) const
 Returns WD_True if the attributes are equal.

Static Public Member Functions

static WT_Result default_process (WT_View &item, WT_File &file)
 Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).

Friends

class WT_Rendering_Options
class WT_W2D_Class_Factory
class WT_Opcode


Member Function Documentation

static WT_Result WT_View::default_process WT_View item,
WT_File file
[static]
 

Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).

Warning:
This is used by the framework and should not be called by client code.
Parameters:
item  The attribute to process.
file  The file being read.

WT_Result WT_View::materialize WT_Opcode const &  opcode,
WT_File file
[virtual]
 

Materializes the contents of the object from the file and the given opcode.

Reads in the object data and causes the file reading to proceed to the end of this object.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.
WT_Result::Opcode_Not_Valid_For_This_Object The object does not support the opcode type.
WT_Result::Internal_Error Something went very wrong.

Implements WT_Object.

WT_Result WT_View::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.

WT_Result WT_View::serialize WT_File file  )  const [virtual]
 

Forces the serialization of the object to the file.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.

Implements WT_Attribute.

Examples:
WhipExamples/View.cpp.

WT_Result WT_View::skip_operand WT_Opcode const &  opcode,
WT_File file
[virtual]
 

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

Warning:
This is used by the framework and should not be called by client code.
Bug:
Not all objects perform skip_operand() correctly; this is a known problem. For best results, if client code must use WT_File::get_next_object_shell() manually, it should also call the corresponding WT_Object::materialize() method to avoid this problem.
See also:
WT_File::get_next_object_shell(), WT_File_Heuristics::set_deferred_delete().

Reimplemented from WT_Object.

WT_Result WT_View::sync WT_File file  )  const [virtual]
 

Serializes the attribute out to the file, if necessary.

Only outputs relevant desired rendition changes to the file.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.
See also:
WT_File::desired_rendition().

Implements WT_Attribute.


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