WT_Informational Class Reference
[Metadata objects]

#include <informational.h>

Inheritance diagram for WT_Informational:

Inheritance graph
[legend]
Collaboration diagram for WT_Informational:

Collaboration graph
[legend]
List of all members.

Detailed Description

A metadata class for internal drawing metadata (also used as a base class for specific metadata objects.).

Deprecated:
This class is provided for backward compatibiility with classic DWF files of version 00.55 and earlier. Users desiring to add metadata to the W2D page should create properties using DWFEPlot::EPlotPage::GetProperties()->AddProperty(). Use of derivatives of this class are allowed in version 6.0 and beyond, but this is discouraged.

Definition at line 70 of file informational.h.

Public Member Functions

 WT_Informational ()
 Constructs a WT_Informational object.
 WT_Informational (char *string)
 Constructs a WT_Informational object with the given string value.
 WT_Informational (WT_Unsigned_Integer16 *string)
 Constructs a WT_Informational object with the given string value.
 WT_Informational (WT_Informational const &info)
 Constructs a WT_Informational object. Copy constructor.
virtual ~WT_Informational ()
virtual WT_Type object_type () const
 Returns the WT_Type for this object.
virtual WT_ID object_id () const
 Returns the WT_ID for this object.
virtual WT_Result process (WT_File &)
 Calls the configured action handler for this object (passes in the file reference.).
virtual WT_Result serialize (WT_File &) const
 Causes the serialization of the object to the file.
virtual WT_Result materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
virtual WT_Result serialize (WT_File &file, char const *name) const
 Provides a means to create custom informational metadata with the given string name.
virtual WT_Result skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
void set (char const *info)
 Sets the string value with the given string.
void set (WT_Unsigned_Integer16 const *info)
 Sets the string value with the given string.
void set (int length, WT_Unsigned_Integer16 const *info)
 Sets the string with characters from the given string buffer.
void set (WT_String const &info)
 Sets the string value with the given string.
WT_String const & string (void) const
 Returns the string value.
WT_Informational const & operator= (WT_Informational const &info)
 Assignment operator. Assigns the given object's string value to this one.
WT_Informational const & operator= (char *info)
 Assignment operator. Assigns the given string to this one.

Protected Types

enum  WT_Materialize_Stage
 Materialization stage.

Static Protected Member Functions

static WT_Result preprocess_workarounds (WT_Object &item, WT_File &file)
 Performs some fixes to data containing known errors from specific authoring apps.

Protected Attributes

WT_String m_string
 String containing the information value.
enum WT_Informational::WT_Materialize_Stage m_stage
 Materialization stage.


Member Function Documentation

virtual WT_Result WT_Informational::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.

virtual WT_Result WT_Informational::process WT_File  )  [inline, 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.

Definition at line 118 of file informational.h.

virtual WT_Result WT_Informational::serialize WT_File  )  const [inline, virtual]
 

Causes the serialization of the object to the file.

If this is a WT_Drawable derived object, this method may cause the object to be delayed (in case a coincident like-object follows) and/or merged (in case a coincident like-object preceeded) so as to optimize the output.

Return values:
WT_Result::Success The operation was successful.

Implements WT_Object.

Definition at line 119 of file informational.h.

virtual WT_Result WT_Informational::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.


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