.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.DateTime.TimeZone:
==========================================================================================================================================
|phoenix_title| **wx.DateTime.TimeZone**
==========================================================================================================================================
Class representing a time zone.
The representation is simply the offset, in seconds, from ``UTC``.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
TimeZone:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DateTime.TimeZone.__init__` Constructor for a named time zone.
:meth:`~wx.DateTime.TimeZone.GetOffset` Return the offset of this time zone from ``UTC``, in seconds.
:meth:`~wx.DateTime.TimeZone.IsLocal` Return ``True`` if this is the local time zone.
:meth:`~wx.DateTime.TimeZone.Make` Create a time zone with the given offset in seconds.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.DateTime.TimeZone.Offset` See :meth:`~wx.DateTime.TimeZone.GetOffset`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DateTime.TimeZone(object)
**Possible constructors**::
TimeZone(tz : DateTime.TZ) -> None
TimeZone(offset: int=0) -> None
Class representing a time zone.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self, tz : DateTime.TZ)`
Constructor for a named time zone.
:param `tz`:
:type `tz`: DateTime.TZ
:rtype: `None`
:html:`
`
**__init__** `(self, offset: int=0)`
Constructor for the given offset in seconds.
:param `offset`:
:type `offset`: long
:rtype: `None`
:html:`
`
.. method:: GetOffset(self)
Return the offset of this time zone from ``UTC``, in seconds.
:rtype: `int`
.. method:: IsLocal(self)
Return ``True`` if this is the local time zone.
This method can be useful for distinguishing between ``UTC`` time zone and local time zone in Great Britain, which use the same offset as ``UTC`` (i.e. 0), but do use ``DST``.
:rtype: `bool`
.. versionadded:: 4.1/wxWidgets-3.1.1
.. staticmethod:: Make(offset : int)
Create a time zone with the given offset in seconds.
:param `offset`:
:type `offset`: long
:rtype: :ref:`wx.DateTime.TimeZone`
.. attribute:: Offset
See :meth:`~wx.DateTime.TimeZone.GetOffset`