IFD/IFD_IPRData.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        IFD_IPRData.h ( IFD Library, C++)
 *
 * COMMENTS:    Data associated with an IFD_IPRTree.  This is data which is
 *              specific to the renderer.  The class can hold things like the
 *              cache filename, a file descriptor to a pipe, parameters to
 *              control the cache.  All sorts of stuff.
 */

#ifndef __IFD_IPRData__
#define __IFD_IPRData__

#include "IFD_API.h"

class IFD_IPRTree;
class IFD_StreamEvent;

class IFD_API IFD_IPRData {
public:
             IFD_IPRData();
    virtual ~IFD_IPRData();

    virtual const char  *className() const = 0;

    // If the startRender() or finishRender() methods return false, then the
    // render was considered to have an error.
    virtual bool         startRender();
    virtual bool         finishRender(int status);

    // Some renders (i.e. irma) require the stream to be left open at the
    // conclusion of the render.  If this is the case, this method is called
    // after the stream is sent to the renderer.  status is the success code so
    // far.
    virtual bool         leaveStreamOpen(int status) const;

    // The stream events are passed down from the IPR tree.  The sub-class
    // doesn't have to indicate interest in the events.  They are just here for
    // convenience.
    virtual void         handleStreamEvent(IFD_IPRTree &tree,
                                            IFD_StreamEvent &event);
};

#endif

---