class CCL::DocumentFilter

Overview

#include <documentfilter.h>

class DocumentFilter:
    public CCL::Unknown,
    public CCL::PluginInstance,
    public CCL::IDocumentFilter
{
public:
    // methods

    virtual int CCL_API getFlags () const;
    virtual tresult CCL_API installFile (IUrl& path) const;
    virtual tresult CCL_API canImportFile (CCL::UrlRef path) const;
    virtual tresult CCL_API showImportOptions (IDocument& document);

    virtual tresult CCL_API importDocument (
        IDocument& document,
        IProgressNotify* progress = nullptr
    );

    virtual tbool CCL_API canExportDocument (IDocument& document) const;
    virtual tresult CCL_API showExportOptions (IDocument& document);

    virtual tresult CCL_API exportDocument (
        IDocument& document,
        ExportParams& params,
        IProgressNotify* progress = nullptr
    );

    virtual tresult CCL_API finalizeDocumentExport (
        CCL::IDocument& document,
        ExportParams& params
    );

    virtual tbool CCL_API canMergeDocuments (IDocument& target, UrlRef sourceUrl);

    virtual tresult CCL_API mergeDocuments (
        IDocument& target,
        IDocument& source,
        IProgressNotify* progress = nullptr
    );
};

Inherited Members

public:
    // typedefs

    typedef IUnknown* Token;

    // enums

    enum Flags;

    // structs

    struct ExportParams;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual void CCL_API setFactoryToken (Token token) = 0;
    virtual Token CCL_API getFactoryToken () const = 0;
    virtual void CCL_API setFactoryToken (Token token);
    virtual Token CCL_API getFactoryToken () const;
    virtual int CCL_API getFlags () const = 0;
    virtual const FileType&CCL_API getFileType () const = 0;
    virtual tresult CCL_API installFile (IUrl& path) const = 0;
    virtual tresult CCL_API canImportFile (UrlRef path) const = 0;
    virtual tresult CCL_API showImportOptions (IDocument& document) = 0;

    virtual tresult CCL_API importDocument (
        IDocument& document,
        IProgressNotify* progress = nullptr
    ) = 0;

    virtual tbool CCL_API canExportDocument (IDocument& document) const = 0;
    virtual tresult CCL_API showExportOptions (IDocument& document) = 0;

    virtual tresult CCL_API exportDocument (
        IDocument& document,
        ExportParams& params,
        IProgressNotify* progress = nullptr
    ) = 0;

    virtual tresult CCL_API finalizeDocumentExport (
        IDocument& document,
        ExportParams& params
    ) = 0;

    virtual tbool CCL_API canMergeDocuments (IDocument& target, UrlRef sourceUrl) = 0;

    virtual tresult CCL_API mergeDocuments (
        IDocument& target,
        IDocument& source,
        IProgressNotify* progress = nullptr
    ) = 0;

Detailed Documentation

Methods

virtual int CCL_API getFlags () const

Get filter capability flags.

virtual tresult CCL_API installFile (IUrl& path) const

Install document to location determined by filter (optional).

This might move or copy the document file before it’s being imported.

virtual tresult CCL_API canImportFile (CCL::UrlRef path) const

Check if given document can be imported.

virtual tresult CCL_API showImportOptions (IDocument& document)

Show options before import (optional).

virtual tresult CCL_API importDocument (
    IDocument& document,
    IProgressNotify* progress = nullptr
)

Import document.

virtual tbool CCL_API canExportDocument (IDocument& document) const

Check if given document can be exported.

virtual tresult CCL_API showExportOptions (IDocument& document)

Show options before export (optional).

virtual tresult CCL_API exportDocument (
    IDocument& document,
    ExportParams& params,
    IProgressNotify* progress = nullptr
)

Export document.

virtual tresult CCL_API finalizeDocumentExport (
    CCL::IDocument& document,
    ExportParams& params
)

Post process the exported document (optional)

virtual tbool CCL_API canMergeDocuments (IDocument& target, UrlRef sourceUrl)

Check if given documents can be merged.

virtual tresult CCL_API mergeDocuments (
    IDocument& target,
    IDocument& source,
    IProgressNotify* progress = nullptr
)

Merge documents.

Source is not loaded so far…