struct CCL::IProgressNotify

Overview

Progress notification interface. More…

#include <iprogress.h>

struct IProgressNotify: public CCL::IUnknown
{
    // enums

    enum Flags;

    // structs

    struct State;

    // methods

    virtual void CCL_API setTitle (StringRef title) = 0;
    virtual void CCL_API setCancelEnabled (tbool state) = 0;
    virtual void CCL_API beginProgress () = 0;
    virtual void CCL_API endProgress () = 0;
    virtual IProgressNotify*CCL_API createSubProgress () = 0;
    virtual void CCL_API setProgressText (StringRef text) = 0;
    virtual void CCL_API updateProgress (const State& state) = 0;
    virtual tbool CCL_API isCanceled () = 0;
    IProgressNotify void updateAnimated ();
    void updateAnimated (StringRef text, bool important = false);
};

Inherited Members

public:
    // 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;

Detailed Documentation

Progress notification interface.

<>

Methods

virtual void CCL_API setTitle (StringRef title) = 0

Set progress title.

virtual void CCL_API setCancelEnabled (tbool state) = 0

Enable/disable cancellation by user.

virtual void CCL_API beginProgress () = 0

Begin progression.

virtual void CCL_API endProgress () = 0

End progression.

virtual IProgressNotify*CCL_API createSubProgress () = 0

Creates a sub-step progress, must be released by caller.

virtual void CCL_API setProgressText (StringRef text) = 0

Update progress text.

virtual void CCL_API updateProgress (const State& state) = 0

Update progress.

virtual tbool CCL_API isCanceled () = 0

Check if canceled by user.