SophiaFramework UNIVERSE 5.3 |
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
O | O | O | O |
Public Functions | |
---|---|
Void |
EnableCommand(
Bool enable
, UInt16 id
)
Enable the date control object to send a user-defined command to the active applet.
|
Bool |
GetDate(
SInt32Ptr year
, SInt32Ptr month
, SInt32Ptr day
)
Get the date from the date control object.
|
Bool |
GetDateString(
WCharPtr buffer
, SInt32 buffSize
, SInt32Ptr countChars
, UInt32 dateFormat
)
Get the date string in the specified format.
|
Bool |
GetDateString(
SFXWideStringPtr string
, UInt32 dateFormat
)
Get the date string in the specified format.
|
UInt16 |
GetDayOfWeek( Void )
Get the day of week from the date control object.
|
WCharPtr |
GetDayString(
WCharPtr buffer
, SInt32 buffSize
, SInt32Ptr countChars
)
Get the name of the day corresponding to the date control object’s current date.
|
Bool |
GetDayString(
SFXWideStringPtr string
)
Get the name of the day corresponding to the date control object’s current date.
|
Bool |
GetFont(
AEEFont* text
, AEEFont* title
)
This method allows the caller to get the title and text fonts.
|
SInt32 |
GetJulianDay( Void )
Get the Julian day value of the specified date control object.
|
WCharPtr |
GetMonthString(
WCharPtr buffer
, SInt32 buffSize
, SInt32Ptr countChars
)
Get the name of the month of the date control object’s current date.
|
Bool |
GetMonthString(
SFXWideStringPtr string
)
Get the name of the month of the date control object’s current date.
|
static SFBDateCtlSmp |
NewInstance(
SFCErrorPtr exception = null
)
Create a new SFBDateCtl instance.
|
static SFBDateCtlSmp |
NewInstance(
AEECLSID clsid
, SFCErrorPtr exception = null
)
Create a new SFBDateCtl instance.
|
Void |
SetActiveDayMask(
UInt32 mask
)
Set a new active day mask.
|
Bool |
SetDate(
SInt32 year
, SInt32 month
, SInt32 day
)
Assign the specified date to the date control object.
|
Void |
SetFont(
AEEFont text
, AEEFont title
)
Set the title and text fonts.
|
Bool |
SetJulianDay(
SInt32 day
)
Assign the specified Julian day to the date control object.
|
Bool |
SetTitle(
ACharConstPtr resourceFile
, UInt16 resourceId
)
Set title of a date control object.
|
Bool |
SetTitle(
WCharPtr text
)
Set title of a date control object.
|
Bool |
SetTitle(
SFXAnsiStringConstRef resourceFile
, UInt16 resourceId
)
Set title of a date control object.
|
Bool |
SetTitle(
SFXWideStringConstRef text
)
Set title of a date control object.
|
Void |
SizeToFit(
SFXRectanglePtr rect
)
This method allows the caller to size the rectangle to the date text.
|
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.
|
[ public ] Void EnableCommand( Bool enable // boolean value for enable flag UInt16 id // command ID );
[ public ] Bool GetDateString( WCharPtr buffer // placeholder for date string SInt32 buffSize // size of the input buffer (pBuffer) in bytes SInt32Ptr countChars // placeholder for the number of characters written in buffer UInt32 dateFormat // format of the date string. // use one of the date string formats given: // DFMT_DD_MONTH_YYYY : 18 July 2000 // DFMT_DD_MON_YYYY : 18 Jul 2000 // DFMT_DD_MON_YY : 18 Jul ‘00 // DFMT_MONTH_DD_YYYY : July 18, 2000 // DFMT_MON_DD_YYYY : Jul. 18, 2000 // DFMT_MON_DD_YY : Jul 18, ‘00 // DFMT_MM_DD_YYYY : 10/15/2000 // DFMT_DD_MM_YYYY : 15/10/2001 // DFMT_YYYY_MM_DD : 2001/6/1 // DFMT_INT_YYYY_MM_DD : 2001.06.01 );
[ public ] Bool GetDateString( SFXWideStringPtr string UInt32 dateFormat );
[ public ] UInt16 GetDayOfWeek(Void);
[ public ] WCharPtr GetDayString( WCharPtr buffer // placeholder for day name SInt32 buffSize // size of the input buffer in bytes SInt32Ptr countChars // placeholder for number of characters written in buffer );
[ public ] Bool GetDayString( SFXWideStringPtr string // placeholder for day name );
[ public ] Bool GetFont( AEEFont* text // pointer to location to set to text font AEEFont* title // pointer to location to set to title font );
[ public ] SInt32 GetJulianDay(Void);
[ public ] WCharPtr GetMonthString( WCharPtr buffer // placeholder for month name SInt32 buffSize // size of the input buffer in bytes SInt32Ptr countChars // placeholder for number of characters written in buffer );
[ public ] Bool GetMonthString( SFXWideStringPtr string // placeholder for month name );
[ public, static ] SFBDateCtlSmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBDateCtlSmp NewInstance( AEECLSID clsid // ClassID for the SFBDateCtl class SFCErrorPtr exception = null // Error );
[ public ] Void SetFont( AEEFont text // font to use for the text (if 0, normal font is used) AEEFont title // font to use for the title (if 0, bold font is used) );
[ public ] Bool SetTitle( ACharConstPtr resourceFile // null-terminated string containing resource file name UInt16 resourceId // string resource identifier );
[ public ] Bool SetTitle( WCharPtr text // null-terminated title string );
[ public ] Bool SetTitle( SFXAnsiStringConstRef resourceFile // null-terminated string containing resource file name UInt16 resourceId // string resource identifier );
[ public ] Bool SetTitle( SFXWideStringConstRef text // null-terminated title string );
[ public ] Void SizeToFit( SFXRectanglePtr rect // pointer to location to set to bounding rectangle );
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |