WT_User_Fill_Pattern Class Reference
[Rendition attributes]

#include <usrfillpat.h>

Inheritance diagram for WT_User_Fill_Pattern:

Inheritance graph
[legend]
Collaboration diagram for WT_User_Fill_Pattern:

Collaboration graph
[legend]
List of all members.

Detailed Description

Attribute class for specifying a user defined fill pattern.

Definition at line 37 of file usrfillpat.h.

Public Member Functions

 WT_User_Fill_Pattern ()
 Constructs a WT_User_Fill_Pattern object.
 WT_User_Fill_Pattern (WT_Integer16 pattern_num)
 Constructs a WT_User_Fill_Pattern with the given ID.
 WT_User_Fill_Pattern (WT_Integer16 pattern_num, WT_Unsigned_Integer16 rows, WT_Unsigned_Integer16 columns, WT_Unsigned_Integer32 data_size, WT_Byte const *data)
 Constructs a WT_User_Fill_Pattern with a user defined bitonal bitmap passing in all the parameters.
 WT_User_Fill_Pattern (WT_Integer16 pattern_num, Fill_Pattern *fill_pattern)
 Constructs a WT_User_Fill_Pattern with a user defined bitonal bitmap using the reference counted Fill_Pattern class.
 WT_User_Fill_Pattern (WT_User_Fill_Pattern const &)
 Copy Constructor for the WT_User_Fill_Pattern.
virtual ~WT_User_Fill_Pattern ()
 Destroys a WT_User_Fill_Pattern object.
WT_User_Fill_Pattern const & operator= (WT_User_Fill_Pattern const &)
 Assignment operator for the WT_User_Fill_Pattern.
WT_Integer16 const & pattern_number () const
 The user defined fill pattern number.
WT_Integer16pattern_number ()
WT_Boolean const & is_scale_used () const
WT_Booleanis_scale_used ()
WT_Pattern_Scale const & pattern_scale () const
 Returns the a read-only reference to the pattern scale option.
WT_Pattern_Scalepattern_scale ()
 Returns the a writable reference to the pattern scale option.
const Fill_Patternfill_pattern () const
 Returns the reference counted Fill_Pattern object that holds onto the data.
Fill_Pattern *& fill_pattern ()
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_User_Fill_Pattern const &pattern) const
 Returns WD_True if the given pattern is equal to this one (compares ID and pattern scale.).
WT_Boolean operator!= (WT_User_Fill_Pattern const &pattern) const
 Returns WD_True if the given pattern is NOT equal to this one (compares ID and pattern scale.).

Static Public Member Functions

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

Friends

class WT_Pattern_Scale
class WT_Rendition
class WT_W2D_Class_Factory
class WT_Opcode

Classes

class  Fill_Pattern


Member Function Documentation

static WT_Result WT_User_Fill_Pattern::default_process WT_User_Fill_Pattern 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_User_Fill_Pattern::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_User_Fill_Pattern::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_User_Fill_Pattern::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_User_Fill_Pattern::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_User_Fill_Pattern::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:28 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5