WT_URL_List Class Reference

#include <url_list.h>

Inheritance diagram for WT_URL_List:

Inheritance graph
[legend]
Collaboration diagram for WT_URL_List:

Collaboration graph
[legend]
List of all members.

Detailed Description

A linked list of WT_URL_Item objects.

Definition at line 138 of file url_list.h.

Public Member Functions

 WT_URL_List ()
 Constructs a WT_URL_List object.
 WT_URL_List (WT_URL_List const &list)
 Constructs a WT_URL_List object. Copy constructor.
virtual ~WT_URL_List ()
 Destroys a WT_URL_List object.
void add (WT_URL_Item &item)
 Adds a WT_URL_Item object to the list.
WT_Boolean check_whether_emitted (WT_Integer32 index) const
 Returns WD_True if the URL has been emitted (serialized) already.
WT_Integer32 index_from_url_item (WT_URL_Item &item_in)
 Returns the index of the WT_URL_Item if found (returns -1 if not found.).
WT_URL_Itemurl_item_from_index (WT_Integer32 index)
 Returns the WT_URL_Item object with the given index (returns NULL if not found.).
void set_as_being_emitted (WT_Integer32 index)
 Sets a flag indicating that this URL has been emitted (serializaed.).
WT_Result materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
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 process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
virtual WT_Result serialize (WT_File &file) const
 Causes the serialization of the object to the file.
WT_Result skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
WT_URL_List const & operator= (WT_URL_List const &url)
 Assignment operator. Assigns the given list contents to this one.
WT_Boolean operator== (WT_URL_List const &list) const
 Equality operator. Returns WD_True if the given list's contents is equal to this one.

Friends

class WT_URL
class WT_Attribute_URL
class WT_Rendition
class WT_W2D_Class_Factory


Member Function Documentation

WT_Boolean WT_URL_List::check_whether_emitted WT_Integer32  index  )  const
 

Returns WD_True if the URL has been emitted (serialized) already.

Note:
As an optimization, once a URL has been serialized once, subsequent references can be referred to by index.

WT_Result WT_URL_List::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_URL_List::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.

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

void WT_URL_List::set_as_being_emitted WT_Integer32  index  ) 
 

Sets a flag indicating that this URL has been emitted (serializaed.).

Note:
As an optimization, once a URL has been serialized once, subsequent references can be referred to by index.

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