WT_Inked_Area Class Reference
[Rendering attributes]

#include <inked_area.h>

Inheritance diagram for WT_Inked_Area:

Inheritance graph
[legend]
Collaboration diagram for WT_Inked_Area:

Collaboration graph
[legend]
List of all members.

Detailed Description

Describes the drawing extents of the WHIP! data.

Deprecated:
This information is now contained in the DWFEPlot::EPlotGraphicResource "extents" rectangle. This remains in the toolkit only for backward compatability with previous versions of DWF.
See also:
WT_Rendering_Options

Definition at line 36 of file inked_area.h.

Public Member Functions

 WT_Inked_Area ()
 Constructs a WT_Inked_Area object.
 WT_Inked_Area (WT_Logical_Point const *pos) throw (WT_Result)
 Constructs a WT_Inked_Area object with the given bounds (lower-left, lower-right, upper-right, upper-left.).
 WT_Inked_Area (WT_Inked_Area const &bounds) throw (WT_Result)
 Constructs a WT_Inked_Area object. Copy constructor.
virtual ~WT_Inked_Area ()
 Destroys a WT_Inked_Area object.
WT_Logical_Point const * bounds () const
 Returns the array of points representing the bounds (lower-left, lower-right, upper-right, upper-left.).
void de_relativize (WT_File &file)
 Returns the bounding box points to absolute values based on their relative position to last materialized point.
WT_Logical_Point const * get_inked_area () const
 Alias for bounds() - Returns the array of points representing the bounds (lower-left, lower-right, upper-right, upper-left.).
void relativize (WT_File &file)
 Relativizes the bounding box points to the last serialized point.
WT_Result set (WT_Logical_Point const *bounds)
 Sets the array of points representing the bounds (lower-left, lower-right, upper-right, upper-left.).
WT_Result set_inked_area (WT_Logical_Point const *bounds)
 Alias for set() - Sets the array of points representing the bounds (lower-left, lower-right, upper-right, upper-left.).
void transform (WT_Transform const &transform)
 Applies the given transform to the bounding box points.
virtual WT_Inked_Area const & operator= (WT_Inked_Area const &inked_area) throw (WT_Result)
 Assignment operator. Assigns the given inked area settings 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_Inked_Area &item, WT_File &file)
 Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).


Member Function Documentation

static WT_Result WT_Inked_Area::default_process WT_Inked_Area 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_Inked_Area::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_Inked_Area::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_Inked_Area::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.

WT_Result WT_Inked_Area::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_Inked_Area::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:20 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5