WT_Attribute Class Reference

#include <attribute.h>

Inheritance diagram for WT_Attribute:

Inheritance graph
[legend]
Collaboration diagram for WT_Attribute:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for attributes contained by WT_Rendition and WT_Rendering_Options.

Note:
When seriailzing (writing) data to a file, clients should always use the WT_File::desired_rendition() to set attributes. When materializing (reading) data, clients should use the WT_File::rendition() to read attributes.
Warning:
Clients should never call serialize() or sync() to write attributes manually, as the optimization of the resultant file will suffer. Serialization will occur automatically through the framework.
See also:
WT_File::desired_rendition(), WT_File::rendition().

Definition at line 40 of file attribute.h.

Public Member Functions

virtual WT_Type object_type () const
 Returns the object type WT_Type::Attribute.
virtual WT_Result serialize (WT_File &file) const =0
 Forces the serialization of the object to the file.
virtual WT_Result sync (WT_File &file) const =0
 Serializes the attribute out to the file, if necessary.
virtual WT_Boolean operator== (WT_Attribute const &attrib) const =0
 Returns WD_True if the attributes are equal.
WT_Boolean operator!= (WT_Attribute const &attrib) const
 Returns WD_True if the attributes are not equal.

Protected Member Functions

 WT_Attribute ()
 Constructs a WT_Attribute object.
virtual ~WT_Attribute ()
 Destroys a WT_Attribute object.

Friends

class WT_Class_Factory
class WT_DeprecatedClassFactory


Member Function Documentation

virtual WT_Result WT_Attribute::serialize WT_File file  )  const [pure 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_Object.

Implemented in WT_Attribute_URL, WT_Background, WT_BlockRef, WT_Code_Page, WT_Color, WT_Color_Map, WT_Contrast_Color, WT_Dash_Pattern, WT_Delineate, WT_Fill, WT_Fill_Pattern, WT_Font, WT_Font_Extension, WT_Inked_Area, WT_Layer, WT_Line_Pattern, WT_Line_Style, WT_Line_Weight, WT_Macro_Index, WT_Macro_Scale, WT_Marker_Size, WT_Marker_Symbol, WT_Merge_Control, WT_Object_Node, WT_Pen_Pattern, WT_PenPat_Options, WT_Plot_Optimized, WT_Projection, WT_Text_Background, WT_Text_HAlign, WT_Text_VAlign, WT_URL, WT_User_Fill_Pattern, WT_User_Hatch_Pattern, WT_View, WT_Viewport, and WT_Visibility.

virtual WT_Result WT_Attribute::sync WT_File file  )  const [pure 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().
Parameters:
file  File being written.

Implemented in WT_Attribute_URL, WT_Background, WT_BlockRef, WT_Code_Page, WT_Color, WT_Color_Map, WT_Contrast_Color, WT_Dash_Pattern, WT_Delineate, WT_Fill, WT_Fill_Pattern, WT_Font, WT_Font_Extension, WT_Inked_Area, WT_Layer, WT_Line_Pattern, WT_Line_Style, WT_Line_Weight, WT_Macro_Index, WT_Macro_Scale, WT_Marker_Size, WT_Marker_Symbol, WT_Merge_Control, WT_Object_Node, WT_Pen_Pattern, WT_PenPat_Options, WT_Plot_Optimized, WT_Projection, WT_Text_Background, WT_Text_HAlign, WT_Text_VAlign, WT_URL, WT_User_Fill_Pattern, WT_User_Hatch_Pattern, WT_View, WT_Viewport, and WT_Visibility.


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