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