WT_Named_View Class Reference
[Support objects]

#include <named_view.h>

Inheritance diagram for WT_Named_View:

Inheritance graph
[legend]
Collaboration diagram for WT_Named_View:

Collaboration graph
[legend]
List of all members.

Detailed Description

An object which defines a rectangular view associated with a string name.

Definition at line 36 of file named_view.h.

Public Member Functions

 WT_Named_View (void)
 Constructs a WT_Named_View object.
 WT_Named_View (WT_Named_View const &named_view)
 Constructs a WT_Named_View object. Copy constructor.
 WT_Named_View (WT_Logical_Box const &view, const char *name=WD_Null)
 Constructs a WT_Named_View object with the given view and name.
 WT_Named_View (WT_Logical_Box const &view, WT_Unsigned_Integer16 const *name)
 Constructs a WT_Named_View object with the given view and name.
virtual ~WT_Named_View (void)
 Destroys a WT_Named_View object.
WT_String const & name () const
 Returns a read-only accessor for the view name.
WT_Logical_Boxview () const
 Returns a read-only pointer to a WT_Logical_Box describing the view rectangle.
void set (WT_Named_View const &named_view)
 Sets the named view from another one (copies its values.).
void set (WT_Logical_Box const &view)
 Sets the view rectangle from the given box.
void set (const char *name)
 Sets the view name from the given string.
void set (WT_Unsigned_Integer16 const *name)
 Sets the view name from the given string.
void set (WT_String const &name)
 Sets the view name from the given string.
void set (int length, WT_Unsigned_Integer16 const *name)
 Sets the view name from the characters in given string buffer, for the specified length.
WT_Named_View const & operator= (WT_Named_View const &named_view)
 Assignment operator. Sets the named view from another one (copies its values.).
WT_Boolean operator== (WT_Named_View const &named_view) const
 Returns WD_True if this named view is equal to the given one.
virtual WT_Named_Viewcopy () const
 Copies the current name view to a new instantiation.
WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Type object_type () const
 Returns the WT_Type 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
 Causes the serialization of the object to the file.

Static Public Member Functions

static WT_Result default_process (WT_Named_View &item, WT_File &file)
 Provides a default action handler for this object.

Friends

class WT_Class_Factory
class WT_W2D_Class_Factory
class WT_Opcode


Member Function Documentation

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

Provides a default action handler for this object.

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

WT_Result WT_Named_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_Named_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_Named_View::serialize WT_File file  )  const [virtual]
 

Causes the serialization of the object to the file.

If this is a WT_Drawable derived object, this method may cause the object to be delayed (in case a coincident like-object follows) and/or merged (in case a coincident like-object preceeded) so as to optimize the output.

Return values:
WT_Result::Success The operation was successful.

Implements WT_Object.

WT_Result WT_Named_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.


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