TABLE OF CONTENTS
Time/--background--
Time/MUIA_Time_ChangeDay
Time/MUIA_Time_ChangeHour
Time/MUIA_Time_DaylightSaving
Time/MUIA_Time_Hour
Time/MUIA_Time_MaxHour
Time/MUIA_Time_MaxMinute
Time/MUIA_Time_MaxSecond
Time/MUIA_Time_MidnightSecs
Time/MUIA_Time_Minute
Time/MUIA_Time_MinHour
Time/MUIA_Time_MinMinute
Time/MUIA_Time_MinSecond
Time/MUIA_Time_NextDay
Time/MUIA_Time_PrevDay
Time/MUIA_Time_Second
Time/MUIA_Time_ZoneMinute
Time/MUIM_Time_Compare
Time/MUIM_Time_Decrease
Time/MUIM_Time_Increase
Time/MUIM_Time_SetCurrent
Time/--background--
Time -- ... (V12)
Time is an abstract Custom Class of the Magic User Interface © by
Stefan Stuntz.
It's a subclass of notify-class and only usable for developers who
want to build subclasses of Time.mcc!
The idea of this class was born during developing my Gregor
application.
MUI abstract public custom class that allowing easy handling of time.
Because it is abstract it is only usefull for developers working with
classes that are based on Time.mcc (like TimeString.mcc), or those
who want to build their own Time.mcc based classes.
NOTES
None at the moment.
GO TO CONTENTS
Time/MUIA_Time_ChangeDay
MUIA_Time_ChangeDay, UWORD [ISG] -- Is day a DS change day? (V12.1)
SYNOPSIS
MUIA_Time_ChangeDay, MUIV_Time_ChangeDay_Normal,
\*result =*\ set(obj,MUIA_Time_DaylightDay,cd);
\*result =*\ get(obj,MUIA_Time_DaylightDay,&cd);
The MUIA_Time_ChangeDay attribute defines if a daylight saving
change happens on the actual day.
Defaults to MUIV_Time_ChangeDay_Normal.
RESULT
cd - MUIV_Time_ChangeDay_Normal : Normal day
MUIV_Time_ChangeDay_WinterToSummer : Winter to summer time
change happens today
MUIV_Time_ChangeDay_SummerToWinter : Summer to winter time
change happens today
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MUIA_Time_ChangeHour
MUIA_Time_DaylightSaving
GO TO CONTENTS
Time/MUIA_Time_ChangeHour
MUIA_Time_ChangeHour, UWORD [ISG] -- Change hour for DS (V12.1)
SYNOPSIS
MUIA_Time_ChangeHour, 2,
\*result =*\ set(obj,MUIA_Time_DaylightSaving,ch);
\*result =*\ get(obj,MUIA_Time_DaylightSaving,&ch);
The MUIA_Time_ChangeHour attribute defines the hour at which the
daylight saving change happens.
Defaults to 2.
RESULT
ch - Change hour for daylight saving time.
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MUIA_Time_ChangeDay
MUIA_Time_DaylightSaving
GO TO CONTENTS
Time/MUIA_Time_DaylightSaving
MUIA_Time_DaylightSaving, BOOL [ISG] -- Daylight saving status (V12.1)
SYNOPSIS
MUIA_Time_DaylightSaving, FALSE,
\*result =*\ set(obj,MUIA_Time_DaylightSaving,ds);
\*result =*\ get(obj,MUIA_Time_DaylightSaving,&ds);
The MUIA_Time_DaylightSaving attribute of a Time object reflects the
daylight saving status.
Defaults to FALSE.
RESULT
ds - TRUE : Daylight saving time.
FALSE : No daylight saving time.
NOTES
When you define MaxTime and/or MinTime then changing the daylight
saving will set the time to MinTime/MaxTime by crossing these limits.
BUGS
No known bugs.
SEE ALSO
MUIM_Time_ZoneMinute
MUIA_Time_ChangeDay
MUIA_Time_ChangeHour
GO TO CONTENTS
Time/MUIA_Time_Hour
MUIA_Time_Hour, UWORD [ISG] -- User selected hour (V12)
SYNOPSIS
MUIA_Time_Hour, 0,
\*result =*\ set(obj,MUIA_Time_Hour,hour);
\*result =*\ get(obj,MUIA_Time_Hour,&hour);
\*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_Hour,
MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
The MUIA_Time_Hour attribute of a Time object is
triggered when a new object value is given.
Defaults to 0 if there was never a valid time value given!
INPUTS
hour - Hour of the time value
RESULT
hour - Hour of the time value
NOTES
The hour is always in 24h format!
If you set a wrong time or if the time is not within MinTime and
MaxTime then this attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_Minute
MUIA_Time_Second
MUIA_Time_ZoneMinute
MUIA_Time_ZoneMinute
GO TO CONTENTS
Time/MUIA_Time_MaxHour
MUIA_Time_MaxHour, UWORD [ISG] -- Hour of the max. time (V12.1)
SYNOPSIS
MUIA_Time_MaxHour, 23,
\*result =*\ set(obj,MUIA_Time_MaxHour,mhour);
\*result =*\ get(obj,MUIA_Time_MaxHour,&mhour);
The MUIA_Time_MaxHour attribute of a Time object is
the hour of the maximum time that can be set.
Defaults to 23.
RESULT
mhour - Hour of the maximum time
NOTES
If you set a wrong time or if MinTime is >= MaxTime then this
attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_MaxMinute
MUIA_Time_MaxSecond
GO TO CONTENTS
Time/MUIA_Time_MaxMinute
MUIA_Time_MaxMinute, UWORD [ISG] -- Minute of max. time (V12.1)
SYNOPSIS
MUIA_Time_MaxMinute, 59,
\*result =*\ set(obj,MUIA_Time_MaxMinute,mmin);
\*result =*\ get(obj,MUIA_Time_MaxMinute,&mmin);
The MUIA_Time_MaxMinute attribute of a Time object is
the minute of the maximum time that can be set.
Defaults to 59.
INPUTS
mmin - Minute of the maximum time
RESULT
mmin - Minute of the maximum time
NOTES
If you set a wrong time or if MinTime is >= MaxTime then this
attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_MaxHour
MUIA_Time_MaxSecond
GO TO CONTENTS
Time/MUIA_Time_MaxSecond
MUIA_Time_MaxSecond, UWORD [ISG] -- Second of the max. time (V12.1)
SYNOPSIS
MUIA_Time_MaxSecond, 59,
\*result =*\ set(obj,MUIA_Time_MaxSecond,msec);
\*result =*\ get(obj,MUIA_Time_MaxSecond,&msec);
The MUIA_Time_MaxSecond attribute of a Time object is
the second of the maximum time that can be set.
Defaults to 59.
INPUTS
msec - Second of the maximum time
RESULT
msec - Second of the maximum time
NOTES
If you set a wrong time or if MinTime is >= MaxTime then this
attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_MaxHour
MUIA_Time_MaxMinute
GO TO CONTENTS
Time/MUIA_Time_MidnightSecs
MUIA_Time_MidnightSecs, ULONG [ISG] -- Seconds since midnight (V12.2)
SYNOPSIS
MUIA_Time_MidnightSecs, 0,
\*result =*\ set(obj,MUIA_Time_MidnightSecs,secs);
\*result =*\ get(obj,MUIA_Time_MidnightSecs,&secs);
\*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_MidnightSecs,
MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
The MUIA_Time_MidnightSecs attribute of a Time object is
triggered when a new value is given.
Defaults to 0 if there was never a valid time value given!
INPUTS
secs - Seconds since midnight (0-86399)
RESULT
secs - Seconds since midnight (0-86399)
NOTES
If you set a wrong time or if the time is not within MinTime and
MaxTime then this attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_Hour
MUIA_Time_Minute
MUIA_Time_Second
GO TO CONTENTS
Time/MUIA_Time_Minute
MUIA_Time_Minute, UWORD [ISG] -- Used minute (V12)
SYNOPSIS
MUIA_Time_Minute, 0,
\*result =*\ set(obj,MUIA_Time_Minute,min);
\*result =*\ get(obj,MUIA_Time_Minute,&min);
\*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_Minute,
MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
The MUIA_Time_Minute attribute of a Time object is
triggered when a new value is given.
Defaults to 0 if there was never a valid time value given!
INPUTS
min - Minute of the time value
RESULT
min - Minute of the time value
NOTES
If you set a wrong time or if the time is not within MinTime and
MaxTime then this attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_Hour
MUIA_Time_Second
MUIA_Time_ZoneMinute
MUIA_Time_ZoneMinute
GO TO CONTENTS
Time/MUIA_Time_MinHour
MUIA_Time_MinHour, UWORD [ISG] -- Hour of the min time (V12.1)
SYNOPSIS
MUIA_Time_MinHour, 0,
\*result =*\ set(obj,MUIA_Time_MinHour,mhour);
\*result =*\ get(obj,MUIA_Time_MinHour,&mhour);
The MUIA_Time_MinHour attribute of a Time object is
the hour of the minimum time that can be set.
Defaults to 0.
RESULT
mhour - Hour of the minimum time
NOTES
Always in 24h format!
If you set a wrong time or if MinTime is >= MaxTime then this
attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_MinMinute
MUIA_Time_MinSecond
GO TO CONTENTS
Time/MUIA_Time_MinMinute
MUIA_Time_MinMinute, UWORD [ISG] -- Minute of min. time (V12.1)
SYNOPSIS
MUIA_Time_MinMinute, 0,
\*result =*\ set(obj,MUIA_Time_MinMinute,mmin);
\*result =*\ get(obj,MUIA_Time_MinMinute,&mmin);
The MUIA_Time_MinMinute attribute of a Time object is
the minute of the minimum time that can be set.
Defaults to 0.
INPUTS
mmin - Minute of the minimum time
RESULT
mmin - Minute of the minimum time
NOTES
If you set a wrong time or if MinTime is >= MaxTime then this
attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_MinHour
MUIA_Time_MinSecond
GO TO CONTENTS
Time/MUIA_Time_MinSecond
MUIA_Time_MinSecond, UWORD [ISG] -- Second of the min. time (V12.1)
SYNOPSIS
MUIA_Time_MinSecond, 0,
\*result =*\ set(obj,MUIA_Time_MinSecond,msec);
\*result =*\ get(obj,MUIA_Time_MinSecond,&msec);
The MUIA_Time_MinSecond attribute of a Time object is
the second of the minimum time that can be set.
Defaults to 0.
INPUTS
msec - Second of the minimum time
RESULT
msec - Second of the minimum time
NOTES
If you set a wrong time or if MinTime is >= MaxTime then this
attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_MinHour
MUIA_Time_MinMinute
GO TO CONTENTS
Time/MUIA_Time_NextDay
MUIA_Time_NextDay, UWORD [..G] -- The next day has begun (V12)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_NextDay,
MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
The MUIA_Time_NextDay attribute of a Time object will be triggered
when the time changes from MaxTime to MinTime
Defaults to 0.
RESULT
nextday - Triggered when the next day begins.
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MUIM_Time_Increase
GO TO CONTENTS
Time/MUIA_Time_PrevDay
MUIA_Time_PrevDay, UWORD [..G] -- Changed to previous day (V12)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_PrevDay,
MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
The MUIA_Time_PrevDay attribute of a Time object will be triggered
when the time changes from MinTime to MaxTime
Defaults to 0.
RESULT
prevday - Triggered when changed to the previous day.
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MUIM_Time_Decrease
GO TO CONTENTS
Time/MUIA_Time_Second
MUIA_Time_Second, UWORD [ISG] -- Used second (V12)
SYNOPSIS
MUIA_Time_Second, 0,
\*result =*\ set(obj,MUIA_Time_Second,sec);
\*result =*\ get(obj,MUIA_Time_Second,&sec);
\*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_Second,
MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
The MUIA_Time_Second attribute of a Time object is
triggered when a new value is given.
Defaults to 0 if there was never a valid time value given!
INPUTS
sec - Second of the time value
RESULT
sec - Second of the time value
NOTES
If you set a wrong time or if the time is not within MinTime and
MaxTime then this attribute will be set back to its default!
BUGS
No known bugs.
SEE ALSO
MUIA_Time_Hour
MUIA_Time_Minute
MUIA_Time_ZoneMinute
MUIA_Time_ZoneMinute
GO TO CONTENTS
Time/MUIA_Time_ZoneMinute
MUIA_Time_ZoneMinute, WORD [ISG] -- Time zone (V12.1)
SYNOPSIS
MUIA_Time_ZoneMinute, 60,
\*result =*\ set(obj,MUIA_Time_ZoneMinute,zonemin);
\*result =*\ get(obj,MUIA_Time_ZoneMinute,&zonemin);
The MUIA_Time_ZoneMinute attribute of a Time object is
the time zone of the time that can be set (in minutes).
If the user gives a time string including a zone the time will be
recaclutated to this zone.
Defaults to 0 which is UCT also known as GMT.
INPUTS
zonemin - Time zone of the time in minutes
RESULT
zonemin - Time zone of the time in minutes
NOTES
If you set a wrong zone then this attribute will be set back to its
default!
When you define MaxTime and/or MinTime then changing the zone will
set the time to MinTime/MaxTime by crossing these limits.
BUGS
No known bugs.
SEE ALSO
MUIA_Time_Hour
MUIA_Time_Minute
MUIA_Time_Second
MUIA_Time_Second
GO TO CONTENTS
Time/MUIM_Time_Compare
MUIM_Time_Compare -- Compare with another time object (V12.3)
SYNOPSIS
result = (LONG)DoMethod(obj,MUIM_Time_Compare,tobj);
Compares the time object with another time object.
RESULT
result - -1 : obj < tobj : MUIV_Time_Compare_Less
0 : obj = tobj : MUIV_Time_Compare_Equal
1 : obj > tobj : MUIV_Time_Compare_Greater
NOTES
The result is undefined when tobj is not a Time object!
BUGS
No known bugs.
SEE ALSO
GO TO CONTENTS
Time/MUIM_Time_Decrease
MUIM_Time_Decrease -- Decrease the time (V12)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_Time_Decrease,secs);
Decreases the time by seconds.
INPUTS
secs - Seconds to sub from the time.
NOTES
MUIM_Time_Decrease considers the Min- and MaxTime settings.
Having 08:00:00 as MinTime, 17:59:59 as MaxTime then
decreasing 09:00:00 by two hours will result into 17:00:00!
BUGS
No known bugs.
SEE ALSO
MUIM_Time_Increase
MUIA_Time_PrevDay
GO TO CONTENTS
Time/MUIM_Time_Increase
MUIM_Time_Increase -- Increase the time (V12)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_Time_Increase,secs);
Increases the time by seconds.
INPUTS
secs - Seconds to add to the time.
NOTES
MUIM_Time_Increase considers the Min- and MaxTime settings.
Having 08:00:00 as MinTime, 17:59:59 as MaxTime then
increasing 17:00:00 by two hours will result into 09:00:00!
BUGS
No known bugs.
SEE ALSO
MUIM_Time_Decrease
MUIA_Time_NextDay
GO TO CONTENTS
Time/MUIM_Time_SetCurrent
MUIM_Time_SetCurrent -- Set the current time (V12)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_Time_SetCurrent);
Set the current time including the users time zone.
NOTES
MinTime/MaxTime will be set when the current time exceeds these
limits.
BUGS
No known bugs.
SEE ALSO