libwps: WPSDocument Class Reference documentation

- Main Page
- Namespaces
- Classes
- Files

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# WPSDocument Class Reference

`#include <WPSDocument.h>`

List of all members.

## Detailed Description

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

## Static Public Member Functions
static WPSConfidence | isFileFormatSupported (WPSInputStream *input, bool partialContent)
| Analyzes the content of an input stream to see if it can be parsed.
static WPSResult | parse (WPSInputStream *input, WPXHLListenerImpl *listenerImpl)
| Parses the input stream content.

## Member Function Documentation

WPSConfidence WPSDocument::isFileFormatSupported | ( | WPSInputStream * | 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 MS Works 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

WPSResult WPSDocument::parse | ( | WPSInputStream * | 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 WPSContentListener implementation

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

- WPSDocument.h
- WPSDocument.cpp