WT_Background Class Reference
[Rendering attributes]

#include <backgrnd.h>

Inheritance diagram for WT_Background:

Inheritance graph
[legend]
Collaboration diagram for WT_Background:

Collaboration graph
[legend]
List of all members.

Detailed Description

Describes the drawing background color (i.e. paper color.).

Deprecated:
This class is provided for backward compatibiility with classic DWF files of version 0.55 and earlier. Users desiring to set background color for W2D files should set the DWFEPlot::EPlotPaper color. Any attempt to use this attribute in version 6.0 or greater will result in a WT_Result::Toolkit_Usage_Error during the sync() and/or serialize() calls.
See also:
WT_Rendering_Options

Definition at line 44 of file backgrnd.h.

Public Member Functions

 WT_Background ()
 Creates a WT_Background object.
 WT_Background (const WT_Color &color)
 Creates a WT_Background object using the specified color.
virtual ~WT_Background ()
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.
virtual void set (WT_Color const &color)
 Sets the background color from a WT_Color object.
const WT_Colorcolor () const
 Read-only accessor to a WT_Color object representing the background color.

Static Public Member Functions

static WT_Result default_process (WT_Background &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_Background::default_process WT_Background 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_Background::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_Background::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_Background::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.

virtual void WT_Background::set WT_Color const &  color  )  [virtual]
 

Sets the background color from a WT_Color object.

Parameters:
color  The new color.

WT_Result WT_Background::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_Background::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:14 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5