IProgress.h

Go to the documentation of this file.

/*========================================================== */ 
// header file automatically generated by PIDGEN - DO NOT MODIFY
/*========================================================== */ 

#ifndef APP_IPROGRESS_H
#define APP_IPROGRESS_H

#include <support/IInterface.h>
#include <support/Binder.h>
#include <support/Context.h>
#include <support/String.h>

/*
 * Copyright (c) 2005 Palmsource, Inc.
 * 
 * This software is licensed as described in the file LICENSE, which
 * you should have received as part of this distribution. The terms
 * are also available at http://www.openbinder.org/license.html.
 * 
 * This software consists of voluntary contributions made by many
 * individuals. For the exact contribution history, see the revision
 * history and logs, available at http://www.openbinder.org
 */

/* ============= Interface Class Declarations =========================== */

#if _SUPPORTS_NAMESPACE
namespace palmos {
namespace app {
using namespace palmos::support;
#endif /* _SUPPORTS_NAMESPACE */

class IProgress : public IInterface
{
public:
    B_DECLARE_META_INTERFACE(Progress)
    
    
    /* ------- Properties --------------------- */
    
    
    virtual float                   Progress() const = 0;
    virtual void                    SetProgress(float value) = 0;
    
    virtual SString                 Note() const = 0;
    virtual void                    SetNote(const SString& value) = 0;
    
    virtual bool                    IsCanceled() const = 0;
    
    /* ------- Methods ------------------------ */
    
    virtual void                    Finish(status_t err) = 0;
    
    /* ------- inline helpers ------------------------- */
    status_t LinkProgress(const sptr<IBinder>& to, const SValue& mappings, uint32_t flags = 0)
    {
        return AsBinder()->Link(to, mappings, flags);
    }
    status_t UnlinkProgress(const sptr<IBinder>& to, const SValue& mappings, uint32_t flags = 0)
    {
        return AsBinder()->Unlink(to, mappings, flags);
    }

protected:
                                    IProgress() { }
    virtual                         ~IProgress();

private:
    /* ------- copy/assignment protection ------------------ */
                                    IProgress(const IProgress& o);
            IProgress&              operator=(const IProgress& o);
};


/* ============= Local Class Declarations =============================== */

class BnProgress : public IProgress, public BBinder
{
public:
    virtual SValue                  Inspect(const sptr<IBinder>& caller, const SValue& which, uint32_t flags = 0);
    virtual sptr<IInterface>        InterfaceFor(const SValue& descriptor, uint32_t flags = 0);
    
    /* ------- Push Properties ---------------- */
public:
            void                    PushProgress(float value);
            void                    PushNote(const SString& value);
            void                    PushIsCanceled(bool value);

protected:
                                    BnProgress();
                                    BnProgress(const SContext& context);
    virtual                         ~BnProgress();
    
    virtual sptr<IBinder>           AsBinderImpl();
    virtual sptr<const IBinder>     AsBinderImpl() const;
    
    /* ------- Marshalling Details ------------ */
    virtual status_t                HandleEffect(const SValue &, const SValue &, const SValue &, SValue *);
    virtual status_t                Transact(uint32_t code, SParcel& data, SParcel* reply, uint32_t flags);

private:
                                    BnProgress(const BnProgress& o);
            BnProgress&             operator=(const BnProgress& o);
};


#if _SUPPORTS_NAMESPACE
} } // namespace palmos::app
#endif /* _SUPPORTS_NAMESPACE */


// namespace palmos::app

#endif // APP_IPROGRESS_H

---

Generated on Wed Dec 28 22:33:27 2005 by Doxygen 1.4.4 for OpenBinder Documentation Version 1.0

PalmSource, Inc. © 2005