This is a guide to the wxPython GUI toolkit, written by a Python programmer for his fellow Python programmers. It began as a simple translation of the wxWidgets documentation (which is written @@ -108,8 +390,8 @@ beans, dark chocolate, and large denomination currency. Better yet, buy huge quantities of my wxPython book (written with Robin Dunn) and send one to each of your friends, relatives, and coworkers.
wxPython is a GUI toolkit for the Python programming language. It allows Python programmers to create programs with a robust, highly functional graphical user interface, simply and easily. It is @@ -126,19 +408,19 @@ or unix-like systems, and Macintosh OS X.
Since the language is Python, wxPython programs are simple, easy to write and easy to understand.
To make use of wxPython, you currently need one of the following setups.
-wxWidgets is a C++ framework providing GUI (Graphical User Interface) and other facilities on more than one platform. Version 2 currently supports all desktop versions of MS Windows, Unix with GTK+, Unix with @@ -169,8 +451,8 @@ Roebling, Vadim Zeitlin, Vaclav Slavik and many others.
platforms related to Microsoft Windows, including 16-bit and 32-bit variants, unless otherwise stated. All trademarks are acknowledged.wxWidgets was developed to provide a cheap and flexible way to maximize investment in GUI application development. While a number of commercial class libraries already existed for cross-platform @@ -244,8 +526,8 @@ the clipboard. PNM, PCX).
To set a wxPython application going, you will need to derive an App class and override App.OnInit.
An application must have a top-level Frame or Dialog window. Each @@ -291,14 +573,14 @@ PathList. There's a miscellany of operating system and other functions.
See also Classes by Category for a list of classes.
In addition to the core wxWidgets library, a number of further libraries and utilities are supplied with each distribution.
[Need to list these.]
[This section needs to be reviewed.]
Classes: wx.App
-The OnInit method defined for a class derived from wx.App will usually create a top window as a bare minimum.
OnInit must return a boolean value to indicate whether processing @@ -365,8 +647,8 @@ if __name__ == '__main__': main()
The application normally shuts down when the last of its top level windows is closed. This is normally the expected behaviour and means that it is enough to call Close() in response to the "Exit" menu @@ -385,11 +667,11 @@ created by the time OnExit finishes.
[Need examples of objects needing cleanup to keep app from crashing.]
Classes: wx.Sizer, wx.GridSizer, wx.FlexGridSizer, wx.BoxSizer, wx.StaticBoxSizer, wx.NotebookSizer, wx.CreateButtonSizer
-wxPython provides a set of powerful classes to work with dates and times. Some of the supported features of the DateTime class are:
-There are 3 main classes: except DateTime itself which represents an absolute moment in time, there are also two classes - TimeSpan and DateSpan which represent the intervals of time.
@@ -748,8 +1030,8 @@ date is a holiday or not and DateTimeWorkDays which is a derivation of this class for which (only) Saturdays and Sundays are the holidays. See more about these classes in the discussion of the holidays.DateTime stores the time as a signed number of milliseconds since the Epoch which is fixed, by convention, to Jan 1, 1970 - however this is not visible to the class users (in particular, dates prior to the @@ -772,8 +1054,8 @@ country, and even region, dependent). Future versions will probably have Julian calendar support as well and support for other calendars (Maya, Hebrew, Chinese...) is not ruled out.
While there is only one logical way to represent an absolute moment in the time (and hence only one DateTime class), there are at least two methods to describe a time interval.
@@ -801,14 +1083,14 @@ in the program, you should probably use TimeSpan instead of DateSpan in situations when you do need to understand what 'in a month' means (of course, it is just DateTime.Now() + DateSpan.Month()).Many different operations may be performed with the dates, however not all of them make sense. For example, multiplying a date by a number is an invalid operation, even though multiplying either of the time span classes by a number is perfectly valid.
Here is what can be done:
-Although the time is always stored internally in GMT, you will usually work in the local time zone. Because of this, all DateTime constructors and setters which take the broken down date assume that @@ -877,8 +1159,8 @@ job. I.e. you would just write
printf("The time is %s in local time zone", dt.FormatTime().c_str()); printf("The time is %s in GMT", dt.FormatTime(wxDateTime::GMT).c_str());DST (a.k.a. 'summer time') handling is always a delicate task which is better left to the operating system which is supposed to be configured by the administrator to behave correctly. Unfortunately, when doing @@ -894,17 +1176,17 @@ the future.
The time zone handling methods use these functions too, so they are subject to the same limitations.
[TODO]
Not done yet.
wxPython provides the following predefined ID constants:
ID_ABORT ID_ABOUT @@ -964,8 +1246,8 @@ ID_UNDO ID_YES ID_YESTOALL
The source document is named wxPythonManual.txt and can be found by clicking the link at the bottom of this page (assuming you are viewing the html file). It is written using a fantastic formatting convention @@ -973,8 +1255,8 @@ called reStructuredText. The wxPythonManual.html file is created using the Docutils utilities, which can turn reStructuredText documents into html, xml, pdf, and even OpenOffice files.
Some items in the source text file look like this:
.. This is text from the wxWidgets documentation that needs to be @@ -991,8 +1273,8 @@ to you and will show my gratitude by adding your name to the list of contributors. (Contributors who also send me gifts of coffee, chocolate, or currency will have their names listed in bold.)
Individuals who contributed to this documentation (in order by last name):