interface/wx/time.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/time.h
   3 // Purpose:     Time-related functions.
   4 // Author:      Vadim Zeitlin
   5 // Created:     2011-11-27
   6 // Copyright:   (c) 2011 Vadim Zeitlin <vadim@wxwidgets.org>
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 /** @addtogroup group_funcmacro_time */
  11 //@{
  12
  13 /**
  14     Returns the difference between UTC and local time in seconds.
  15
  16     @header{wx/time.h}
  17  */
  18 int wxGetTimeZone();
  19
  20 /**
  21     Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
  22
  23     @see wxDateTime::Now()
  24
  25     @header{wx/time.h}
  26 */
  27 long wxGetLocalTime();
  28
  29 /**
  30     Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
  31
  32     The use of wxGetUTCTimeMillis() is preferred as it provides a usually
  33     (except for changes to the system time) monotonic clock which the local
  34     time also changes whenever DST begins or ends.
  35
  36     @see wxDateTime::Now(), wxGetUTCTimeMillis(), wxGetUTCTimeUSec()
  37
  38     @header{wx/time.h}
  39 */
  40 wxLongLong wxGetLocalTimeMillis();
  41
  42 /**
  43     Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
  44
  45     @see wxDateTime::Now()
  46
  47     @header{wx/time.h}
  48 */
  49 long wxGetUTCTime();
  50
  51 /**
  52     Returns the number of milliseconds since GMT 00:00:00 Jan 1st 1970.
  53
  54     @header{wx/time.h}
  55
  56     @since 2.9.3
  57  */
  58 wxLongLong wxGetUTCTimeMillis();
  59
  60 /**
  61     Returns the number of microseconds since GMT 00:00:00 Jan 1st 1970.
  62
  63     @header{wx/time.h}
  64
  65     @since 2.9.3
  66  */
  67 wxLongLong wxGetUTCTimeUSec();
  68
  69 //@}