- </DL>
-</UL>
-<BR>
-<BR>
-<BR>
-<DT><B>EVT_TIMEUPDATE(win, id, func)</B>
-<DD>func is fired whenever the value of the control changes.
-<BR>
-<BR>
-<DT><B>SetValue(time_string | wxDateTime | wxTimeSpan | mx.DateTime | mx.DateTimeDelta)</B>
-<DD>Sets the value of the control to a particular time, given a valid
-value; raises ValueError on invalid value.
-<EM>NOTE:</EM> This will only allow mx.DateTime or mx.DateTimeDelta if mx.DateTime
-was successfully imported by the class module.
-<BR>
-<DT><B>GetValue(as_wxDateTime = False, as_mxDateTime = False, as_wxTimeSpan=False, as mxDateTimeDelta=False)</B>
-<DD>Retrieves the value of the time from the control. By default this is
-returned as a string, unless one of the other arguments is set; args are
-searched in the order listed; only one value will be returned.
-<BR>
-<DT><B>GetWxDateTime(value=None)</B>
-<DD>When called without arguments, retrieves the value of the control, and applies
-it to the wxDateTimeFromHMS() constructor, and returns the resulting value.
-The date portion will always be set to Jan 1, 1970. This form is the same
-as GetValue(as_wxDateTime=True). GetWxDateTime can also be called with any of the
-other valid time formats settable with SetValue, to regularize it to a single
-wxDateTime form. The function will raise ValueError on an unconvertable argument.
-<BR>
-<DT><B>GetMxDateTime()</B>
-<DD>Retrieves the value of the control and applies it to the DateTime.Time()
-constructor,and returns the resulting value. (The date portion will always be
-set to Jan 1, 1970.) (Same as GetValue(as_wxDateTime=True); provided for backward
-compatibility with previous release.)
-<BR>
-<BR>
-<DT><B>BindSpinButton(SpinBtton)</B>
-<DD>Binds an externally created spin button to the control, so that up/down spin
-events change the active cell or selection in the control (in addition to the
-up/down cursor keys.) (This is primarily to allow you to create a "standard"
-interface to time controls, as seen in Windows.)
-<BR>
-<BR>
-<DT><B>SetMin(min=None)</B>
-<DD>Sets the expected minimum value, or lower bound, of the control.
-(The lower bound will only be enforced if the control is
-configured to limit its values to the set bounds.)
-If a value of <I>None</I> is provided, then the control will have
-explicit lower bound. If the value specified is greater than
-the current lower bound, then the function returns False and the
-lower bound will not change from its current setting. On success,
-the function returns True. Even if set, if there is no corresponding
-upper bound, the control will behave as if it is unbounded.
-<DT><DD>If successful and the current value is outside the
-new bounds, if the control is limited the value will be
-automatically adjusted to the nearest bound; if not limited,
-the background of the control will be colored with the current
-out-of-bounds color.
-<BR>
-<DT><B>GetMin(as_string=False)</B>
-<DD>Gets the current lower bound value for the control, returning
-None, if not set, or a wxDateTime, unless the as_string parameter
-is set to True, at which point it will return the string
-representation of the lower bound.
-<BR>
-<BR>
-<DT><B>SetMax(max=None)</B>
-<DD>Sets the expected maximum value, or upper bound, of the control.
-(The upper bound will only be enforced if the control is
-configured to limit its values to the set bounds.)
-If a value of <I>None</I> is provided, then the control will
-have no explicit upper bound. If the value specified is less
-than the current lower bound, then the function returns False and
-the maximum will not change from its current setting. On success,
-the function returns True. Even if set, if there is no corresponding
-lower bound, the control will behave as if it is unbounded.
-<DT><DD>If successful and the current value is outside the
-new bounds, if the control is limited the value will be
-automatically adjusted to the nearest bound; if not limited,
-the background of the control will be colored with the current
-out-of-bounds color.
-<BR>
-<DT><B>GetMax(as_string = False)</B>
-<DD>Gets the current upper bound value for the control, returning
-None, if not set, or a wxDateTime, unless the as_string parameter
-is set to True, at which point it will return the string
-representation of the lower bound.
-
-<BR>
-<BR>
-<DT><B>SetBounds(min=None,max=None)</B>
-<DD>This function is a convenience function for setting the min and max
-values at the same time. The function only applies the maximum bound
-if setting the minimum bound is successful, and returns True
-only if both operations succeed. <B><I>Note: leaving out an argument
-will remove the corresponding bound, and result in the behavior of
-an unbounded control.</I></B>
-<BR>
-<DT><B>GetBounds(as_string = False)</B>
-<DD>This function returns a two-tuple (min,max), indicating the
-current bounds of the control. Each value can be None if
-that bound is not set. The values will otherwise be wxDateTimes
-unless the as_string argument is set to True, at which point they
-will be returned as string representations of the bounds.
-<BR>
-<BR>
-<DT><B>IsInBounds(value=None)</B>
-<DD>Returns <I>True</I> if no value is specified and the current value
-of the control falls within the current bounds. This function can also
-be called with a value to see if that value would fall within the current
-bounds of the given control. It will raise ValueError if the value
-specified is not a wxDateTime, mxDateTime (if available) or parsable string.
-<BR>
-<BR>
-<DT><B>IsValid(value)</B>
-<DD>Returns <I>True</I>if specified value is a legal time value and
-falls within the current bounds of the given control.
-<BR>
-<BR>
-<DT><B>SetLimited(bool)</B>
-<DD>If called with a value of True, this function will cause the control
-to limit the value to fall within the bounds currently specified.
-(Provided both bounds have been set.)
-If the control's value currently exceeds the bounds, it will then
-be set to the nearest bound.
-If called with a value of False, this function will disable value
-limiting, but coloring of out-of-bounds values will still take
-place if bounds have been set for the control.
-<DT><B>IsLimited()</B>
-<DD>Returns <I>True</I> if the control is currently limiting the
-value to fall within the current bounds.
-<BR>
-</DL>
-</body></html>
+
+--------------------
+
+EVT_TIMEUPDATE(win, id, func)
+ func is fired whenever the value of the control changes.
+
+
+SetValue(time_string | wxDateTime | wxTimeSpan | mx.DateTime | mx.DateTimeDelta)
+ Sets the value of the control to a particular time, given a valid
+ value; raises ValueError on invalid value.
+
+*NOTE:* This will only allow mx.DateTime or mx.DateTimeDelta if mx.DateTime
+ was successfully imported by the class module.
+
+GetValue(as_wxDateTime = False, as_mxDateTime = False, as_wxTimeSpan=False, as mxDateTimeDelta=False)
+ Retrieves the value of the time from the control. By default this is
+ returned as a string, unless one of the other arguments is set; args are
+ searched in the order listed; only one value will be returned.
+
+GetWxDateTime(value=None)
+ When called without arguments, retrieves the value of the control, and applies
+ it to the wxDateTimeFromHMS() constructor, and returns the resulting value.
+ The date portion will always be set to Jan 1, 1970. This form is the same
+ as GetValue(as_wxDateTime=True). GetWxDateTime can also be called with any of the
+ other valid time formats settable with SetValue, to regularize it to a single
+ wxDateTime form. The function will raise ValueError on an unconvertable argument.
+
+GetMxDateTime()
+ Retrieves the value of the control and applies it to the DateTime.Time()
+ constructor,and returns the resulting value. (The date portion will always be
+ set to Jan 1, 1970.) (Same as GetValue(as_wxDateTime=True); provided for backward
+ compatibility with previous release.)
+
+
+BindSpinButton(SpinBtton)
+ Binds an externally created spin button to the control, so that up/down spin
+ events change the active cell or selection in the control (in addition to the
+ up/down cursor keys.) (This is primarily to allow you to create a "standard"
+ interface to time controls, as seen in Windows.)
+
+
+SetMin(min=None)
+ Sets the expected minimum value, or lower bound, of the control.
+ (The lower bound will only be enforced if the control is
+ configured to limit its values to the set bounds.)
+ If a value of *None* is provided, then the control will have
+ explicit lower bound. If the value specified is greater than
+ the current lower bound, then the function returns False and the
+ lower bound will not change from its current setting. On success,
+ the function returns True. Even if set, if there is no corresponding
+ upper bound, the control will behave as if it is unbounded.
+
+ If successful and the current value is outside the
+ new bounds, if the control is limited the value will be
+ automatically adjusted to the nearest bound; if not limited,
+ the background of the control will be colored with the current
+ out-of-bounds color.
+
+GetMin(as_string=False)
+ Gets the current lower bound value for the control, returning
+ None, if not set, or a wxDateTime, unless the as_string parameter
+ is set to True, at which point it will return the string
+ representation of the lower bound.
+
+
+SetMax(max=None)
+ Sets the expected maximum value, or upper bound, of the control.
+ (The upper bound will only be enforced if the control is
+ configured to limit its values to the set bounds.)
+ If a value of *None* is provided, then the control will
+ have no explicit upper bound. If the value specified is less
+ than the current lower bound, then the function returns False and
+ the maximum will not change from its current setting. On success,
+ the function returns True. Even if set, if there is no corresponding
+ lower bound, the control will behave as if it is unbounded.
+
+ If successful and the current value is outside the
+ new bounds, if the control is limited the value will be
+ automatically adjusted to the nearest bound; if not limited,
+ the background of the control will be colored with the current
+ out-of-bounds color.
+
+GetMax(as_string = False)
+ Gets the current upper bound value for the control, returning
+ None, if not set, or a wxDateTime, unless the as_string parameter
+ is set to True, at which point it will return the string
+ representation of the lower bound.
+
+
+
+SetBounds(min=None,max=None)
+ This function is a convenience function for setting the min and max
+ values at the same time. The function only applies the maximum bound
+ if setting the minimum bound is successful, and returns True
+ only if both operations succeed. *Note: leaving out an argument
+ will remove the corresponding bound, and result in the behavior of
+ an unbounded control.*
+
+GetBounds(as_string = False)
+ This function returns a two-tuple (min,max), indicating the
+ current bounds of the control. Each value can be None if
+ that bound is not set. The values will otherwise be wxDateTimes
+ unless the as_string argument is set to True, at which point they
+ will be returned as string representations of the bounds.
+
+
+IsInBounds(value=None)
+ Returns *True* if no value is specified and the current value
+ of the control falls within the current bounds. This function can also
+ be called with a value to see if that value would fall within the current
+ bounds of the given control. It will raise ValueError if the value
+ specified is not a wxDateTime, mxDateTime (if available) or parsable string.
+
+
+IsValid(value)
+ Returns *True* if specified value is a legal time value and
+ falls within the current bounds of the given control.
+
+
+SetLimited(bool)
+ If called with a value of True, this function will cause the control
+ to limit the value to fall within the bounds currently specified.
+ (Provided both bounds have been set.)
+ If the control's value currently exceeds the bounds, it will then
+ be set to the nearest bound.
+ If called with a value of False, this function will disable value
+ limiting, but coloring of out-of-bounds values will still take
+ place if bounds have been set for the control.
+IsLimited()
+ Returns *True* if the control is currently limiting the
+ value to fall within the current bounds.
+
+
projects / wxWidgets.git / blobdiff