SFBBacklight

Wrapper Class for the IBacklight interface.

#include <SFBBacklight.h.hpp>

class SFBBacklight : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBBacklight)

Inheritance diagram

Version

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

Reference

BREW API IBacklight

Member

Public Functions
`SFCError`	Disable( `Void` ) Turn back light off.
`SFCError`	Enable( `Void` ) Turn back light on.
`SFCError`	GetBacklightInfo( `AEEBacklightInfo *` backlightInfo ) Provide information about various parameters associated with the back light.
`SFCError`	GetBrightnessLevel( `UInt32Ptr` brightnessLevel ) Provide information about the current brightness level of the back light.
`Bool`	IsEnabled( `Void` ) Check if back light is on.
static `SFBBacklightSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new instance of SFBBacklight class.
static `SFBBacklightSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new instance of SFBBacklight class.
`SFCError`	SetBrightnessLevel( `UInt32` brightnessLevel ) Set the brightness level of the back light.
`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 a specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for a specified ClassID's interface using the SFBQuery instance.

SFBBacklight::Disable

Turn back light off.

[ public ]
SFCError Disable(Void);

Return value

SUCCESS － If successful
Error Code - Otherwise

Reference

BREW API IBACKLIGHT_Disable

SFBBacklight::Enable

Turn back light on.

[ public ]
SFCError Enable(Void);

Return value

SUCCESS － If successful
Error Code - Otherwise

Reference

BREW API IBACKLIGHT_Enable

SFBBacklight::GetBacklightInfo

Provide information about various parameters associated with the back light.

[ public ]
SFCError GetBacklightInfo(
    AEEBacklightInfo * backlightInfo   // Pointer to back light information structure
);

Return value

SUCCESS － If successful
Error Code - Otherwise

Reference

BREW API IBACKLIGHT_GetBacklightInfo

SFBBacklight::GetBrightnessLevel

Provide information about the current brightness level of the back light.

[ public ]
SFCError GetBrightnessLevel(
    UInt32Ptr brightnessLevel   // Pointer to brightness level  
);

Return value

SUCCESS － If successful
Error Code - Otherwise

Reference

BREW API IBACKLIGHT_GetBrightnessLevel | SFBBacklight::SetBrightnessLevel

SFBBacklight::IsEnabled

Check if back light is on.

[ public ]
Bool IsEnabled(Void);

Return value

TRUE － If back light is on
FALSE - Otherwise

Reference

BREW API IBACKLIGHT_IsEnabled | SFBBacklight::Enable | SFBBacklight::Disable

SFBBacklight::NewInstance

Create a new instance of SFBBacklight class.

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

[ public, static ]
SFBBacklightSmp NewInstance(
    AEECLSID id                    // classID 
    SFCErrorPtr exception = null   // Error
);

SFBBacklight::SetBrightnessLevel

Set the brightness level of the back light.

[ public ]
SFCError SetBrightnessLevel(
    UInt32 brightnessLevel   // Brightness Level  
);

Return value

SUCCESS － If successful
Error Code - Otherwise

Reference

BREW API IBACKLIGHT_SetBrightnessLevel | SFBBacklight::GetBrightnessLevel