File: wx.DateTime.Tm.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (163 lines) | stat: -rw-r--r-- 6,069 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.DateTime.Tm:

==========================================================================================================================================
|phoenix_title|  **wx.DateTime.Tm**
==========================================================================================================================================

Contains broken down date-time representation.          

This struct is analogous to standard C  ``struct tm``   and uses the same, not always immediately obvious, conventions for its members: notably its mon and mday fields count from 0 while yday counts from 1.            




|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>Tm</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.DateTime.Tm_inheritance.png" alt="Inheritance diagram of Tm" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.DateTime.Tm.html" title="wx.DateTime.Tm" alt="" coords="5,5,133,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.DateTime.Tm.GetWeekDay`                                               Return the week day corresponding to this date.
:meth:`~wx.DateTime.Tm.IsValid`                                                  Check if the given date/time is valid (in Gregorian calendar).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.DateTime.Tm.WeekDay`                                                  See :meth:`~wx.DateTime.Tm.GetWeekDay`
:attr:`~wx.DateTime.Tm.hour`                                                     A public C++ attribute of type ``int``. Hours since midnight in 0..23 range.                  
:attr:`~wx.DateTime.Tm.mday`                                                     A public C++ attribute of type ``int``. Day of the month in 1..31 range.                  
:attr:`~wx.DateTime.Tm.min`                                                      A public C++ attribute of type ``int``. Minutes in 0..59 range.                  
:attr:`~wx.DateTime.Tm.mon`                                                      A public C++ attribute of type ``DateTime.Month``. Month, as an enumerated constant.                  
:attr:`~wx.DateTime.Tm.msec`                                                     A public C++ attribute of type ``int``. Number of milliseconds.                  
:attr:`~wx.DateTime.Tm.sec`                                                      A public C++ attribute of type ``int``. Seconds in 0..59 (60 with leap seconds) range.                  
:attr:`~wx.DateTime.Tm.yday`                                                     A public C++ attribute of type ``int``. Day of the year in 0..365 range.                  
:attr:`~wx.DateTime.Tm.year`                                                     A public C++ attribute of type ``int``. Year.                  
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.DateTime.Tm(object)

   Contains broken down date-time representation.



   .. method:: GetWeekDay(self)

      Return the week day corresponding to this date.                  

      Unlike the other fields, the week day is not always available and so must be accessed using this method as it is computed on demand when it is called.                  

      :rtype: :ref:`wx.DateTime.WeekDay`








   .. method:: IsValid(self)

      Check if the given date/time is valid (in Gregorian calendar).                  

      Return ``False`` if the components don't correspond to a correct date.                  

      :rtype: `bool`








   .. attribute:: WeekDay

      See :meth:`~wx.DateTime.Tm.GetWeekDay`


   .. attribute:: hour

      A public C++ attribute of type ``int``. Hours since midnight in 0..23 range.                  


   .. attribute:: mday

      A public C++ attribute of type ``int``. Day of the month in 1..31 range.                  


   .. attribute:: min

      A public C++ attribute of type ``int``. Minutes in 0..59 range.                  


   .. attribute:: mon

      A public C++ attribute of type ``DateTime.Month``. Month, as an enumerated constant.                  


   .. attribute:: msec

      A public C++ attribute of type ``int``. Number of milliseconds.                  


   .. attribute:: sec

      A public C++ attribute of type ``int``. Seconds in 0..59 (60 with leap seconds) range.                  


   .. attribute:: yday

      A public C++ attribute of type ``int``. Day of the year in 0..365 range.                  


   .. attribute:: year

      A public C++ attribute of type ``int``. Year.