MWAWPictData Class Referenceabstract

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

#include <MWAWPictData.hxx>

Inheritance diagram for MWAWPictData:
MWAWPict MWAWPictDB3 MWAWPictDUnknown MWAWPictMac

Public Types

enum  SubType { PictMac, DB3, Unknown }
 the picture subtype More...
 
- Public Types inherited from MWAWPict
enum  Type { PictData, Bitmap, Unknown }
 the different picture types: More...
 
enum  ReadResult { MWAW_R_BAD =0, MWAW_R_OK, MWAW_R_OK_EMPTY, MWAW_R_MAYBE }
 an enum to defined the result of a parsing use by some picture's classes which can read their data More...
 

Public Member Functions

 ~MWAWPictData () override
 destructor More...
 
Type getType () const override
 returns the picture type More...
 
virtual SubType getSubType () const =0
 returns the picture subtype More...
 
bool getBinary (MWAWEmbeddedObject &picture) const override
 returns the final picture More...
 
virtual bool sure () const
 returns true if we are relatively sure that the data are correct More...
 
virtual bool valid () const
 returns true if the picture is valid More...
 
bool isEmpty () const
 returns true if the picture is valid and has size 0 or contains no data More...
 
int cmp (MWAWPict const &a) const override
 a virtual function used to obtain a strict order, must be redefined in the subs class More...
 
- Public Member Functions inherited from MWAWPict
virtual ~MWAWPict ()
 virtual destructor More...
 
MWAWBox2f getBdBox () const
 returns the bdbox of the picture More...
 
void setBdBox (MWAWBox2f const &box)
 sets the bdbox of the picture More...
 

Static Public Member Functions

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

Protected Member Functions

 MWAWPictData ()
 protected constructor: use check to construct a picture More...
 
 MWAWPictData (MWAWBox2f &)
 
- Protected Member Functions inherited from MWAWPict
void extendBDBox (float val)
 udaptes the bdbox, by extended it by (val-previousVal) More...
 
 MWAWPict ()
 protected constructor must not be called directly More...
 
 MWAWPict (MWAWPict const &p)
 protected constructor must not be called directly More...
 
MWAWPictoperator= (MWAWPict const &p)
 protected operator= must not be called directly More...
 

Static Protected Member Functions

static bool createFileData (librevenge::RVNGBinaryData const &orig, librevenge::RVNGBinaryData &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 More...
 
static ReadResult checkOrGet (MWAWInputStreamPtr input, int size, MWAWBox2f &box, MWAWPictData **result=nullptr)
 checks if the data pointed by input and of given size is a pict More...
 
- Static Protected Member Functions inherited from MWAWPict
static MWAWBox2f getBdBox (int numPt, MWAWVec2f const *pt)
 computes the minimum and maximum of a list of point More...
 

Protected Attributes

librevenge::RVNGBinaryData m_data
 the data size (without the empty header of 512 characters) More...
 
bool m_empty
 some picture can be valid but empty More...
 

Detailed Description

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

Member Enumeration Documentation

◆ SubType

the picture subtype

Enumerator
PictMac 
DB3 
Unknown 

Constructor & Destructor Documentation

◆ ~MWAWPictData()

MWAWPictData::~MWAWPictData ( )
override

destructor

◆ MWAWPictData() [1/2]

MWAWPictData::MWAWPictData ( )
inlineprotected

protected constructor: use check to construct a picture

◆ MWAWPictData() [2/2]

MWAWPictData::MWAWPictData ( MWAWBox2f )
inlineexplicitprotected

Member Function Documentation

◆ check()

◆ checkOrGet()

MWAWPictData::ReadResult MWAWPictData::checkOrGet ( MWAWInputStreamPtr  input,
int  size,
MWAWBox2f box,
MWAWPictData **  result = nullptr 
)
staticprotected

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

Referenced by check(), and get().

◆ cmp()

int MWAWPictData::cmp ( MWAWPict const &  a) const
inlineoverridevirtual

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

Reimplemented from MWAWPict.

Reimplemented in MWAWPictMac, MWAWPictDUnknown, and MWAWPictDB3.

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

◆ createFileData()

bool MWAWPictData::createFileData ( librevenge::RVNGBinaryData const &  orig,
librevenge::RVNGBinaryData &  result 
)
staticprotected

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().

◆ get()

◆ getBinary()

bool MWAWPictData::getBinary ( MWAWEmbeddedObject picture) const
inlineoverridevirtual

returns the final picture

Reimplemented from MWAWPict.

Reimplemented in MWAWPictMac.

◆ getSubType()

virtual SubType MWAWPictData::getSubType ( ) const
pure virtual

returns the picture subtype

Implemented in MWAWPictMac, MWAWPictDUnknown, and MWAWPictDB3.

Referenced by cmp(), and sure().

◆ getType()

Type MWAWPictData::getType ( ) const
inlineoverridevirtual

returns the picture type

Implements MWAWPict.

◆ isEmpty()

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().

◆ sure()

virtual bool MWAWPictData::sure ( ) const
inlinevirtual

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

◆ valid()

virtual bool MWAWPictData::valid ( ) const
inlinevirtual

returns true if the picture is valid

Reimplemented in MWAWPictMac, MWAWPictDUnknown, and MWAWPictDB3.

Referenced by getBinary().

Member Data Documentation

◆ m_data

librevenge::RVNGBinaryData 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().

◆ m_empty

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:

Generated on Fri Sep 18 2020 18:14:52 for libmwaw by doxygen 1.8.20