WPDocument Class Reference

#include <WPDocument.h>

List of all members.


Detailed Description

This class provides all the functions an application would need to parse WordPerfect documents.

Static Public Member Functions

static WPDConfidence isFileFormatSupported (WPXInputStream *input)
 Analyzes the content of an input stream to see if it can be parsed.
static WPDPasswordMatch verifyPassword (WPXInputStream *input, const char *password)
 Checks whether the given password was used to encrypt the document.
static WPDResult parse (WPXInputStream *input, WPXDocumentInterface *documentInterface, const char *password)
 Parses the input stream content.
static WPDResult parseSubDocument (WPXInputStream *input, WPXDocumentInterface *documentInterface, WPDFileFormat fileFormat)

Member Function Documentation

WPDConfidence WPDocument::isFileFormatSupported ( WPXInputStream input  )  [static]

Analyzes the content of an input stream to see if it can be parsed.

Parameters:
input The input stream
Returns:
A confidence value which represents the likelyhood that the content from the input stream can be parsed

WPDPasswordMatch WPDocument::verifyPassword ( WPXInputStream input,
const char *  password 
) [static]

Checks whether the given password was used to encrypt the document.

Parameters:
input The input stream
password The password used to protect the document or NULL if the document is not protected
Returns:
A value which indicates between the given password and the password that was used to protect the document

WPDResult WPDocument::parse ( WPXInputStream input,
WPXDocumentInterface documentInterface,
const char *  password 
) [static]

Parses the input stream content.

It will make callbacks to the functions provided by a WPXDocumentInterface class implementation when needed. This is often commonly called the 'main parsing routine'.

Parameters:
input The input stream
documentInterface A WPXDocumentInterface implementation
password The password used to protect the document or NULL if the document is not protected
Returns:
A value that indicates whether the conversion was successful and in case it was not, it indicates the reason of the error

WPDResult WPDocument::parseSubDocument ( WPXInputStream input,
WPXDocumentInterface documentInterface,
WPDFileFormat  fileFormat 
) [static]


The documentation for this class was generated from the following files:
Generated on Sun Nov 21 10:48:13 2010 for libwpd by doxygen 1.5.4