SFBBitmapDev

Wrapper Class for the IBitmapDev interface.

#include <SFBBitmapDev.h.hpp>

class SFBBitmapDev : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBBitmapDev)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	O	O	O

Reference

BREW API IBitmapDev

Member

Public Functions
`Bool`	IsEnabled( `Void` ) Query the enabled state of the bitmap.
static `SFBBitmapDevSmp`	NewInstance( `SFBBitmapSmpConstRef` bmp , `SFCErrorPtr` exception = null ) Create a new SFBBitmapDev instance.
static `SFBBitmapDevSmp`	NewInstance( `SFBBitmapSmpConstRef` bitmap , `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBBitmapDev instance.
`SInt32`	NotifyEnable( `SFXCallbackPtr` callback ) Register for a notification of a change to the bitmap's enabled state. The callback will be triggered when the state of the bitmap changes either from enabled to disabled or disabled to enabled.
`SFCError`	Update( `Void` ) Copy the bitmap to its associated display synchronously. If dirty rectangle optimization is implemented, only areas of the display marked as dirty will be copied.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBBitmapDev::IsEnabled

Query the enabled state of the bitmap.

[ public ]
Bool IsEnabled(Void);

Reference

BREW API IBITMAPDEV_IsEnabled

SFBBitmapDev::NewInstance

Create a new SFBBitmapDev instance.

[ public, static ]
SFBBitmapDevSmp NewInstance(
    SFBBitmapSmpConstRef bmp       // bitmap to get the SFBBitmapDev instance
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBBitmapDevSmp NewInstance(
    SFBBitmapSmpConstRef bitmap    // bitmap to get the SFBBitmapDev instance
    AEECLSID id                    // Class ID for the IBitmapDev interface
    SFCErrorPtr exception = null   // Error
);

SFBBitmapDev::NotifyEnable

Register for a notification of a change to the bitmap's enabled state. The callback will be triggered when the state of the bitmap changes either from enabled to disabled or disabled to enabled.

[ public ]
SInt32 NotifyEnable(
    SFXCallbackPtr callback   // callback structure
);

Reference

BREW API IBITMAPDEV_NotifyEnable

SFBBitmapDev::Update

Copy the bitmap to its associated display synchronously. If dirty rectangle optimization is implemented, only areas of the display marked as dirty will be copied.

[ public ]
SFCError Update(Void);

Reference

BREW API IBITMAPDEV_Update