PowerPoint3Parser Class Reference documentation

Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
PowerPoint3Parser Class Referencefinal

the main class to read a Microsoft PowerPoint v3 or v4 files (MacOs and Windows) More...

`#include <PowerPoint3Parser.hxx>`

Inheritance diagram for PowerPoint3Parser:

## Public Member Functions
| PowerPoint3Parser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
| constructor More...
| ~PowerPoint3Parser () final
| destructor More...
bool | checkHeader (MWAWHeader *header, bool strict=false) final
| checks if the document header is correct (or not) More...
void | parse (librevenge::RVNGPresentationInterface *documentInterface) final
| virtual function used to parse the input More...
Public Member Functions inherited from MWAWPresentationParser
| ~MWAWPresentationParser () override
| destructor More...
Public Member Functions inherited from MWAWParser
virtual | ~MWAWParser ()
| virtual destructor More...
int | version () const
| returns the works version More...
MWAWParserStatePtr | getParserState ()
| returns the parser state More...
MWAWHeader * | getHeader ()
| returns the header More...
MWAWInputStreamPtr & | getInput ()
| returns the actual input More...
MWAWListenerPtr | getMainListener ()
| returns the main listener More...
MWAWGraphicListenerPtr & | getGraphicListener ()
| returns the graphic listener More...
MWAWPresentationListenerPtr & | getPresentationListener ()
| returns the presentation listener More...
MWAWSpreadsheetListenerPtr & | getSpreadsheetListener ()
| returns the spreadsheet listener More...
MWAWTextListenerPtr & | getTextListener ()
| returns the text listener More...
MWAWFontConverterPtr & | getFontConverter ()
| returns the font converter More...
MWAWFontManagerPtr & | getFontManager ()
| returns the font manager More...
MWAWPageSpan const & | getPageSpan () const
| returns the actual page dimension More...
MWAWPageSpan & | getPageSpan ()
| returns the actual page dimension More...
double | getFormLength () const
| returns the form length More...
double | getFormWidth () const
| returns the form width More...
double | getPageLength () const
| returns the page length (form length without margin ) More...
double | getPageWidth () const
| returns the page width (form width without margin ) More...
MWAWRSRCParserPtr & | getRSRCParser ()
| returns the rsrc parser More...
libmwaw::DebugFile & | ascii ()
| a DebugFile used to write what we recognize when we parse the document More...

## Protected Member Functions
void | createDocument (librevenge::RVNGPresentationInterface *documentInterface)
| creates the listener which will be associated to the document More...
bool | createZones ()
| finds the different zones More...
void | sendSlides ()
| try to send all slides More...
bool | readListZones (int &docInfoId)
| try to read the list of zones More...
bool | readStructList (MWAWEntry const &entry, PowerPoint3ParserInternal::FieldParser &parser)
| try to read a list of structure More...
bool | readColors (MWAWEntry const &entry)
| try to read a color list More...
bool | readColorZone (MWAWEntry const &entry)
| try to read a color zone, probably used to define the menu, ...: the 8th zone More...
bool | readDocInfo (MWAWEntry const &entry)
| try to read the document info zone More...
bool | readDocRoot (MWAWEntry const &entry)
| try to read the main child of doc info More...
bool | readFont (MWAWFont &font, int schemeId)
| try to read a font More...
bool | readFontNamesList (std::map< int, int > const &fIdtoZIdMap)
| try to read a font names list More...
bool | readFontName (MWAWEntry const &entry, int id)
| try to read a font name : 11th zone More...
bool | readFramesList (MWAWEntry const &entry, PowerPoint3ParserInternal::SlideContent &content)
| try to read a frame zone in a page More...
bool | readParagraph (MWAWParagraph &para, PowerPoint3ParserInternal::Ruler const &ruler, int schemeId)
| try to read a paragraph More...
bool | readPictureDefinition (MWAWEntry const &entry, int id)
| try to read the picture definition More...
bool | readPictureContent (MWAWEntry const &entry, MWAWEmbeddedObject &pict)
| try to read the first child of the picture More...
bool | readPictureMain (MWAWEntry const &entry)
| try to read the 5th zone More...
bool | readPicturesList (std::map< int, int > const &pIdtoZIdMap)
| try to read a picture list More...
bool | readPrintInfo (MWAWEntry const &entry)
| try to read a print info zone More...
bool | readRuler (MWAWEntry const &entry, int id)
| try to read some ruler More...
bool | readScheme (MWAWEntry const &entry, int id)
| try to read a scheme More...
bool | readSlide (MWAWEntry const &entry, PowerPoint3ParserInternal::Slide &slide, int zId)
| try to read a slide main zone More...
bool | readSlideContent (MWAWEntry const &entry, PowerPoint3ParserInternal::SlideContent &slide)
| try to read the second/third child of slideMain: main, master ? More...
bool | readSlideFormats (MWAWEntry const &entry, std::vector< PowerPoint3ParserInternal::SlideFormat > &formatList)
| try to read the second child of slide content which contains some shadow offset... More...
bool | readSlidePolygons (MWAWEntry const &entry, std::vector< PowerPoint3ParserInternal::Polygon > &polyList)
| try to read the third child of slide content More...
bool | readSlideTransition (MWAWEntry const &entry)
| try to read the first child of slideMain More...
bool | readSlidesList (MWAWEntry const &entry)
| try to read the first child of docRoot More...
bool | readTextZone (MWAWEntry const &entry, PowerPoint3ParserInternal::SlideContent &content)
| try to read a text zone More...
bool | sendSlide (PowerPoint3ParserInternal::SlideContent const &slide, bool master)
| try to send a slide More...
bool | sendFrame (PowerPoint3ParserInternal::Frame const &frame, PowerPoint3ParserInternal::SlideContent const &content, bool master, std::set< int > &seen)
| try to send a frame zone More...
bool | sendText (PowerPoint3ParserInternal::SlideContent const &slide, int tId, bool placeHolder, bool master)
| try to send a text zone More...
bool | readZone9 (MWAWEntry const &entry)
| try to read the 9th zone More...
bool | readZone10 (MWAWEntry const &entry)
| try to read the 10th zone More...
bool | getColor (int colorId, int schemeId, MWAWColor &color) const
| try to return a color corresponding to a scheme and color More...
void | checkForUnparsedZones ()
| check for unparsed zone More...
Protected Member Functions inherited from MWAWPresentationParser
| MWAWPresentationParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
| constructor (protected) More...
| MWAWPresentationParser (MWAWParserStatePtr const &state)
| constructor using a state More...
Protected Member Functions inherited from MWAWParser
| MWAWParser (MWAWParserState::Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
| constructor (protected) More...
| MWAWParser (MWAWParserStatePtr const &state)
| constructor using a state More...
void | setVersion (int vers)
| sets the document's version More...
void | setGraphicListener (MWAWGraphicListenerPtr &listener)
| sets the graphic listener More...
void | resetGraphicListener ()
| resets the listener More...
void | setPresentationListener (MWAWPresentationListenerPtr &listener)
| sets the presentation listener More...
void | resetPresentationListener ()
| resets the listener More...
void | setSpreadsheetListener (MWAWSpreadsheetListenerPtr &listener)
| sets the spreadsheet listener More...
void | resetSpreadsheetListener ()
| resets the listener More...
void | setTextListener (MWAWTextListenerPtr &listener)
| sets the text listener More...
void | resetTextListener ()
| resets the listener More...
void | setAsciiName (char const *name)
| Debugging: change the default ascii file. More...
std::string const & | asciiName () const
| return the ascii file name More...

## Protected Attributes
std::shared_ptr< PowerPoint3ParserInternal::State > | m_state
| the state More...

## Friends
class | PowerPoint3ParserInternal::SubDocument

## Detailed Description

the main class to read a Microsoft PowerPoint v3 or v4 files (MacOs and Windows)

## Constructor & Destructor Documentation

## ◆ PowerPoint3Parser()

PowerPoint3Parser::PowerPoint3Parser | ( | MWAWInputStreamPtr const & | input,
|  | MWAWRSRCParserPtr const & | rsrcParser,
|  | MWAWHeader * | header
| ) |  |

constructor

## ◆ ~PowerPoint3Parser()

PowerPoint3Parser::~PowerPoint3Parser | ( |  | ) |
| final

destructor

## Member Function Documentation

## ◆ checkForUnparsedZones()

void PowerPoint3Parser::checkForUnparsedZones | ( |  | ) |
| protected

check for unparsed zone

Referenced by parse().

## ◆ checkHeader()

bool PowerPoint3Parser::checkHeader | ( | MWAWHeader * | header,
|  | bool | strict = `false`
| ) |  |
| finalvirtual

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by createZones(), and parse().

## ◆ createDocument()

void PowerPoint3Parser::createDocument | ( | librevenge::RVNGPresentationInterface * | documentInterface | ) |
| protected

creates the listener which will be associated to the document

Referenced by parse().

## ◆ createZones()

bool PowerPoint3Parser::createZones | ( |  | ) |
| protected

finds the different zones

Referenced by parse().

## ◆ getColor()

bool PowerPoint3Parser::getColor | ( | int | colorId,
|  | int | schemeId,
|  | MWAWColor & | color
| ) |  | const
| protected

try to return a color corresponding to a scheme and color

Referenced by createDocument(), readFont(), readFramesList(), and readParagraph().

## ◆ parse()

void PowerPoint3Parser::parse | ( | librevenge::RVNGPresentationInterface * | documentInterface | ) |
| finalvirtual

virtual function used to parse the input

Implements MWAWPresentationParser.

## ◆ readColors()

bool PowerPoint3Parser::readColors | ( | MWAWEntry const & | entry | ) |
| protected

try to read a color list

Referenced by readColorZone().

## ◆ readColorZone()

bool PowerPoint3Parser::readColorZone | ( | MWAWEntry const & | entry | ) |
| protected

try to read a color zone, probably used to define the menu, ...: the 8th zone

Referenced by createZones().

## ◆ readDocInfo()

bool PowerPoint3Parser::readDocInfo | ( | MWAWEntry const & | entry | ) |
| protected

try to read the document info zone

Referenced by createZones().

## ◆ readDocRoot()

bool PowerPoint3Parser::readDocRoot | ( | MWAWEntry const & | entry | ) |
| protected

try to read the main child of doc info

Referenced by createZones().

## ◆ readFont()

bool PowerPoint3Parser::readFont | ( | MWAWFont & | font,
|  | int | schemeId
| ) |  |
| protected

try to read a font

Referenced by readTextZone(), and sendText().

## ◆ readFontName()

bool PowerPoint3Parser::readFontName | ( | MWAWEntry const & | entry,
|  | int | id
| ) |  |
| protected

try to read a font name : 11th zone

Referenced by readFontNamesList().

## ◆ readFontNamesList()

bool PowerPoint3Parser::readFontNamesList | ( | std::map< int, int > const & | fIdtoZIdMap | ) |
| protected

try to read a font names list

Referenced by createZones().

## ◆ readFramesList()

bool PowerPoint3Parser::readFramesList | ( | MWAWEntry const & | entry,
|  | PowerPoint3ParserInternal::SlideContent & | content
| ) |  |
| protected

try to read a frame zone in a page

Referenced by readSlideContent().

## ◆ readListZones()

bool PowerPoint3Parser::readListZones | ( | int & | docInfoId | ) |
| protected

try to read the list of zones

Referenced by createZones().

## ◆ readParagraph()

bool PowerPoint3Parser::readParagraph | ( | MWAWParagraph & | para,
|  | PowerPoint3ParserInternal::Ruler const & | ruler,
|  | int | schemeId
| ) |  |
| protected

try to read a paragraph

Referenced by readTextZone(), and sendText().

## ◆ readPictureContent()

bool PowerPoint3Parser::readPictureContent | ( | MWAWEntry const & | entry,
|  | MWAWEmbeddedObject & | pict
| ) |  |
| protected

try to read the first child of the picture

Referenced by readPictureDefinition().

## ◆ readPictureDefinition()

bool PowerPoint3Parser::readPictureDefinition | ( | MWAWEntry const & | entry,
|  | int | id
| ) |  |
| protected

try to read the picture definition

Referenced by readPicturesList().

## ◆ readPictureMain()

bool PowerPoint3Parser::readPictureMain | ( | MWAWEntry const & | entry | ) |
| protected

try to read the 5th zone

Referenced by createZones().

## ◆ readPicturesList()

bool PowerPoint3Parser::readPicturesList | ( | std::map< int, int > const & | pIdtoZIdMap | ) |
| protected

try to read a picture list

Referenced by readPictureMain().

## ◆ readPrintInfo()

bool PowerPoint3Parser::readPrintInfo | ( | MWAWEntry const & | entry | ) |
| protected

try to read a print info zone

Referenced by createZones().

## ◆ readRuler()

bool PowerPoint3Parser::readRuler | ( | MWAWEntry const & | entry,
|  | int | id
| ) |  |
| protected

try to read some ruler

Referenced by createZones().

## ◆ readScheme()

bool PowerPoint3Parser::readScheme | ( | MWAWEntry const & | entry,
|  | int | id
| ) |  |
| protected

try to read a scheme

Referenced by createZones().

## ◆ readSlide()

bool PowerPoint3Parser::readSlide | ( | MWAWEntry const & | entry,
|  | PowerPoint3ParserInternal::Slide & | slide,
|  | int | zId
| ) |  |
| protected

try to read a slide main zone

Referenced by createZones().

## ◆ readSlideContent()

bool PowerPoint3Parser::readSlideContent | ( | MWAWEntry const & | entry,
|  | PowerPoint3ParserInternal::SlideContent & | slide
| ) |  |
| protected

try to read the second/third child of slideMain: main, master ?

Referenced by readSlide().

## ◆ readSlideFormats()

bool PowerPoint3Parser::readSlideFormats | ( | MWAWEntry const & | entry,
|  | std::vector< PowerPoint3ParserInternal::SlideFormat > & | formatList
| ) |  |
| protected

try to read the second child of slide content which contains some shadow offset...

Referenced by readSlideContent().

## ◆ readSlidePolygons()

bool PowerPoint3Parser::readSlidePolygons | ( | MWAWEntry const & | entry,
|  | std::vector< PowerPoint3ParserInternal::Polygon > & | polyList
| ) |  |
| protected

try to read the third child of slide content

Referenced by readSlideContent().

## ◆ readSlidesList()

bool PowerPoint3Parser::readSlidesList | ( | MWAWEntry const & | entry | ) |
| protected

try to read the first child of docRoot

Referenced by readDocRoot().

## ◆ readSlideTransition()

bool PowerPoint3Parser::readSlideTransition | ( | MWAWEntry const & | entry | ) |
| protected

try to read the first child of slideMain

Referenced by readSlide().

## ◆ readStructList()

bool PowerPoint3Parser::readStructList | ( | MWAWEntry const & | entry,
|  | PowerPoint3ParserInternal::FieldParser & | parser
| ) |  |
| protected

try to read a list of structure

Referenced by createZones(), and readPictureMain().

## ◆ readTextZone()

bool PowerPoint3Parser::readTextZone | ( | MWAWEntry const & | entry,
|  | PowerPoint3ParserInternal::SlideContent & | content
| ) |  |
| protected

try to read a text zone

Referenced by readSlideContent().

## ◆ readZone10()

bool PowerPoint3Parser::readZone10 | ( | MWAWEntry const & | entry | ) |
| protected

try to read the 10th zone

Referenced by createZones().

## ◆ readZone9()

bool PowerPoint3Parser::readZone9 | ( | MWAWEntry const & | entry | ) |
| protected

try to read the 9th zone

Referenced by createZones().

## ◆ sendFrame()

bool PowerPoint3Parser::sendFrame | ( | PowerPoint3ParserInternal::Frame const & | frame,
|  | PowerPoint3ParserInternal::SlideContent const & | content,
|  | bool | master,
|  | std::set< int > & | seen
| ) |  |
| protected

try to send a frame zone

Referenced by sendSlide().

## ◆ sendSlide()

bool PowerPoint3Parser::sendSlide | ( | PowerPoint3ParserInternal::SlideContent const & | slide,
|  | bool | master
| ) |  |
| protected

try to send a slide

Referenced by sendSlides().

## ◆ sendSlides()

void PowerPoint3Parser::sendSlides | ( |  | ) |
| protected

try to send all slides

Referenced by parse().

## ◆ sendText()

bool PowerPoint3Parser::sendText | ( | PowerPoint3ParserInternal::SlideContent const & | slide,
|  | int | tId,
|  | bool | placeHolder,
|  | bool | master
| ) |  |
| protected

try to send a text zone

## Friends And Related Function Documentation

## ◆ PowerPoint3ParserInternal::SubDocument

friend class PowerPoint3ParserInternal::SubDocument
| friend

## Member Data Documentation

## ◆ m_state

std::shared_ptr<PowerPoint3ParserInternal::State> PowerPoint3Parser::m_state
| protected

the state

Referenced by checkForUnparsedZones(), checkHeader(), createDocument(), createZones(), getColor(), parse(), readColors(), readColorZone(), readDocInfo(), readDocRoot(), readFont(), readFontName(), readFontNamesList(), readFramesList(), readListZones(), readParagraph(), readPictureContent(), readPictureDefinition(), readPictureMain(), readPicturesList(), readRuler(), readScheme(), readSlide(), readSlideContent(), readSlideFormats(), readSlidePolygons(), readSlidesList(), readSlideTransition(), readStructList(), readTextZone(), sendFrame(), sendSlides(), and sendText().

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

- PowerPoint3Parser.hxx
- PowerPoint3Parser.cxx