WT_Embed Class Reference
[Support objects]

#include <embed.h>

Inheritance diagram for WT_Embed:

Inheritance graph
[legend]
Collaboration diagram for WT_Embed:

Collaboration graph
[legend]
List of all members.

Detailed Description

Allows the source file from which the WHIP! data was created to be embedded (or referenced) inside the WHIP! data.

This helps to facilitate smart drag-and-drop operations for those consuming applications which do so.

Definition at line 38 of file embed.h.

Public Member Functions

 WT_Embed ()
 Constructs a WT_Embed object.
 WT_Embed (WT_Embed const &embed)
 Constructs a WT_Embed object. Copy constructor.
virtual ~WT_Embed ()
WT_String const & description () const
 Returns the human-readable description of the source data.
WT_String const & filename () const
 Returns the source data file name.
WT_String const & MIME_options () const
 Returns the MIME options field.
WT_String const & MIME_subtype () const
 Returns the MIME subtype of the data being embedded.
WT_String const & MIME_type () const
 Returns the standard MIME (Multipurpose Internet Mail Extension) specification type field of the data being embedded.
WT_Result set_description (char const *description, WT_File &file)
 Sets the human-readable description of the source data.
WT_Result set_description (WT_Unsigned_Integer16 const *description, WT_File &file)
 Sets the human-readable description of the source data.
WT_Result set_filename (char const *filename, WT_File &file)
 Sets the source data file name.
WT_Result set_filename (WT_Unsigned_Integer16 const *filename, WT_File &file)
 Sets the source data file name.
WT_Result set_MIME_options (char const *options, WT_File &file)
 Sets the MIME options field.
WT_Result set_MIME_options (WT_Unsigned_Integer16 const *options, WT_File &file)
 Sets the MIME options field.
WT_Result set_MIME_subtype (char const *subtype, WT_File &file)
 Sets the MIME subtype of the data being embedded.
WT_Result set_MIME_subtype (WT_Unsigned_Integer16 const *subtype, WT_File &file)
 Sets the MIME subtype of the data being embedded.
WT_Result set_MIME_type (char const *type, WT_File &file)
 Sets the standard MIME (Multipurpose Internet Mail Extension) specification type field of the data being embedded.
WT_Result set_MIME_type (WT_Unsigned_Integer16 const *type, WT_File &file)
 Sets the standard MIME (Multipurpose Internet Mail Extension) specification type field of the data being embedded.
WT_Result set_url (char const *url, WT_File &file)
 Sets the URL of the source data file.
WT_Result set_url (WT_Unsigned_Integer16 const *url, WT_File &file)
 Sets the URL of the source data file.
WT_Result set_whole_MIME (char const *mime, WT_File &file)
 Sets the full MIME type, i.e. text/html.
WT_String const & url () const
 Returns the URL of the source data file.
WT_Embed const & operator= (WT_Embed const &embed)
 Assignment operator. Copies the contents of the given embed object to this one.
WT_Boolean operator== (WT_Object const &object) const
 Returns WD_True if the given object is equal to this one.
WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Type object_type () const
 Returns the WT_Type 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
 Causes the serialization of the object to the file.

Static Public Member Functions

static WT_Result default_process (WT_Embed &item, WT_File &file)
 Provides a default action handler for this object.

Friends

class WT_W2D_Class_Factory
class WT_Opcode


Member Function Documentation

static WT_Result WT_Embed::default_process WT_Embed item,
WT_File file
[static]
 

Provides a default action handler for this object.

Warning:
This is used by the framework and should not be called by client code.
Parameters:
item  The object to process.
file  The file being read.

WT_Result WT_Embed::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_String const& WT_Embed::MIME_subtype  )  const [inline]
 

Returns the MIME subtype of the data being embedded.

If the full mime type were text/html, the MIME subtype would be html.

Definition at line 91 of file embed.h.

WT_String const& WT_Embed::MIME_type  )  const [inline]
 

Returns the standard MIME (Multipurpose Internet Mail Extension) specification type field of the data being embedded.

If the full mime type were text/html, the MIME type would be text.

Definition at line 94 of file embed.h.

WT_Result WT_Embed::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_Embed::serialize WT_File file  )  const [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.

WT_Result WT_Embed::set_MIME_subtype WT_Unsigned_Integer16 const *  subtype,
WT_File file
 

Sets the MIME subtype of the data being embedded.

If the full mime type were text/html, the MIME subtype would be html.

WT_Result WT_Embed::set_MIME_subtype char const *  subtype,
WT_File file
 

Sets the MIME subtype of the data being embedded.

If the full mime type were text/html, the MIME subtype would be html.

WT_Result WT_Embed::set_MIME_type WT_Unsigned_Integer16 const *  type,
WT_File file
 

Sets the standard MIME (Multipurpose Internet Mail Extension) specification type field of the data being embedded.

If the full mime type were text/html, the MIME type would be text.

WT_Result WT_Embed::set_MIME_type char const *  type,
WT_File file
 

Sets the standard MIME (Multipurpose Internet Mail Extension) specification type field of the data being embedded.

If the full mime type were text/html, the MIME type would be text.

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