WT_Line_Weight Class Reference
[Rendition attributes]

#include <lweight.h>

Inheritance diagram for WT_Line_Weight:

Inheritance graph
[legend]
Collaboration diagram for WT_Line_Weight:

Collaboration graph
[legend]
List of all members.

Detailed Description

Rendition attribute describing the current line weight to be applied to subsequent lines and arcs.

See also:
WT_Rendition
Examples:

WhipExamples/LineWeight.cpp.

Definition at line 39 of file lweight.h.

Public Member Functions

 WT_Line_Weight ()
 Constructs a WT_Line_Weight object.
 WT_Line_Weight (WT_Integer32 weight)
 Constructs a WT_Line_Weight object with the given line weight.
 WT_Line_Weight (WT_Line_Weight const &copy)
 Constructs a WT_Line_Weight object with the given line weight.
virtual ~WT_Line_Weight ()
WT_Integer32 const & weight_value () const
 Returns a read-only reference to the line weight value.
WT_Integer32weight_value ()
 Returns a writable reference to the line weight value.
WT_Line_Weightoperator= (WT_Integer32 weight)
 Assignment operator. Sets the line weight to the given value.
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.
WT_Boolean operator== (WT_Integer32 weight) const
 Returns WD_True if the given line weight matches this line weight.

Static Public Member Functions

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

Friends

class WT_Rendition
class WT_W2D_Class_Factory
class WT_Opcode


Member Function Documentation

static WT_Result WT_Line_Weight::default_process WT_Line_Weight 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_Line_Weight::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_Line_Weight& WT_Line_Weight::operator= WT_Integer32  weight  )  [inline]
 

Assignment operator. Sets the line weight to the given value.

Parameters:
weight  The line weight, in drawing units (0 indicates a 1-pixel line. Negative values are undefined.)

Definition at line 80 of file lweight.h.

WT_Result WT_Line_Weight::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_Line_Weight::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_Line_Weight::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_Line_Weight::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:21 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5