IIterator.h

Go to the documentation of this file.

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

#ifndef SUPPORT_IITERATOR_H
#define SUPPORT_IITERATOR_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 support {
#endif /* _SUPPORTS_NAMESPACE */


class IIterator : public IInterface
{
public:
    B_DECLARE_META_INTERFACE(Iterator)
    
    
    /* ------- Typedefs --------------------- */
    typedef SVector<SValue> ValueList;
    
    /* ------- enums/structs --------------------- */
    enum  {
        BINDER_IPC_LIMIT=0x05
    };
    

    enum  {

        REQUEST_DATA=0x1000,

        COLLAPSE_NODE=0x2000,
        COLLAPSE_CATALOG=0x2000,

        IGNORE_PROJECTION=0x4000
    };
    
    
    /* ------- Properties --------------------- */
    

    virtual SValue                  Options() const = 0;
    
    /* ------- Methods ------------------------ */
    

    virtual status_t                Next(ValueList* keys, ValueList* values, uint32_t flags, size_t count = 0) = 0;
    
    /* ------- Events ------------------------ */
    
    /* ------- inline helpers ------------------------- */
    status_t LinkIterator(const sptr<IBinder>& to, const SValue& mappings, uint32_t flags = 0)
    {
        return AsBinder()->Link(to, mappings, flags);
    }
    status_t UnlinkIterator(const sptr<IBinder>& to, const SValue& mappings, uint32_t flags = 0)
    {
        return AsBinder()->Unlink(to, mappings, flags);
    }

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

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


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

class BnIterator : public IIterator, 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);
    
    /* ------- Events ------------------------- */
public:

            void                    PushIteratorChanged(const sptr<IIterator>& it);
    
    /* ------- Push Properties ---------------- */
public:
            void                    PushOptions(const SValue& value);

protected:
                                    BnIterator();
                                    BnIterator(const SContext& context);
    virtual                         ~BnIterator();
    
    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:
                                    BnIterator(const BnIterator& o);
            BnIterator&             operator=(const BnIterator& o);
};


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


// namespace palmos::support

#endif // SUPPORT_IITERATOR_H

---

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

PalmSource, Inc. © 2005