WT_Drawing_Info Class Reference
[File I/O objects]

#include <dwginfo.h>

List of all members.


Detailed Description

Contains drawing metadata.

Note, most of the drawing info metadata objects have been deprecated. The remaining data useful for versions 06.00 and beyond are the drawing revision and the WT_Units object.

See also:
WT_Rendition

Definition at line 60 of file dwginfo.h.

Public Types

enum  WT_Drawing_Info_Bits
 Used in identifying which drawing info data have changed and need to be serialized.

Public Member Functions

 WT_Drawing_Info ()
 Constructs a WT_Drawing_Info object.
virtual ~WT_Drawing_Info ()
 Destroys a WT_Drawing_Info object.
 WT_Drawing_Info (WT_Drawing_Info const &other)
WT_Drawing_Infooperator= (WT_Drawing_Info const &other)
virtual WHIP_DRAWING_INFO_LIST
WT_Result 
sync (WT_File &file)
 Serializes pending changed drawing info settings to the file.
int decimal_revision () const
 Returns the decimal revision of the file being read.
int major_revision () const
 Returns the major revision of the file being read.
int minor_revision () const
 Returns the minor revision of the file being read.

Static Public Member Functions

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

Protected Member Functions

void set_major_revision (int rev)
void set_minor_revision (int rev)

Protected Attributes

WT_Integer32 m_changed
int m_major_revision
int m_minor_revision

Friends

class WT_DWF_Header
class WT_Rendition
class WT_W2D_Class_Factory


Member Function Documentation

int WT_Drawing_Info::decimal_revision  )  const [inline]
 

Returns the decimal revision of the file being read.

The revision is calculated as follows: (major_version * 100) + minor_version. For example, if the file version is 00.55, the decimal revision will be 55; for version 06.00, the decimal revision will be 600.

Note:
This is only used when reading a file. This method is not applicable in a write mode. When writing a file, clients should call WT_Fileheuristics().set_target_version() before opening the file to set the desired version/revision.
See also:
WT_File_Heuristics::set_target_version()

Definition at line 155 of file dwginfo.h.

static WT_Result WT_Drawing_Info::default_process WT_Drawing_Info 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.

int WT_Drawing_Info::major_revision  )  const [inline]
 

Returns the major revision of the file being read.

For example, if the file version is 00.55, the major revision is 0. For version 06.00, the major revision is 6.

Definition at line 162 of file dwginfo.h.

int WT_Drawing_Info::minor_revision  )  const [inline]
 

Returns the minor revision of the file being read.

For example, if the file version is 00.55, the minor revision is 55. For version 06.00, the minor revision is 0.

Definition at line 169 of file dwginfo.h.

virtual WHIP_DRAWING_INFO_LIST WT_Result WT_Drawing_Info::sync WT_File file  )  [virtual]
 

Serializes pending changed drawing info settings to the file.

Only outputs changed desired drawing info 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.
Examples:
WhipExamples/DrawingInfo.cpp.


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