libwpd: WPDocument Class Reference documentation

Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

# 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, bool partialContent)
| Analyzes the content of an input stream to see if it can be parsed.
static WPDResult | parse (WPXInputStream *input, WPXHLListenerImpl *listenerImpl)
| Parses the input stream content.

## Member Function Documentation

WPDConfidence WPDocument::isFileFormatSupported | ( | WPXInputStream * | input,
|  | bool | partialContent
| ) | `[static]`

  | Analyzes the content of an input stream to see if it can be parsed. Parameters:
  | input | The input stream
  | partialContent | A boolean which states if the content from the input stream represents the full contents of a WordPerfect file, or just the first X bytes
Returns: A confidence value which represents the likelyhood that the content from the input stream can be parsed

WPDResult WPDocument::parse | ( | WPXInputStream * | input,
|  | WPXHLListenerImpl * | listenerImpl
| ) | `[static]`

  | Parses the input stream content. It will make callbacks to the functions provided by a WPXHLListenerImpl class implementation when needed. This is often commonly called the 'main parsing routine'. Parameters:
  | input | The input stream
  | listenerImpl | A WPXListener implementation

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

- WPDocument.h
- WPDocument.cpp