Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | Related Pages | Examples

WT_Font_Extension Class Reference
[ class]

#include <font_extension.h>

Inheritance diagram for WT_Font_Extension:

Inheritance graph
[legend]
Collaboration diagram for WT_Font_Extension:

Collaboration graph
[legend]
List of all members.

Detailed Description

Rendition attribute containing additional information for a font.

See also:
WT_Rendition

WT_Font

See the embedded fonts example provided in the sample app W2DTest accompanying the WHIP! Toolkit source distribution.

Definition at line 36 of file font_extension.h.

Public Member Functions

Construction
 WT_Font_Extension ()
 Constructs a WT_Font_Extension object.
 WT_Font_Extension (WT_String logfont_name, WT_String cannonical_name)
 Constructs a WT_Font_Extension object with the given data.
Data access methods
WT_String cannonical_name ()
 Returns the cannonical font name.
WT_String logfont_name ()
 Returns the LOGFONT name.
void set_cannonical_name (WT_String cannonical_name)
 Sets the cannonical font name.
void set_logfont_name (WT_String logfont_name)
 Sets the font name as it would appear in a LOGFONT structure.
WT_Object and WT_Attribute virtual methods
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_Font_Extension &item, WT_File &file)
 Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).


Constructor & Destructor Documentation

WT_Font_Extension::WT_Font_Extension WT_String  logfont_name,
WT_String  cannonical_name
[inline]
 

Constructs a WT_Font_Extension object with the given data.

Parameters:
logfont_name  The font name as it would appear in a LOGFONT structure.
cannonical_name  The cannonical font name.

Definition at line 59 of file font_extension.h.


Member Function Documentation

static WT_Result WT_Font_Extension::default_process WT_Font_Extension 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_Font_Extension::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_Font_Extension::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_Font_Extension::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_Font_Extension::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_Font_Extension::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 May 17 12:07:53 2005 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.1