SFBKeysMapping

Wrapper Class for the IKeysMapping interface.

#include <SFBKeysMapping.h.hpp>

class SFBKeysMapping : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBKeysMapping)

Inheritance diagram

Version

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

Reference

BREW API IKeysMapping

Member

Public Functions
`SFCError`	GetMapping( `UInt16` keycode , `UInt32` modifiers , `WCharPtr` mapping ) Return the mapping of the an AVK code and modifier combination to the intended character.
static `SFBKeysMappingSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBKeysMapping instance.
static `SFBKeysMappingSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBKeysMapping instance.
`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.

SFBKeysMapping::GetMapping

Return the mapping of the an AVK code and modifier combination to the intended character.

[ public ]
SFCError GetMapping(
    UInt16 keycode     // the key virtual code for which mapping is desired
    UInt32 modifiers   // a bit mask of modifiers for which the mapping is desired (such as KB_LSHIFT) See AEEVCodes.h for a complete list of modifiers
    WCharPtr mapping   // on return, is set to the unicode value of the mapping for avk + modifiers
);

Reference

BREW API IKeysMapping_GetMapping

SFBKeysMapping::NewInstance

Create a new SFBKeysMapping instance.

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

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