MWAWPictData Class Reference

an abstract class which defines basic formated picture ( AppleŠ Pict, DB3, ...) More...

#include <MWAWPictData.hxx>

Inheritance diagram for MWAWPictData:
MWAWPict MWAWPictDB3 MWAWPictDUnknown MWAWPictMac

List of all members.

Public Types

enum  SubType { PictMac, DB3, Unknown }
 the picture subtype More...

Public Member Functions

virtual Type getType () const
 returns the picture type
virtual SubType getSubType () const =0
 returns the picture subtype
virtual bool getBinary (WPXBinaryData &res, std::string &s) const
 returns the final WPXBinary data
virtual bool sure () const
 returns true if we are relatively sure that the data are correct
virtual bool valid () const
 returns true if the picture is valid
bool isEmpty () const
 returns true if the picture is valid and has size 0 or contains no data
virtual int cmp (MWAWPict const &a) const
 a virtual function used to obtain a strict order, must be redefined in the subs class

Static Public Member Functions

static ReadResult check (MWAWInputStreamPtr input, int size, Box2f &box)
 checks if the data pointed by input is known
static MWAWPictDataget (MWAWInputStreamPtr input, int size)
 checks if the data pointed by input is known

Protected Member Functions

 MWAWPictData ()
 protected constructor: use check to construct a picture
 MWAWPictData (Box2f &)

Static Protected Member Functions

static bool createFileData (WPXBinaryData const &orig, WPXBinaryData &result)
 a file pict can be created from the data pict by adding a header with size 512, this function do this conversion needed to return the final picture
static ReadResult checkOrGet (MWAWInputStreamPtr input, int size, Box2f &box, MWAWPictData **result=0L)
 checks if the data pointed by input and of given size is a pict

Protected Attributes

WPXBinaryData m_data
 the data size (without the empty header of 512 characters)
bool m_empty
 some picture can be valid but empty

Detailed Description

an abstract class which defines basic formated picture ( AppleŠ Pict, DB3, ...)


Member Enumeration Documentation

the picture subtype

Enumerator:
PictMac 
DB3 
Unknown 

Constructor & Destructor Documentation

MWAWPictData::MWAWPictData ( ) [inline, protected]

protected constructor: use check to construct a picture

MWAWPictData::MWAWPictData ( Box2f ) [inline, protected]

Member Function Documentation

MWAWPictData::ReadResult MWAWPictData::checkOrGet ( MWAWInputStreamPtr  input,
int  size,
Box2f box,
MWAWPictData **  result = 0L 
) [static, protected]

checks if the data pointed by input and of given size is a pict

  • if not returns MWAW_R_BAD
  • if true
    • fills the box size
    • creates a picture if result is given and if the picture is not empty

Reimplemented in MWAWPictMac.

Referenced by check(), and get().

virtual int MWAWPictData::cmp ( MWAWPict const &  a) const [inline, virtual]

a virtual function used to obtain a strict order, must be redefined in the subs class

Reimplemented from MWAWPict.

Reimplemented in MWAWPictDUnknown, MWAWPictDB3, and MWAWPictMac.

bool MWAWPictData::createFileData ( WPXBinaryData const &  orig,
WPXBinaryData &  result 
) [static, protected]

a file pict can be created from the data pict by adding a header with size 512, this function do this conversion needed to return the final picture

Referenced by MWAWPictMac::getBinary(), and getBinary().

virtual bool MWAWPictData::getBinary ( WPXBinaryData &  res,
std::string &  s 
) const [inline, virtual]

returns the final WPXBinary data

Reimplemented from MWAWPict.

Reimplemented in MWAWPictMac.

virtual SubType MWAWPictData::getSubType ( ) const [pure virtual]

returns the picture subtype

Implemented in MWAWPictDUnknown, MWAWPictDB3, and MWAWPictMac.

Referenced by cmp(), and sure().

virtual Type MWAWPictData::getType ( ) const [inline, virtual]

returns the picture type

Implements MWAWPict.

bool MWAWPictData::isEmpty ( ) const [inline]

returns true if the picture is valid and has size 0 or contains no data

Referenced by MWAWPictMac::getBinary(), and getBinary().

virtual bool MWAWPictData::sure ( ) const [inline, virtual]

returns true if we are relatively sure that the data are correct

virtual bool MWAWPictData::valid ( ) const [inline, virtual]

returns true if the picture is valid

Reimplemented in MWAWPictDUnknown, MWAWPictDB3, and MWAWPictMac.

Referenced by getBinary().


Member Data Documentation

WPXBinaryData MWAWPictData::m_data [protected]

the data size (without the empty header of 512 characters)

Referenced by cmp(), MWAWPictMac::getBinary(), getBinary(), MWAWPictDB3::valid(), and MWAWPictDUnknown::valid().

bool MWAWPictData::m_empty [protected]

some picture can be valid but empty

Referenced by cmp(), isEmpty(), MWAWPictDB3::MWAWPictDB3(), and MWAWPictDUnknown::MWAWPictDUnknown().


The documentation for this class was generated from the following files: