the in-place control uses the attr for colours/font info too

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

diff --git a/docs/latex/wx/wxPython.tex b/docs/latex/wx/wxPython.tex
index 37a22553afdc284630392aeeaf20a6c2e8b8bd95..53d6881842b571bc588b7d00710cb62b7b715396 100644 (file)
--- a/docs/latex/wx/wxPython.tex
+++ b/docs/latex/wx/wxPython.tex
@@ -1,5 +1,5 @@
 \chapter{wxPython Notes}\label{wxPython}
 \chapter{wxPython Notes}\label{wxPython}

-\pagenumbering{arabic}%
+

 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 


@@ -113,7 +113,7 @@ to use the GUI portions.
 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
 wrappers around some C or C++ toolkit or another, and most are not
 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
 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.
 
 %----------------------------------------------------------------------


@@ -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


@@ -159,18 +159,15 @@ 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.
 
 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,
 \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{python \%WXWIN/utils/wxPython/distrib/build.py \%1 \%2 \%3 \%4 \%5 \%6}
+ {\tt build}.bat in a directory on the PATH that contains:

 
 

-\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.
 
 The build.py script actually generates a Makefile based on what it
 finds on your system and information found in the build.cfg file.


@@ -178,19 +175,16 @@ 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
 build.local.
 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
 build.local.

-

 \item To build and install the add-on modules, change to the appropriate
 \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}
 


@@ -205,12 +199,12 @@ 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:
 
 \begin{indented}{1cm}
 Python and wxPython are properly installed, you should be able to run
 it by issuing this command:
 
 \begin{indented}{1cm}

-    \bftt{python DialogUnits.py}
+    {\bf\tt python DialogUnits.py}

 \end{indented}
 
 \hrule
 \end{indented}
 
 \hrule


@@ -295,13 +289,12 @@ it by issuing this command:
 
 \wxheading{Things to notice}
 
 
 \wxheading{Things to notice}
 

-\begin{enumerate}\itemsep=0pt
+\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
 \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
 \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


@@ -309,20 +302,17 @@ 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
 the event table entry should be added to.
 same to dynamically build the table. The only real difference is
 that the first arguemnt to the event helpers is always the window that
 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
+{\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
 be fully documented. When in doubt, use an EVT\_*** function.
 that changes from time to time I can make no guarentees, 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
 \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


@@ -334,18 +324,16 @@ 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.
 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
 \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.
 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
 \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}


@@ -362,11 +350,14 @@ as possible to the C++ spec over time.
 \item \helpref{wxAcceleratorEntry}{wxacceleratorentry}
 \item \helpref{wxAcceleratorTable}{wxacceleratortable}
 \item \helpref{wxActivateEvent}{wxactivateevent}
 \item \helpref{wxAcceleratorEntry}{wxacceleratorentry}
 \item \helpref{wxAcceleratorTable}{wxacceleratortable}
 \item \helpref{wxActivateEvent}{wxactivateevent}

-\item \helpref{wxBitmapButton}{wxbitmapbutton}

 \item \helpref{wxBitmap}{wxbitmap}
 \item \helpref{wxBitmap}{wxbitmap}

+\item \helpref{wxBitmapButton}{wxbitmapbutton}
+\item \helpref{wxBitmapDataObject}{wxbitmapdataobject}

 \item wxBMPHandler
 \item \helpref{wxBoxSizer}{wxboxsizer}
 \item \helpref{wxBrush}{wxbrush}
 \item wxBMPHandler
 \item \helpref{wxBoxSizer}{wxboxsizer}
 \item \helpref{wxBrush}{wxbrush}

+\item \helpref{wxBusyInfo}{wxbusyinfo}
+\item \helpref{wxBusyCursor}{wxbusycursor}

 \item \helpref{wxButton}{wxbutton}
 \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
 \item wxCaret
 \item \helpref{wxButton}{wxbutton}
 \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
 \item wxCaret


@@ -374,6 +365,7 @@ as possible to the C++ spec over time.
 \item \helpref{wxCheckListBox}{wxchecklistbox}
 \item \helpref{wxChoice}{wxchoice}
 \item \helpref{wxClientDC}{wxclientdc}
 \item \helpref{wxCheckListBox}{wxchecklistbox}
 \item \helpref{wxChoice}{wxchoice}
 \item \helpref{wxClientDC}{wxclientdc}

+\item \helpref{wxClipboard}{wxclipboard}

 \item \helpref{wxCloseEvent}{wxcloseevent}
 \item \helpref{wxColourData}{wxcolourdata}
 \item \helpref{wxColourDialog}{wxcolourdialog}
 \item \helpref{wxCloseEvent}{wxcloseevent}
 \item \helpref{wxColourData}{wxcolourdata}
 \item \helpref{wxColourDialog}{wxcolourdialog}


@@ -383,14 +375,23 @@ as possible to the C++ spec over time.
 \item \helpref{wxConfig}{wxconfigbase}
 \item \helpref{wxControl}{wxcontrol}
 \item \helpref{wxCursor}{wxcursor}
 \item \helpref{wxConfig}{wxconfigbase}
 \item \helpref{wxControl}{wxcontrol}
 \item \helpref{wxCursor}{wxcursor}

+\item \helpref{wxCustomDataObject}{wxcustomdataobject}
+\item \helpref{wxDataFormat}{wxdataformat}
+\item \helpref{wxDataObject}{wxdataobject}
+\item \helpref{wxDataObjectComposite}{wxdataobjectcomposite}
+\item \helpref{wxDataObjectSimple}{wxdataobjectsimple}

 \item \helpref{wxDC}{wxdc}
 \item \helpref{wxDialog}{wxdialog}
 \item \helpref{wxDirDialog}{wxdirdialog}
 \item \helpref{wxDropFilesEvent}{wxdropfilesevent}
 \item \helpref{wxDC}{wxdc}
 \item \helpref{wxDialog}{wxdialog}
 \item \helpref{wxDirDialog}{wxdirdialog}
 \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{wxEraseEvent}{wxeraseevent}
 \item \helpref{wxEvent}{wxevent}
 \item \helpref{wxEvtHandler}{wxevthandler}

+\item \helpref{wxFileDataObject}{wxfiledataobject}

 \item \helpref{wxFileDialog}{wxfiledialog}
 \item \helpref{wxFileDialog}{wxfiledialog}

+\item \helpref{wxFileDropTarget}{wxfiledroptarget}

 \item \helpref{wxFocusEvent}{wxfocusevent}
 \item \helpref{wxFontData}{wxfontdata}
 \item \helpref{wxFontDialog}{wxfontdialog}
 \item \helpref{wxFocusEvent}{wxfocusevent}
 \item \helpref{wxFontData}{wxfontdata}
 \item \helpref{wxFontDialog}{wxfontdialog}


@@ -404,10 +405,13 @@ as possible to the C++ spec over time.
 \item \helpref{wxGrid}{wxgrid}
 \item \helpref{wxHtmlCell}{wxhtmlcell}
 \item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
 \item \helpref{wxGrid}{wxgrid}
 \item \helpref{wxHtmlCell}{wxhtmlcell}
 \item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}

+\item \helpref{wxHtmlDCRenderer}{wxhtmldcrenderer}
+\item \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}

 \item \helpref{wxHtmlParser}{wxhtmlparser}
 \item \helpref{wxHtmlTagHandler}{wxhtmltaghandler}
 \item \helpref{wxHtmlTag}{wxhtmltag}
 \item \helpref{wxHtmlWinParser}{wxhtmlwinparser}
 \item \helpref{wxHtmlParser}{wxhtmlparser}
 \item \helpref{wxHtmlTagHandler}{wxhtmltaghandler}
 \item \helpref{wxHtmlTag}{wxhtmltag}
 \item \helpref{wxHtmlWinParser}{wxhtmlwinparser}

+\item \helpref{wxHtmlPrintout}{wxhtmlprintout}

 \item \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}
 \item \helpref{wxHtmlWindow}{wxhtmlwindow}
 \item wxIconizeEvent
 \item \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}
 \item \helpref{wxHtmlWindow}{wxhtmlwindow}
 \item wxIconizeEvent


@@ -490,12 +494,14 @@ as possible to the C++ spec over time.
 \item \helpref{wxStaticBitmap}{wxstaticbitmap}
 \item \helpref{wxStaticBox}{wxstaticbox}
 \item \helpref{wxStaticBoxSizer}{wxstaticboxsizer}
 \item \helpref{wxStaticBitmap}{wxstaticbitmap}
 \item \helpref{wxStaticBox}{wxstaticbox}
 \item \helpref{wxStaticBoxSizer}{wxstaticboxsizer}

-\item wxStaticLine
+\item \helpref{wxStaticLine}{wxstaticline}

 \item \helpref{wxStaticText}{wxstatictext}
 \item \helpref{wxStatusBar}{wxstatusbar}
 \item \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
 \item \helpref{wxTaskBarIcon}{wxtaskbaricon}
 \item \helpref{wxTextCtrl}{wxtextctrl}
 \item \helpref{wxStaticText}{wxstatictext}
 \item \helpref{wxStatusBar}{wxstatusbar}
 \item \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
 \item \helpref{wxTaskBarIcon}{wxtaskbaricon}
 \item \helpref{wxTextCtrl}{wxtextctrl}

+\item \helpref{wxTextDataObject}{wxtextdataobject}
+\item \helpref{wxTextDropTarget}{wxtextdroptarget}

 \item \helpref{wxTextEntryDialog}{wxtextentrydialog}
 \item \helpref{wxTimer}{wxtimer}
 \item wxToolBarTool
 \item \helpref{wxTextEntryDialog}{wxtextentrydialog}
 \item \helpref{wxTimer}{wxtimer}
 \item wxToolBarTool


@@ -509,16 +515,13 @@ as possible to the C++ spec over time.
 \item \helpref{wxValidator}{wxvalidator}
 \item \helpref{wxWindowDC}{wxwindowdc}
 \item \helpref{wxWindow}{wxwindow}
 \item \helpref{wxValidator}{wxvalidator}
 \item \helpref{wxWindowDC}{wxwindowdc}
 \item \helpref{wxWindow}{wxwindow}

-
-
-

 \end{itemize}
 
 %----------------------------------------------------------------------
 \section{Where to go for help}\label{wxphelp}
 
 Since wxPython is a blending of multiple technologies, help comes from
 \end{itemize}
 
 %----------------------------------------------------------------------
 \section{Where to go for help}\label{wxphelp}
 
 Since wxPython is a blending of multiple technologies, help comes from

-multiple sources. See
+multiple sources. See 

 \urlref{http://alldunn.com/wxPython}{http://alldunn.com/wxPython} 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
 \urlref{http://alldunn.com/wxPython}{http://alldunn.com/wxPython} 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