NAME

RTF::Reader - Base class for building RTF-processing modules

DESCRIPTION

Gives you a simple toolset for doing what you want with RTF

OVERVIEW

THIS MODULE IS AT BEST BETA, AT WORST, STILL IN 'PLANNING'. The interface may change, the docs are almost certainly slighty out of date.... The latest version of all this is in CVS - use that instead where possible. Details at http://rtf.perl.org/...

RTF::Reader is a base-class that opens up an API for you to use to convert RTF into other formats. The basic model is that you have contexts which represent places in an RTF document, for which you can define what action is taken when different types of RTF constructs are encountered.

Before starting, you should also read RTF::Reader::Context to get a better idea of how to do this.

METHODS

new

Instantiate a new object. All arguments are currently passed to the underlying RTF::Tokenizer instantiator, so you may want to read the docs for that to understand what you can do. Note that we're not a subclass of RTF::Tokenizer, we just store an RTF::Tokenizer object, which we rely on heavily.

add_events

Accepts a Hash::Diff::Dispatch object...

add_text

FIX ME

process

Having defined all your behaviours, you invoke this method to start the processing of the RTF.

AUTHOR

Peter Sergeant - pete@clueball.com

LICENSE

As Perl - artistic license.