WT_Line_Style Class Reference
[Rendition attributes]

#include <linestyle.h>

Inheritance diagram for WT_Line_Style:

Inheritance graph
[legend]
Collaboration diagram for WT_Line_Style:

Collaboration graph
[legend]
List of all members.

Detailed Description

Describes the attributes which affect rendered lines, polylines, and arcs.

See also:
WT_Rendition

Definition at line 83 of file linestyle.h.

Public Types

enum  WT_Capstyle_ID
 An enumeration of cap styles used by WT_Line_End_Cap, WT_Line_Start_Cap, WT_Dash_End_Cap, and WT_Dash_Start_Cap.
enum  WT_Joinstyle_ID
 An enumeration of styles used when joining two thick line segments.
enum  
 Bit settings to identify which line style options are defined.

Public Member Functions

 WT_Line_Style ()
 Constructs a WT_Line_Style object.
 WT_Line_Style (WT_Line_Style const &copy)
virtual ~WT_Line_Style ()
virtual WT_Line_Styleoperator= (WT_Line_Style const &copy)
 Copies the given style's option settings to this one.
void merge (WT_Line_Style const &style)
 Merges the given style's option settings to this one.
WHIP_LINE_STYLE_LIST WT_Pattern_Scale
const & 
pattern_scale () const
WHIP_LINE_STYLE_LIST WT_Pattern_Scalepattern_scale ()
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_Line_Style &item, WT_File &file)
 Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).

Public Attributes

WT_Unsigned_Integer16 m_fields_defined

Protected Types

enum  WT_Materialize_Stage

Protected Attributes

WT_Line_Style_Option_Code m_optioncode
WT_Pattern_Scale m_pattern_scale

Friends

class WT_Pattern_Scale
class WT_Rendition
class WT_W2D_Class_Factory
class WT_Opcode

Classes

class  WT_Line_Style_Option_Code
 Provides an ID for line style option objects. More...


Member Function Documentation

static WT_Result WT_Line_Style::default_process WT_Line_Style 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_Style::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_Line_Style::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_Style::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_Style::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_Style::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