SFBAClockCtl

Wrapper Class for the IAClockCtl interface.

#include <SFBAClockCtl.h.hpp>

class SFBAClockCtl : public SFBControl;

SFMTYPEDEFWRAPPER(SFBAClockCtl)

Inheritance diagram

Version

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

Reference

BREW API IAClockCtl

Member

Public Functions
`Void`	GetFaceImageRect( `SFXRectanglePtr` rect ) Retrieves the image rectangle for the underlying face image if set for the analog clock.
`SFXRectangle`	GetFaceImageRect( `Void` ) Retrieves the image rectangle for the underlying face image if set for the analog clock.
static `SFBAClockCtlSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBAClockCtl instance.
static `SFBAClockCtlSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBAClockCtl instance.
`Void`	SetFaceColor( `RGBVAL` color ) Set the background color of the analog clock control.
`Void`	SetFaceColor( `SFXRGBColorConstRef` color ) Set the background color of the analog clock control.
`Void`	SetFaceImage( `SFBImageSmpConstRef` image , `SFXRectanglePtr` rect ) Set the background image that is displayed on the face of the analog clock control.
`Void`	SetHandFrameColor( `RGBVAL` color ) Set the fill color for the frame of the analog clock control.
`Void`	SetHandFrameColor( `SFXRGBColorConstRef` color ) Set the fill color for the frame of the analog clock control.
`Void`	SetHourColor( `RGBVAL` color ) Set the fill color for the hour-hand of the analog clock control.
`Void`	SetHourColor( `SFXRGBColorConstRef` color ) Set the fill color for the hour-hand of the analog clock control.
`Void`	SetMinColor( `RGBVAL` color ) Set the fill color for the minute-hand of the analog clock control.
`Void`	SetMinColor( `SFXRGBColorConstRef` color ) Set the fill color for the minute-hand of the analog clock control.
`Void`	SetSecColor( `RGBVAL` color ) Set the fill color for the second-hand of the analog clock control.
`Void`	SetSecColor( `SFXRGBColorConstRef` color ) Set the fill color for the second-hand of the analog clock control.
`UInt32`	SetTime( `UInt32` tod ) Set given time and redraw the clock on the screen.
`Void`	Start( `Void` ) Start the analog clock.
`Void`	StopStop( `Void` ) Stop the automatic display of the analog clock initiated by the call to SFBAClockCtl::Start.
`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.

SFBAClockCtl::GetFaceImageRect

Retrieves the image rectangle for the underlying face image if set for the analog clock.

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

[ public ]
SFXRectangle GetFaceImageRect(Void);

Reference

BREW API IAClockCtl_GetFaceImageRect | AEERect | SFBAClockCtl::SetFaceImage

SFBAClockCtl::NewInstance

Create a new SFBAClockCtl instance.

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

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

SFBAClockCtl::SetFaceColor

Set the background color of the analog clock control.

[ public ]
Void SetFaceColor(
    RGBVAL color   // RGB color of the background. 
);

[ public ]
Void SetFaceColor(
    SFXRGBColorConstRef color   // RGB color of the background. 
);

Reference

BREW API IAClockCtl_SetFaceColor

SFBAClockCtl::SetFaceImage

Set the background image that is displayed on the face of the analog clock control.

[ public ]
Void SetFaceImage(
    SFBImageSmpConstRef image   // pointer to SFBImage object to use for underlying face.
    SFXRectanglePtr rect        //  Pointer to rect in which to center the image. If NULL, the entire analog clock control is used.
);

Reference

BREW API IAClockCtl_SetFaceImage

SFBAClockCtl::SetHandFrameColor

Set the fill color for the frame of the analog clock control.

[ public ]
Void SetHandFrameColor(
    RGBVAL color   // RGB color of the frame
);

[ public ]
Void SetHandFrameColor(
    SFXRGBColorConstRef color   // RGB color of the frame
);

Reference

BREW API IAClockCtl_SetHandFrameColor

SFBAClockCtl::SetHourColor

Set the fill color for the hour-hand of the analog clock control.

[ public ]
Void SetHourColor(
    RGBVAL color   // RGB color of the hand 
);

[ public ]
Void SetHourColor(
    SFXRGBColorConstRef color   // RGB color of the hand 
);

Reference

BREW API IAClockCtl_SetHourColor

SFBAClockCtl::SetMinColor

Set the fill color for the minute-hand of the analog clock control.

[ public ]
Void SetMinColor(
    RGBVAL color   // RGB color of the hand 
);

[ public ]
Void SetMinColor(
    SFXRGBColorConstRef color   // RGB color of the hand 
);

Reference

BREW API IAClockCtl_SetMinColor

SFBAClockCtl::SetSecColor

Set the fill color for the second-hand of the analog clock control.

[ public ]
Void SetSecColor(
    RGBVAL color   // RGB color of the hand 
);

[ public ]
Void SetSecColor(
    SFXRGBColorConstRef color   // RGB color of the hand 
);

Reference

BREW API IAClockCtl_SetSecColor

SFBAClockCtl::SetTime

Set given time and redraw the clock on the screen.

[ public ]
UInt32 SetTime(
    UInt32 tod   // time in milliseconds expired since 00:00:00. Negative value is ignored.
);

Reference

BREW API IAClockCtl_SetTime

SFBAClockCtl::Start

Start the analog clock.

[ public ]
Void Start(Void);

Reference

BREW API IAClockCtl_Start | SFBAClockCtl::StopStop

SFBAClockCtl::StopStop

Stop the automatic display of the analog clock initiated by the call to SFBAClockCtl::Start.

[ public ]
Void Stop(Void);

Reference

BREW API IAClockCtl_Stop | SFBAClockCtl::Start