SFBFlip

Wrapper Class for the IFlip interface.

#include <SFBFlip.h.hpp>

class SFBFlip : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBFlip)

Inheritance diagram

Version

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

Reference

BREW API IFlip

Member

Public Functions
`SFCError`	GetDisplayList( `AEECLSID *` clslist , `SInt16Ptr` count ) Retrieve the display class IDs of the displays accessible to user based on the current positions of all flips.
`SFCError`	GetFlipIDList( `AEEFlipInfo *` infolist , `SInt16Ptr` count ) This function retrieves the flip IDs of the flips present on the device.
`SFCError`	GetFlipInfoEx( `AEEFlipInfoEx *` infoEx ) Retrieve the information about the specified flip in the AEEFlipInfox structure.
`SFCError`	GetFlipPosition( `AEEFlipInfo *` info ) This function returns the current position of the specified flip.
`SFCError`	GetKeyList( `AVKType *` keylist , `SInt16Ptr` count ) Retrieve the key codes of the keys accessible to user based on the current positions of all flips.
`SFCError`	GetMaxFlipPosition( `AEEFlipInfo *` info ) Return the maximum position that the specified flip can take, that is, the position of the flip when it is fully open.
`SFCError`	GetMinFlipPosition( `AEEFlipInfo *` info ) Return the minimum position that the specified flip can take, that is, the position of the flip when it is fully closed.
`SFCError`	GetParm( `AEEFlipInfo *` info , `SInt16` parmID , `SInt32Ptr` p1 , `SInt32Ptr` p2 ) Get the flip parameter information. The flip parameter should be specified in the nParmID argument.
`SFCError`	IsSupport( `AEEFlipInfo *` info , `SInt16` parmID , `BoolPtr` support ) Check if specified flip parameter (FLIP_PARM_XXX) is supported by IFlip Interface.
static `SFBFlipSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBFlip instance.
static `SFBFlipSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBFlip instance.
`SFCError`	SetParm( `AEEFlipInfo *` info , `SInt16` parmID , `SInt32` p1 , `SInt32` p2 ) Set the flip parameter information.
`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.

SFBFlip::GetDisplayList

Retrieve the display class IDs of the displays accessible to user based on the current positions of all flips.

[ public ]
SFCError GetDisplayList(
    AEECLSID * clslist   // Pointer to the array of AEECLSID. Can be NULL.
    SInt16Ptr count      // Caller indicates the size of the array of AEECLSID passed in via ClsList.
);

Argument

clslist: If the function returns SUCCESS, and ClsList is not NULL, it contains the display class IDs of the displays accessible
count: If the function returns SUCCESS, this parameter contains the number of displays accessible.

Return value

SUCCESS: if successful.
EBADPARM: invalid parameter.
EBUFFERTOOSMALL: buffer specified by caller is too small.
EFAILED: other failure.

Description

See IDisplay interface documentation for various display class IDs.

Reference

BREW API IFLIP_GetDisplayList | SFBDisplay

SFBFlip::GetFlipIDList

This function retrieves the flip IDs of the flips present on the device.

[ public ]
SFCError GetFlipIDList(
    AEEFlipInfo * infolist   // Pointer to the array of AEEFlipInfo structures. Can be NULL.
    SInt16Ptr count          // Caller indicates the size of the array of AEEFlipInfo structures passed in via InfoList. 
);

Argument

infolist: If the function returns SUCCESS, and InfoList is not NULL, it contains the flip IDs of the flips present on the device.
count: If the function returns SUCCESS (or) EBUFFERTOOSMALL, pnCount contains the number of flips on the device, and is always a non-zero, positive number.

Return value

SUCCESS: if successful.
EBADPARM: invalid argument.
EFAILED: other failure.
EBUFFERTOOSMALL: if the array size of pFlipInfoList passed in is smaller than the number of flips present on the device.

Reference

BREW API IFLIP_GetFlipIDList

SFBFlip::GetFlipInfoEx

Retrieve the information about the specified flip in the AEEFlipInfox structure.

[ public ]
SFCError GetFlipInfoEx(
    AEEFlipInfoEx * infoEx   // Pointer to the AEEFlipInfoEx structure
);

Return value

SUCCESS: if successful.
EBADPARM: invalid argument.
EFAILED: other failure.
EVERSIONNOTSUPPORT: if the supplied wStructSize is not supported.

Reference

BREW API IFLIP_GetFlipInfoEx

SFBFlip::GetFlipPosition

This function returns the current position of the specified flip.

[ public ]
SFCError GetFlipPosition(
    AEEFlipInfo * info   // Pointer to the AEEFlipInfo structure. Caller fills in the flip ID field
);

Return value

SUCCESS: if successful.
EBADPARM: invalid argument.
EUNSUPPORTED: if the flip ID is invalid.
EFAILED: other failure.

Reference

BREW API IFLIP_GetFlipPosition

SFBFlip::GetKeyList

Retrieve the key codes of the keys accessible to user based on the current positions of all flips.

[ public ]
SFCError GetKeyList(
    AVKType * keylist   // Pointer to the array of AVKType. Can be NULL
    SInt16Ptr count     // Caller indicates the size of the array of AVKType passed in via KeyList
);

Argument

keylist: If the function returns SUCCESS, and KeyList is not NULL, it contains the key codes of the keys accessible based on current position of the specified flip.
count: If the function returns SUCCESS (or)EBUFFERTOOSMALL, this argument contains the number of keys accessible based on current position of the specified flip.

Return value

SUCCESS: if successful.
EBADPARM: invalid argument.
EBUFFERTOOSMALL: buffer specified by caller is too small.
EFAILED: other failure.

Description

See AEEVcodes.h for the complete key code enumeration.

Reference

BREW API IFLIP_GetKeyList

SFBFlip::GetMaxFlipPosition

Return the maximum position that the specified flip can take, that is, the position of the flip when it is fully open.

[ public ]
SFCError GetMaxFlipPosition(
    AEEFlipInfo * info   // Pointer to the AEEFlipInfo structure. Caller fills in the flip ID field. 
);

Return value

SUCCESS: if successful.
EBADPARM: invalid argument.
EUNSUPPORTED: if the flip ID is invalid.
EFAILED: other failure.

Reference

BREW API IFLIP_GetMaxFlipPosition

SFBFlip::GetMinFlipPosition

Return the minimum position that the specified flip can take, that is, the position of the flip when it is fully closed.

[ public ]
SFCError GetMinFlipPosition(
    AEEFlipInfo * info   // Pointer to the AEEFlipInfo structure. Caller fills in the flip ID field. 
);

Return value

SUCCESS: if successful.
EBADPARM: invalid argument.
EUNSUPPORTED: if the flip ID is invalid.
EFAILED: other failure.

Reference

BREW API IFLIP_GetMinFlipPosition

SFBFlip::GetParm

Get the flip parameter information. The flip parameter should be specified in the nParmID argument.

[ public ]
SFCError GetParm(
    AEEFlipInfo * info   // Pointer to the AEEFlipInfo structure. Caller fills in the flip ID field 
    SInt16 parmID        // FLIP_PARM_XXX. See Flip Parameters 
    SInt32Ptr p1         // Depends on nParmID
    SInt32Ptr p2         // Depends on nParmID
);

Return value

SUCCESS: Successful.
EBADPARM: Bad parm (in function argument). Non-NULL pFlipInfo where NULL was expected.
EUNSUPPORTED: IFLIP_GetParm not supported for this nParmID (or) flip ID is invalid (or) nParmID is not supported by the class.
EBUFFERTOOSMALL: Buffer specified by caller is too small.
EFAILED: General failure.

Reference

BREW API IFLIP_GetParm | BREW API FLIP_PARM_

SFBFlip::IsSupport

Check if specified flip parameter (FLIP_PARM_XXX) is supported by IFlip Interface.

[ public ]
SFCError IsSupport(
    AEEFlipInfo * info   // Pointer to the AEEFlipInfo structure. Caller fills in the flip ID field
    SInt16 parmID        // FLIP_PARM_XXX. See Flip Parameters
    BoolPtr support      // Pointer to boolean. TRUE/FALSE => Supported/Unsupported
);

Return value

SUCCESS: Successful.
EBADPARM: Bad parm (in function argument). Non-NULL pFlipInfo where NULL was expected.
EUNSUPPORTED: Invalid Flip ID in pFlipInfo (if pFlipInfo is not NULL).
EFAILED: General failure.

Reference

BREW API IFLIP_IsSupport

SFBFlip::NewInstance

Create a new SFBFlip instance.

[ public, static ]
SFBFlipSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

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

SFBFlip::SetParm

Set the flip parameter information.

[ public ]
SFCError SetParm(
    AEEFlipInfo * info   // Pointer to the AEEFlipInfo structure. Caller fills in the flip ID field
    SInt16 parmID        // FLIP_PARM_XXX. See Flip Parameters
    SInt32 p1            // Depends on nParmID
    SInt32 p2            // Depends on nParmID
);

Return value

SUCCESS: Successful.
EBADPARM: Bad parm (in function argument). Non-NULL pFlipInfo where NULL was expected.
IFLIP_SetParm not supported for this nParmID (or) flip ID is invalid (or) nParmID is not supported by the class.
EFAILED: General failure.

Reference

BREW API IFLIP_SetParm