\docparam{mimetype}{MIME type string (for example 'image/jpeg')}
-Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application
+Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application
initialization in order to work with JPEGs.
\wxheading{See also}
\helpref{wxImage::LoadFile}{wximageloadfile}
+\pythonnote{Constructors supported by wxPython are:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{wxImage(name, flag)}}{Loads an image from a file}
+\twocolitem{\bf{wxNullImage()}}{Create a null image (has no size or
+image data)}
+\twocolitem{\bf{wxEmptyImage(width, height)}}{Creates an empty image
+of the given size}
+\twocolitem{\bf{wxImageFromMime(name, mimetype}}{Creates an image from
+the given file of the given mimetype}
+\twocolitem{\bf{wxImageFromBitmap(bitmap)}}{Creates an image from a
+platform-dependent bitmap}
+\end{twocollist}}
+}
+
\membersection{wxImage::\destruct{wxImage}}
\func{}{\destruct{wxImage}}{\void}
\helpref{wxImageHandler}{wximagehandler}
+\pythonnote{In wxPython this static method is named \tt{wxImage_AddHandler}.}
\membersection{wxImage::CleanUpHandlers}
\func{static void}{CleanUpHandlers}{\void}
\helpref{wxImage::SaveFile}{wximagesavefile}
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{LoadFile(filename, type)}}{Loads an image of the given
+type from a file}
+\twocolitem{\bf{LoadMimeFile(filename, mimetype)}}{Loads an image of the given
+mimetype from a file}
+\end{twocollist}}
+}
+
+
\membersection{wxImage::Ok}\label{wximageok}
\constfunc{bool}{Ok}{\void}
\helpref{wxImage::LoadFile}{wximageloadfile}
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SaveFile(filename, type)}}{Saves the image using the given
+type to the named file}
+\twocolitem{\bf{SaveMimeFile(filename, mimetype)}}{Saves the image using the given
+mimetype to the named file}
+\end{twocollist}}
+}
+
\membersection{wxImage::Scale}\label{wximagescale}
\func{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
Returns a scaled version of the image. This is also useful for
scaling bitmaps in general as the only other way to scale bitmaps
-is to blit a wxMemoryDC into another wxMemoryDC. Windows can do such
-scaling itself but in the GTK port, scaling bitmaps is done using
+is to blit a wxMemoryDC into another wxMemoryDC. Windows can do such
+scaling itself but in the GTK port, scaling bitmaps is done using
this routine internally.
\membersection{wxImage::SetData}\label{wximagesetdata}
\func{void}{SetData}{\param{unsigned char*}{data}}
-Sets the image data without performing checks. The data given must have
+Sets the image data without performing checks. The data given must have
the size (width*height*3) or results will be unexpected. Don't use this
method if you aren't sure you know what you are doing.
\helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild}
+\pythonnote{In wxPython the returned wxTreeItemId and the new cookie
+value are both returned as a tuple containing the two values.}
+
\membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
\constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void}
\helpref{wxTreeItemData}{wxtreeitemdata}
+\pythonnote{wxPython provides the following shortcut method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetPyData(item)}}{Returns the Python Object
+associated with the wxTreeItemData for the given item Id.}
+\end{twocollist}}
+}
+
\membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
\constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item}}
\wxheading{See also}
-\helpref{GetFirstChild}{wxtreectrlgetfirstchild},
+\helpref{GetFirstChild}{wxtreectrlgetfirstchild},
\helpref{GetLastChild}{wxtreectrlgetlastchild}
\membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild}
\helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild}
+\pythonnote{In wxPython the returned wxTreeItemId and the new cookie
+value are both returned as a tuple containing the two values.}
+
\membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
\constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}}
Sets the item client data.
+\pythonnote{wxPython provides the following shortcut method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetPyData(item, obj)}}{Associate the given Python
+Object with the wxTreeItemData for the given item Id.}
+\end{twocollist}}
+}
+
\membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = TRUE}}
\func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}
-Sorts the children of the given item using
+Sorts the children of the given item using
\helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
should override that method to change the sort order (default is ascending
alphabetical order).
Default constructor.
+\pythonnote{The wxPython version of this constructor optionally
+accepts any Python object as a parameter. This object is then
+associated with the tree item using the wxTreeItemData as a
+container.
+
+In addition, the following methods are added in wxPython for accessing
+the object:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetData()}}{Returns a reference to the Python Object}
+\twocolitem{\bf{SetData(obj)}}{Associates a new Python Object with the
+wxTreeItemData}
+\end{twocollist}}
+}
+
+
\membersection{wxTreeItemData::\destruct{wxTreeItemData}}
\func{void}{\destruct{wxTreeItemData}}{\void}
%----------------------------------------------------------------------
\section{What is wxPython?}\label{wxpwhat}
-wxPython is a blending of the wxWindows GUI classes and the
+wxPython is a blending of the wxWindows GUI classes and the
\urlref{Python}{http://www.python.org/} programming language.
\wxheading{Python}
-So what is Python? Go to
+So what is Python? Go to
\urlref{http://www.python.org}{http://www.python.org}
to learn more, but in a nutshell Python is an interpreted,
interactive, object-oriented programming language. It is often
I added a few minor features to SWIG to control some of the code
generation. If you want to play around with this the patches are in
wxPython/SWIG.patches and they should be applied to the 1.1p5 version
-of SWIG. These new patches are documented at
+of SWIG. These new patches are documented at
\urlref{this site}{http://starship.skyport.net/crew/robind/python/\#swig},
and they should also end up in the 1.2 version of SWIG.
will dump wxPython by setting the \tt{TARGETDIR} makefile variable.
The default is \tt{\$(WXWIN)/utils/wxPython}. If you leave it here
then you should add \tt{\$(WXWIN)/utils} to your \tt{PYTHONPATH}.
-However, you may prefer to use something that is already on your
+However, you may prefer to use something that is already on your
\tt{PYTHONPATH}, such as the \tt{site-packages} directory on Unix
systems.
\item Run \tt{nmake -f makefile.vc}
\item If it builds successfully, congratulations! Move on to the next
step. If not then you can try mailing the wxwin-developers list for
-help. Also, I will always have a pre-built win32 version of this extension module at
+help. Also, I will always have a pre-built win32 version of this extension module at
\urlref{http://alldunn.com/wxPython}{http://alldunn.com/wxPython}.
-\item Change to the \tt{\$(WXWIN)/utils/wxPython/tests} directory.
-\item Try executing the test programs. Note that some of these print
+\item Change to the \tt{\$(WXWIN)/utils/wxPython/demo} directory.
+\item Try executing the demo program. Note that some of the demos print
diagnositc or test info to standard output, so they will require the
console version of python. For example:
-\tt{python test1.py}
+\tt{python demo.py}
To run them without requiring a console, you can use the \tt{pythonw.exe}
version of Python either from the command line or from a shortcut.
\wxheading{Unix}
These directions assume that you have already successfully built
-wxWindows for GTK, and installed Python 1.5.1. If you build Python
+wxWindows for GTK, and installed Python 1.5.1 or later. If you build Python
yourself, you will get everything installed that you need simply by
doing \bftt{make install}. If you get Python from an RPM or other
pre-packaged source then there will probably be a separate package
\tt{make -f Makefile.pre.in boot}
-\item Once you have the \tt{Makefile}, run \bftt{make} to build and then
+\item Once you have the \tt{Makefile}, run \bftt{make} to build and then
\bftt{make install} to install the wxPython extension module.
-\item Change to the \tt{\$(WXWIN)/utils/wxPython/tests} directory.
-\item Try executing the test programs. For example:
+\item Change to the \tt{\$(WXWIN)/utils/wxPython/demo} directory.
+\item Try executing the demo program. For example:
-\tt{python test1.py}
+\tt{python demo.py}
\end{enumerate}
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/tests} directory, named \tt{test7.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}
- \bftt{python test7.py}
+ \bftt{python DialogUnits.py}
\end{indented}
\hrule
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
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
+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
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
+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 \helpref{wxActivateEvent}{wxactivateevent}
\item \helpref{wxBitmapButton}{wxbitmapbutton}
\item \helpref{wxBitmap}{wxbitmap}
+\item wxBMPHandler
\item \helpref{wxBrush}{wxbrush}
\item \helpref{wxButton}{wxbutton}
\item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
\item \helpref{wxFont}{wxfont}
\item \helpref{wxFrame}{wxframe}
\item \helpref{wxGauge}{wxgauge}
+\item wxGIFHandler
+\item wxGLCanvas
\item wxGridCell
\item wxGridEvent
\item \helpref{wxGrid}{wxgrid}
\item wxIconizeEvent
\item \helpref{wxIcon}{wxicon}
\item \helpref{wxIdleEvent}{wxidleevent}
+\item \helpref{wxImage}{wximage}
+\item \helpref{wxImageHandler}{wximagehandler}
\item \helpref{wxImageList}{wximagelist}
\item \helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}
\item \helpref{wxInitDialogEvent}{wxinitdialogevent}
\item \helpref{wxJoystickEvent}{wxjoystickevent}
+\item wxJPEGHandler
\item \helpref{wxKeyEvent}{wxkeyevent}
\item \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}
\item \helpref{wxLayoutConstraints}{wxlayoutconstraints}
\item \helpref{wxPalette}{wxpalette}
\item \helpref{wxPanel}{wxpanel}
\item \helpref{wxPen}{wxpen}
+\item wxPNGHandler
\item \helpref{wxPoint}{wxpoint}
\item \helpref{wxPostScriptDC}{wxpostscriptdc}
\item \helpref{wxPrintData}{wxprintdata}
\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
projects / wxWidgets.git / commitdiff
