SFBImageCtl

Wrapper Class for the IImageCtl interface.

#include <SFBImageCtl.h.hpp>

class SFBImageCtl : public SFBControl;

SFMTYPEDEFWRAPPER(SFBImageCtl)

Inheritance diagram

Version

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

Reference

BREW API IImageCtl

Member

Public Functions
static `SFBImageCtlSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBImageCtl instance.
static `SFBImageCtlSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBImageCtl instance.
`Void`	SetImage( `SFBImageSmpConstRef` image ) Set the image.
`Void`	SetRedraw( `PFNNOTIFY` notify , `VoidPtr` data = null ) This method sets the redraw call back for the image set in image control.
`UInt32`	GetProperties( `Void` ) (inherits from SFBControl) Return the control-specific properties or flags.
`Void`	GetRect( `SFXRectanglePtr` rect ) (inherits from SFBControl) Get the rectangle of the control.
`SFXRectangle`	GetRect( `Void` ) (inherits from SFBControl) Get the rectangle of the control.
`Bool`	HandleEvent( `AEEEvent` event , `UInt16` wParam , `UInt32` dwParam ) (inherits from SFBControl) 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 ) (inherits from SFBControl) 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` ) (inherits from SFBControl) Return the active or focus state of the control.
`Bool`	Redraw( `Void` ) (inherits from SFBControl) Instruct the control to redraw its contents.
`Void`	Reset( `Void` ) (inherits from SFBControl) Instruct the control to reset (free/delete) its contents and to immediately leave active/focus mode.
`Void`	SetActive( `Bool` active = true ) (inherits from SFBControl) Instruct the control to enter/leave focus or selected mode.
`Void`	SetProperties( `UInt32` properties ) (inherits from SFBControl) Set control-specific properties or flags.
`Void`	SetRect( `SFXRectangleConstRef` rect ) (inherits from SFBControl) 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.

SFBImageCtl::NewInstance

Create a new SFBImageCtl instance.

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

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

SFBImageCtl::SetImage

Set the image.

[ public ]
Void SetImage(
    SFBImageSmpConstRef image   // pointer to the image
);

Reference

BREW API IIMAGECTL_SetImage

SFBImageCtl::SetRedraw

This method sets the redraw call back for the image set in image control.

[ public ]
Void SetRedraw(
    PFNNOTIFY notify      // redraw Callback 
    VoidPtr data = null   // user Data 
);

Reference

BREW API IIMAGECTL_SetRedraw | PFNNOTIFY