fixed bug in mouse handling

[wxWidgets.git] / docs / latex / wx / wxPython.tex

diff --git a/docs/latex/wx/wxPython.tex b/docs/latex/wx/wxPython.tex
index e54567cc232317acc827643553f311b1e6ffc427..84c2a75c3d285d5439feab38f105eb526a5b128e 100644 (file)
--- a/docs/latex/wx/wxPython.tex
+++ b/docs/latex/wx/wxPython.tex
@@ -35,8 +35,8 @@ wxPython is a Python package that can be imported at runtime that
 includes a collection of Python modules and an extension module
 (native code). It provides a series of Python classes that mirror (or
 shadow) many of the wxWindows GUI classes. This extension module
 includes a collection of Python modules and an extension module
 (native code). It provides a series of Python classes that mirror (or
 shadow) many of the wxWindows GUI classes. This extension module

-attempts to mirror the class heiarchy of wxWindows as closely as
-possble. This means that there is a wxFrame class in wxPython that
+attempts to mirror the class hierarchy of wxWindows as closely as
+possible. This means that there is a wxFrame class in wxPython that

 looks, smells, tastes and acts almost the same as the wxFrame class in
 the C++ version.
 
 looks, smells, tastes and acts almost the same as the wxFrame class in
 the C++ version.
 


@@ -55,7 +55,7 @@ details about getting wxPython working for you.
 So why would you want to use wxPython over just C++ and wxWindows?
 Personally I prefer using Python for everything. I only use C++ when
 I absolutely have to eek more performance out of an algorithm, and even
 So why would you want to use wxPython over just C++ and wxWindows?
 Personally I prefer using Python for everything. I only use C++ when
 I absolutely have to eek more performance out of an algorithm, and even

-then I ususally code it as an extension module and leave the majority
+then I usually code it as an extension module and leave the majority

 of the program in Python.
 
 Another good thing to use wxPython for is quick prototyping of your
 of the program in Python.
 
 Another good thing to use wxPython for is quick prototyping of your


@@ -80,7 +80,7 @@ This has its upsides and its downsides...
 
 The upside is that Tk is a pretty versatile toolkit. It can be made
 to do a lot of things in a lot of different environments. It is fairly
 
 The upside is that Tk is a pretty versatile toolkit. It can be made
 to do a lot of things in a lot of different environments. It is fairly

-easy to create new widgets and use them interchangably in your
+easy to create new widgets and use them interchangeably in your

 programs.
 
 The downside is Tcl. When using Tkinter you actually have two
 programs.
 
 The downside is Tcl. When using Tkinter you actually have two


@@ -89,7 +89,7 @@ Tcl interpreter for the GUI. Since the guts of Tcl is mostly about
 string processing, it is fairly slow as well. (Not too bad on a fast
 Pentium II, but you really notice the difference on slower machines.)
 
 string processing, it is fairly slow as well. (Not too bad on a fast
 Pentium II, but you really notice the difference on slower machines.)
 

-It wasn't until the lastest version of Tcl/Tk that native Look and
+It wasn't until the latest version of Tcl/Tk that native Look and

 Feel was possible on non-Motif platforms. This is because Tk
 usually implements its own widgets (controls) even when there are
 native controls available.
 Feel was possible on non-Motif platforms. This is because Tk
 usually implements its own widgets (controls) even when there are
 native controls available.


@@ -111,9 +111,9 @@ to use the GUI portions.
 \wxheading{Others}
 
 There are quite a few other GUI modules available for Python, some in
 \wxheading{Others}
 
 There are quite a few other GUI modules available for Python, some in

-active use, some that havn't been updated for ages. Most are simple
+active use, some that haven't been updated for ages. Most are simple

 wrappers around some C or C++ toolkit or another, and most are not
 wrappers around some C or C++ toolkit or another, and most are not

-cross-platform compatible. See \urlref{this link}{http://www.python.org/download/Contributed.html\#Graphics} 
+cross-platform compatible. See \urlref{this link}{http://www.python.org/download/Contributed.html\#Graphics}

 for a listing of a few of them.
 
 %----------------------------------------------------------------------
 for a listing of a few of them.
 
 %----------------------------------------------------------------------


@@ -123,7 +123,7 @@ I used SWIG (\urlref{http://www.swig.org}{http://www.swig.org}) to
 to create the source code for the
 extension module. This enabled me to only have to deal with a small
 amount of code and only have to bother with the exceptional issues.
 to create the source code for the
 extension module. This enabled me to only have to deal with a small
 amount of code and only have to bother with the exceptional issues.

-SWIG takes care of the rest and generates all the repetative code for
+SWIG takes care of the rest and generates all the repetitive code for

 me. You don't need SWIG to build the extension module as all the
 generated C++ code is included under the src directory.
 
 me. You don't need SWIG to build the extension module as all the
 generated C++ code is included under the src directory.
 


@@ -134,9 +134,9 @@ a recent version of SWIG from their CVS or from a daily build. See
 
 wxPython is organized as a Python package. This means that the
 directory containing the results of the build process should be a
 
 wxPython is organized as a Python package. This means that the
 directory containing the results of the build process should be a

-subdirectory of a directory on the \tt{PYTHONPATH}. (And preferably should
+subdirectory of a directory on the {\tt PYTHONPATH}. (And preferably should

 be named wxPython.) You can control where the build process will dump
 be named wxPython.) You can control where the build process will dump

-wxPython by setting the \tt{TARGETDIR} variable for the build utility (see
+wxPython by setting the {\tt TARGETDIR} variable for the build utility (see

 below).
 
 \begin{enumerate}\itemsep=0pt
 below).
 
 \begin{enumerate}\itemsep=0pt


@@ -160,31 +160,31 @@ You can use whatever flags you want, but I know these work.
 For Win32 systems I use Visual C++ 6.0, but 5.0 should work also. The
 build utility currently does not support any other Win32 compilers.
 \item At this point you may want to make an alias or symlink, script,
 For Win32 systems I use Visual C++ 6.0, but 5.0 should work also. The
 build utility currently does not support any other Win32 compilers.
 \item At this point you may want to make an alias or symlink, script,

-batch file, whatever on the PATH that invokes \tt{\$(WXWIN)/utils/wxPython/distrib/build.py} to
+batch file, whatever on the PATH that invokes {\tt \$(WXWIN)/utils/wxPython/distrib/build.py} to

 help simplify matters somewhat. For example, on my Win32 system I have a file named
 help simplify matters somewhat. For example, on my Win32 system I have a file named

- \tt{build}.bat in a directory on the PATH that contains:
+ {\tt build}.bat in a directory on the PATH that contains:

 
 

-\tt{python \%WXWIN/utils/wxPython/distrib/build.py \%1 \%2 \%3 \%4 \%5 \%6}
-\item Change into the \tt{\$(WXWIN)/utils/wxPython/src} directory.
-\item Type "\tt{build -b}" to build wxPython and "\tt{build -i}" to
-install it, or "\tt{build -bi}" to do both steps at once.
+{\tt python \%WXWIN/utils/wxPython/distrib/build.py \%1 \%2 \%3 \%4 \%5 \%6}
+\item Change into the {\tt \$(WXWIN)/utils/wxPython/src} directory.
+\item Type "{\tt build -b}" to build wxPython and "{\tt build -i}" to
+install it, or "{\tt build -bi}" to do both steps at once.

 
 The build.py script actually generates a Makefile based on what it
 finds on your system and information found in the build.cfg file.
 If you have troubles building or you want it built or installed in
 a different way, take a look at the docstring in build.py. You are
 
 The build.py script actually generates a Makefile based on what it
 finds on your system and information found in the build.cfg file.
 If you have troubles building or you want it built or installed in
 a different way, take a look at the docstring in build.py. You are

-able to to override many configuration options in a file named
+able to override many configuration options in a file named

 build.local.
 \item To build and install the add-on modules, change to the appropriate
 build.local.
 \item To build and install the add-on modules, change to the appropriate

-directory under \tt{\$(WXWIN)/utils/wxPython/modules} and run the build
+directory under {\tt \$(WXWIN)/utils/wxPython/modules} and run the build

 utility again.
 utility again.

-\item Change to the \tt{\$(WXWIN)/utils/wxPython/demo} directory.
+\item Change to the {\tt \$(WXWIN)/utils/wxPython/demo} directory.

 \item Try executing the demo program. For example:
 
 \item Try executing the demo program. For example:
 

-\tt{python demo.py}
+{\tt python demo.py}

 
 To run it without requiring a console on Win32, you can use the
 
 To run it without requiring a console on Win32, you can use the

-\tt{pythonw.exe} version of Python either from the command line or from a
+{\tt pythonw.exe} version of Python either from the command line or from a

 shortcut.
 \end{enumerate}
 
 shortcut.
 \end{enumerate}
 


@@ -199,7 +199,7 @@ I'm also going to assume that you know a bit about wxWindows already,
 enough to notice the similarities in the classes used.
 
 Take a look at the following wxPython program. You can find a similar
 enough to notice the similarities in the classes used.
 
 Take a look at the following wxPython program. You can find a similar

-program in the \tt{wxPython/demo} directory, named \tt{DialogUnits.py}. If your
+program in the {\tt wxPython/demo} directory, named {\tt DialogUnits.py}. If your

 Python and wxPython are properly installed, you should be able to run
 it by issuing this command:
 
 Python and wxPython are properly installed, you should be able to run
 it by issuing this command:
 


@@ -292,48 +292,48 @@ it by issuing this command:
 \begin{enumerate}\itemsep=11pt
 \item At line 2 the wxPython classes, constants, and etc. are imported
 into the current module's namespace. If you prefer to reduce
 \begin{enumerate}\itemsep=11pt
 \item At line 2 the wxPython classes, constants, and etc. are imported
 into the current module's namespace. If you prefer to reduce

-namespace pollution you can use "\tt{from wxPython import wx}" and
+namespace pollution you can use "{\tt from wxPython import wx}" and

 then access all the wxPython identifiers through the wx module, for
 then access all the wxPython identifiers through the wx module, for

-example, "\tt{wx.wxFrame}".
+example, "{\tt wx.wxFrame}".

 \item At line 13 the frame's sizing and moving events are connected to
 methods of the class. These helper functions are intended to be like
 the event table macros that wxWindows employs. But since static event
 tables are impossible with wxPython, we use helpers that are named the
 same to dynamically build the table. The only real difference is
 \item At line 13 the frame's sizing and moving events are connected to
 methods of the class. These helper functions are intended to be like
 the event table macros that wxWindows employs. But since static event
 tables are impossible with wxPython, we use helpers that are named the
 same to dynamically build the table. The only real difference is

-that the first arguemnt to the event helpers is always the window that
+that the first argument to the event helpers is always the window that

 the event table entry should be added to.
 the event table entry should be added to.

-\item Notice the use of \tt{wxDLG\_PNT} and \tt{wxDLG\_SZE} in lines 19
+\item Notice the use of {\tt wxDLG\_PNT} and {\tt wxDLG\_SZE} in lines 19

 - 29 to convert from dialog units to pixels. These helpers are unique
 to wxPython since Python can't do method overloading like C++.
 - 29 to convert from dialog units to pixels. These helpers are unique
 to wxPython since Python can't do method overloading like C++.

-\item There is an \tt{OnCloseWindow} method at line 34 but no call to
+\item There is an {\tt OnCloseWindow} method at line 34 but no call to

 EVT\_CLOSE to attach the event to the method. Does it really get
 called?  The answer is, yes it does. This is because many of the
 EVT\_CLOSE to attach the event to the method. Does it really get
 called?  The answer is, yes it does. This is because many of the

-\em{standard} events are attached to windows that have the associated
-\em{standard} method names. I have tried to follow the lead of the
-C++ classes in this area to determine what is \em{standard} but since
-that changes from time to time I can make no guarentees, nor will it
+{\em standard} events are attached to windows that have the associated
+{\em standard} method names. I have tried to follow the lead of the
+C++ classes in this area to determine what is {\em standard} but since
+that changes from time to time I can make no guarantees, nor will it

 be fully documented. When in doubt, use an EVT\_*** function.
 \item At lines 17 to 21 notice that there are no saved references to
 the panel or the static text items that are created. Those of you
 who know Python might be wondering what happens when Python deletes
 these objects when they go out of scope. Do they disappear from the GUI?  They
 don't. Remember that in wxPython the Python objects are just shadows of the
 be fully documented. When in doubt, use an EVT\_*** function.
 \item At lines 17 to 21 notice that there are no saved references to
 the panel or the static text items that are created. Those of you
 who know Python might be wondering what happens when Python deletes
 these objects when they go out of scope. Do they disappear from the GUI?  They
 don't. Remember that in wxPython the Python objects are just shadows of the

-coresponding C++ objects. Once the C++ windows and controls are
+corresponding C++ objects. Once the C++ windows and controls are

 attached to their parents, the parents manage them and delete them
 when necessary. For this reason, most wxPython objects do not need to
 have a \_\_del\_\_ method that explicitly causes the C++ object to be
 deleted. If you ever have the need to forcibly delete a window, use
 the Destroy() method as shown on line 36.
 \item Just like wxWindows in C++, wxPython apps need to create a class
 attached to their parents, the parents manage them and delete them
 when necessary. For this reason, most wxPython objects do not need to
 have a \_\_del\_\_ method that explicitly causes the C++ object to be
 deleted. If you ever have the need to forcibly delete a window, use
 the Destroy() method as shown on line 36.
 \item Just like wxWindows in C++, wxPython apps need to create a class

-derived from \tt{wxApp} (line 56) that implements a method named
-\tt{OnInit}, (line 59.) This method should create the application's
-main window (line 62) and use \tt{wxApp.SetTopWindow()} (line 66) to
+derived from {\tt wxApp} (line 56) that implements a method named
+{\tt OnInit}, (line 59.) This method should create the application's
+main window (line 62) and use {\tt wxApp.SetTopWindow()} (line 66) to

 inform wxWindows about it.
 \item And finally, at line 72 an instance of the application class is
 created. At this point wxPython finishes initializing itself, and calls
 inform wxWindows about it.
 \item And finally, at line 72 an instance of the application class is
 created. At this point wxPython finishes initializing itself, and calls

-the \tt{OnInit} method to get things started. (The zero parameter here is
+the {\tt OnInit} method to get things started. (The zero parameter here is

 a flag for functionality that isn't quite implemented yet. Just
 a flag for functionality that isn't quite implemented yet. Just

-ignore it for now.)  The call to \tt{MainLoop} at line 73 starts the event
+ignore it for now.)  The call to {\tt MainLoop} at line 73 starts the event

 loop which continues until the application terminates or all the top
 level windows are closed.
 \end{enumerate}
 loop which continues until the application terminates or all the top
 level windows are closed.
 \end{enumerate}


@@ -360,6 +360,7 @@ as possible to the C++ spec over time.
 \item \helpref{wxBusyCursor}{wxbusycursor}
 \item \helpref{wxButton}{wxbutton}
 \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
 \item \helpref{wxBusyCursor}{wxbusycursor}
 \item \helpref{wxButton}{wxbutton}
 \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}

+\item \helpref{wxCalendarCtrl}{wxcalendarctrl}

 \item wxCaret
 \item \helpref{wxCheckBox}{wxcheckbox}
 \item \helpref{wxCheckListBox}{wxchecklistbox}
 \item wxCaret
 \item \helpref{wxCheckBox}{wxcheckbox}
 \item \helpref{wxCheckListBox}{wxchecklistbox}


@@ -380,15 +381,19 @@ as possible to the C++ spec over time.
 \item \helpref{wxDataObject}{wxdataobject}
 \item \helpref{wxDataObjectComposite}{wxdataobjectcomposite}
 \item \helpref{wxDataObjectSimple}{wxdataobjectsimple}
 \item \helpref{wxDataObject}{wxdataobject}
 \item \helpref{wxDataObjectComposite}{wxdataobjectcomposite}
 \item \helpref{wxDataObjectSimple}{wxdataobjectsimple}

+\item \helpref{wxDateTime}{wxdatetime}
+\item \helpref{wxDateSpan}{wxdatespan}

 \item \helpref{wxDC}{wxdc}
 \item \helpref{wxDialog}{wxdialog}
 \item \helpref{wxDirDialog}{wxdirdialog}
 \item \helpref{wxDC}{wxdc}
 \item \helpref{wxDialog}{wxdialog}
 \item \helpref{wxDirDialog}{wxdirdialog}

+\item \helpref{wxDragImage}{wxdragimage}

 \item \helpref{wxDropFilesEvent}{wxdropfilesevent}
 \item \helpref{wxDropSource}{wxdropsource}
 \item \helpref{wxDropTarget}{wxdroptarget}
 \item \helpref{wxEraseEvent}{wxeraseevent}
 \item \helpref{wxEvent}{wxevent}
 \item \helpref{wxEvtHandler}{wxevthandler}
 \item \helpref{wxDropFilesEvent}{wxdropfilesevent}
 \item \helpref{wxDropSource}{wxdropsource}
 \item \helpref{wxDropTarget}{wxdroptarget}
 \item \helpref{wxEraseEvent}{wxeraseevent}
 \item \helpref{wxEvent}{wxevent}
 \item \helpref{wxEvtHandler}{wxevthandler}

+\item wxFileConfig

 \item \helpref{wxFileDataObject}{wxfiledataobject}
 \item \helpref{wxFileDialog}{wxfiledialog}
 \item \helpref{wxFileDropTarget}{wxfiledroptarget}
 \item \helpref{wxFileDataObject}{wxfiledataobject}
 \item \helpref{wxFileDialog}{wxfiledialog}
 \item \helpref{wxFileDropTarget}{wxfiledroptarget}


@@ -400,9 +405,11 @@ as possible to the C++ spec over time.
 \item \helpref{wxGauge}{wxgauge}
 \item wxGIFHandler
 \item wxGLCanvas
 \item \helpref{wxGauge}{wxgauge}
 \item wxGIFHandler
 \item wxGLCanvas

+\begin{comment}

 \item wxGridCell
 \item wxGridEvent
 \item \helpref{wxGrid}{wxgrid}
 \item wxGridCell
 \item wxGridEvent
 \item \helpref{wxGrid}{wxgrid}

+\end{comment}

 \item \helpref{wxHtmlCell}{wxhtmlcell}
 \item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
 \item \helpref{wxHtmlDCRenderer}{wxhtmldcrenderer}
 \item \helpref{wxHtmlCell}{wxhtmlcell}
 \item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
 \item \helpref{wxHtmlDCRenderer}{wxhtmldcrenderer}


@@ -504,6 +511,9 @@ as possible to the C++ spec over time.
 \item \helpref{wxTextDropTarget}{wxtextdroptarget}
 \item \helpref{wxTextEntryDialog}{wxtextentrydialog}
 \item \helpref{wxTimer}{wxtimer}
 \item \helpref{wxTextDropTarget}{wxtextdroptarget}
 \item \helpref{wxTextEntryDialog}{wxtextentrydialog}
 \item \helpref{wxTimer}{wxtimer}

+\item \helpref{wxTimerEvent}{wxtimerevent}
+\item \helpref{wxTimeSpan}{wxtimespan}
+\item \helpref{wxTipProvider}{wxtipprovider}

 \item wxToolBarTool
 \item \helpref{wxToolBar}{wxtoolbar}
 \item wxToolTip
 \item wxToolBarTool
 \item \helpref{wxToolBar}{wxtoolbar}
 \item wxToolTip


@@ -521,15 +531,16 @@ as possible to the C++ spec over time.
 \section{Where to go for help}\label{wxphelp}
 
 Since wxPython is a blending of multiple technologies, help comes from
 \section{Where to go for help}\label{wxphelp}
 
 Since wxPython is a blending of multiple technologies, help comes from

-multiple sources. See 
-\urlref{http://alldunn.com/wxPython}{http://alldunn.com/wxPython} for details on
+multiple sources. See
+\urlref{http://wxpython.org/}{http://wxpython.org/} for details on

 various sources of help, but probably the best source is the
 wxPython-users mail list. You can view the archive or subscribe by
 going to
 
 various sources of help, but probably the best source is the
 wxPython-users mail list. You can view the archive or subscribe by
 going to
 

-\urlref{http://starship.python.net/mailman/listinfo/wxpython-users}{http://starship.python.net/mailman/listinfo/wxpython-users}
+\urlref{http://wxwindows.org/mailman/listinfo/wxpython-users}{http://wxwindows.org/mailman/listinfo/wxpython-users}

 
 Or you can send mail directly to the list using this address:
 
 
 Or you can send mail directly to the list using this address:
 

-wxpython-users@starship.python.net
+wxpython-users@wxwindows.org
+