SFBBitmapDev2

Wrapper Class for the IBitmapDev2 interface.

#include <SFBBitmapDev2.h.hpp>

class SFBBitmapDev2 : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBBitmapDev2)

Inheritance diagram

Version

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

Reference

BREW API IBitmapDev2

Member

Public Functions
`Bool`	IsEnabled( `Void` ) Query the enabled state of the bitmap.
static `SFBBitmapDev2Smp`	NewInstance( `SFBBitmapSmpConstRef` bitmap , `SFCErrorPtr` exception = null ) Create a new SFBBitmapDev2 instance.
static `SFBBitmapDev2Smp`	NewInstance( `SFBBitmapSmpConstRef` bitmap , `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBBitmapDev2 instance.
`SInt32`	NotifyEnable( `SFXCallbackPtr` callback ) Register for a notification of a change to the bitmap's enabled state.
`SFCError`	SetPrefs( `ACharConstPtr` settings , `SInt32` length ) Change settings for a device bitmap. It is used to implement SFBDisplay::SetPrefs().
`SFCError`	SetPrefs( `SFXAnsiStringConstRef` settings , `SInt32` length ) Change settings for a device bitmap. It is used to implement SFBDisplay::SetPrefs().
`SFCError`	Update( `Void` ) Copy the bitmap to its associated display synchronously.
`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.

SFBBitmapDev2::IsEnabled

Query the enabled state of the bitmap.

[ public ]
Bool IsEnabled(Void);

Return value

TRUE: if this bitmap is enabled.
FALSE: otherwise.

Description

While the bitmap is disabled, no drawing operations are allowed. IBitmap drawing functions will have no effect. If an application has direct access to the bitmap's pixel buffer through IDIB, it is important that the app refrain from modifying the pixel buffer while the bitmap is disabled.

Reference

BREW API IBitmapDev2_IsEnabled()

SFBBitmapDev2::NewInstance

Create a new SFBBitmapDev2 instance.

[ public, static ]
SFBBitmapDev2Smp NewInstance(
    SFBBitmapSmpConstRef bitmap    // bitmap
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBBitmapDev2Smp NewInstance(
    SFBBitmapSmpConstRef bitmap    // bitmap
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBBitmapDev2::NotifyEnable

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

Return value

SUCCESS: if function executed correctly.
EBADPARM: if pcb is NULL.

Other error codes may be returned depending on the implementation.

Reference

BREW API IBITMAPDEV2_NotifyEnable

SFBBitmapDev2::SetPrefs

Change settings for a device bitmap. It is used to implement SFBDisplay::SetPrefs().

[ public ]
SFCError SetPrefs(
    ACharConstPtr settings   // String representing settings. 
    SInt32 length            // String length in characters. 
);

[ public ]
SFCError SetPrefs(
    SFXAnsiStringConstRef settings   // String representing settings. 
    SInt32 length                    // String length in characters. 
);

Return value

AEE_SUCCESS: if function executed correctly.
AEE_EUNSUPPORTED: if this bitmap does not support preferences.

Reference

BREW API IBitmapDev2_SetPrefs

SFBBitmapDev2::Update

Copy the bitmap to its associated display synchronously.

[ public ]
SFCError Update(Void);

Return value

SUCCESS: if functiona executed correctly.

Other error codes may be returned depending on the implementation.

Reference

BREW API IBITMAPDEV2_Update