SFBControl

Wrapper Class for the IControl interface.

#include <SFBControl.h.hpp>

class SFBControl : public SFBBase;

SFMTYPEDEFWRAPPER(SFBControl)

Inheritance diagram

Version

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

Reference

BREW API IControl

Member

Public Functions
`UInt32`	GetProperties( `Void` ) Return the control-specific properties or flags.
`Void`	GetRect( `SFXRectanglePtr` rect ) Get the rectangle of the control.
`SFXRectangle`	GetRect( `Void` ) Get the rectangle of the control.
`Bool`	HandleEvent( `AEEEvent` event , `UInt16` wParam , `UInt32` dwParam ) Pass events to a control. The BREW controls process various events to allow a device user to enter a text, time, or date value or choose an item from a menu. Refer to the descriptions of each control for the events it handles. Your applet must pass a control all of the events, unless the control is part of a dialog. Below is an example of an application passing all of the events to the controls of the application.
`Bool`	HandleEvent( `SFXEventConstRef` event ) Pass events to a control. The BREW controls process various events to allow a device user to enter a text, time, or date value or choose an item from a menu. Refer to the descriptions of each control for the events it handles. Your applet must pass a control all of the events, unless the control is part of a dialog. Below is an example of an application passing all of the events to the controls of the application.
`Bool`	IsActive( `Void` ) Return the active or focus state of the control.
`Bool`	Redraw( `Void` ) Instruct the control to redraw its contents.
`Void`	Reset( `Void` ) Instruct the control to reset (free/delete) its contents and to immediately leave active/focus mode.
`Void`	SetActive( `Bool` active = true ) Instruct the control to enter/leave focus or selected mode.
`Void`	SetProperties( `UInt32` properties ) Set control-specific properties or flags.
`Void`	SetRect( `SFXRectangleConstRef` rect ) Set the active screen coordinates of the control. This may result in the control redrawing its contents.

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.

SFBControl::GetProperties

Return the control-specific properties or flags.

[ public ]
UInt32 GetProperties(Void);

Reference

SFBControl::SetProperties

SFBControl::GetRect

Get the rectangle of the control.

[ public ]
Void GetRect(
    SFXRectanglePtr rect   // rectangle to be filled with the coordinates of the control
);

[ public ]
SFXRectangle GetRect(Void);

Reference

BREW API ICONTROL_GetRect | SFBControl::SetRect

SFBControl::HandleEvent

Pass events to a control. The BREW controls process various events to allow a device user to enter a text, time, or date value or choose an item from a menu. Refer to the descriptions of each control for the events it handles. Your applet must pass a control all of the events, unless the control is part of a dialog. Below is an example of an application passing all of the events to the controls of the application.

[ public ]
Bool HandleEvent(
    AEEEvent event   // event code
    UInt16 wParam    // 16-bit event data
    UInt32 dwParam   // 32-bit event data
);

[ public ]
Bool HandleEvent(
    SFXEventConstRef event   // event code
);

Reference

BREW API ICONTROL_HandleEvent

SFBControl::IsActive

Return the active or focus state of the control.

[ public ]
Bool IsActive(Void);

Reference

BREW API ICONTROL_IsActive

SFBControl::Redraw

Instruct the control to redraw its contents.

[ public ]
Bool Redraw(Void);

Reference

BREW API ICONTROL_Redraw | SFBControl::SetActive

SFBControl::Reset

Instruct the control to reset (free/delete) its contents and to immediately leave active/focus mode.

[ public ]
Void Reset(Void);

Description

Instruct the control to reset (free/delete) its contents and to immediately leave active/focus mode. This is useful in freeing all underlying memory in text or menu controls or removing all items in a single call.

Reference

BREW API ICONTROL_Reset | SFBControl::SetActive

SFBControl::SetActive

Instruct the control to enter/leave focus or selected mode.

[ public ]
Void SetActive(
    Bool active = true   // specifies whether to activate (true) or deactivate (false) the control
);

Reference

BREW API ICONTROL_SetActive

SFBControl::SetProperties

Set control-specific properties or flags.

[ public ]
Void SetProperties(
    UInt32 properties   // 32-bit set of flags/properties
);

Reference

BREW API ICONTROL_SetProperties | SFBControl::GetProperties

SFBControl::SetRect

Set the active screen coordinates of the control. This may result in the control redrawing its contents.

[ public ]
Void SetRect(
    SFXRectangleConstRef rect   // the bounding rectangle for the control
);

Reference

BREW API ICONTROL_SetRect | AEERect | SFBControl::GetRect