\pythonnote{Constructors supported by wxPython are:\par
\indented{2cm}{\begin{twocollist}
\twocolitem{\bf{wxBitmap(name, flag)}}{Loads a bitmap from a file}
-\twocolitem{\bf{wxBitmap(data, type, width, height, depth=1)}}{Creates
+\twocolitem{\bf{wxBitmapFromData(data, type, width, height, depth=1)}}{Creates
a bitmap from the given data, which can be of arbitrary type.}
\twocolitem{\bf{wxNoRefBitmap(name, flag)}}{This one won't own the
reference, so Python won't call the destructor, this is good for toolbars
\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}}
-Sets minimal height of the container.
+Sets minimal height of the container.
When container's \helpref{Layout}{wxhtmlcelllayout} is called, m\_Height
is set depending on layout of subcells to the height of area covered
\func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}}
-Sets floating width adjustment.
+Sets floating width adjustment.
-The normal behaviour of container is that its width is the same as the width of
+The normal behaviour of container is that its width is the same as the width of
parent container (and thus you can have only one sub-container per line).
You can change this by setting FWA.
\wxheading{Parameters}
\docparam{w}{Width of the container. If the value is negative it means
-complement to full width of parent container (e.g.
+complement to full width of parent container (e.g.
{\tt SetWidthFloat(-50, HTML\_UNITS\_PIXELS)} sets the width
of container to parent's width minus 50 pixels. This is useful when
creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50))}
\docparam{tag}{In the second version of method, {\it w} and {\it units}
info is extracted from tag's {\tt WIDTH} parameter.}
+\pythonnote{The second form of this method is named
+SetWidthFloatFromTag in wxPython.}
+
+
+
+
+
+
+
+
wxHelpController!}
This help controller provides an easy way of displaying HTML help in your
-application (see {\it test} sample). The help system is based on {\bf books}
+application (see {\it test} sample). The help system is based on {\bf books}
(see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical
section of documentation (for example "User's Guide" or "Programmer's Guide" or
"C++ Reference" or "wxWindows Reference"). The help controller can handle as
\item as direct filename of HTML document
\item as chapter name (from contents) or as a book name
\item as some word from index
-\item even as any word (will be searched)
+\item even as any word (will be searched)
\end{itemize}
Looking for the page runs in these steps:
This alternative form is used to search help contents by numeric IDs.
+\pythonnote{The second form of this method is named DisplayId in
+wxPython.}
+
\membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
\func{void}{DisplayContents}{\void}
Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
forms are much faster to read. Default value is empty string (empty string means
-that no cached data are stored). Note that these files are {\it not}
+that no cached data are stored). Note that these files are {\it not}
deleted when program exits.
\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
If there is associated config object, wxHtmlHelpController automatically
reads and writes settings (including wxHtmlWindow's settings) when needed.
-The only thing you must do is create wxConfig object and call UseConfig.
+The only thing you must do is create wxConfig object and call UseConfig.
\membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
to display help.
-It is internal class and should not be used directly - except for the case
+It is internal class and should not be used directly - except for the case
you're writing your own HTML help controller.
The second form takes numeric ID as the parameter.
(uses extension to MS format, <param name="ID" value=id>)
+\pythonnote{The second form of this method is named DisplayId in
+wxPython.}
+
\membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
\func{bool}{DisplayContents}{\void}
%\special{!/@scaleunit 1 def}
\parskip=10pt
\parindent=0pt
-\title{wxWindows 2.1: a portable C++ GUI toolkit}
+\title{wxWindows 2.1: a portable C++ and Python GUI toolkit}
\winhelponly{\author{by Julian Smart et al
%\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
}}
-\winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin et al}
-\date{August 27th 1999}
+\winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
+Robin Dunn, et al}
+\date{November 1st 1999}
}
\makeindex
\begin{document}
the scrollbars will scroll a different window.
Note that the underlying system knows nothing about scrolling coordinates, so that all system
-functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows
+functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows
are relative to the "physical" origin of the scrolled window. If the user insert a child window at
position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible
area), the child window will report a position of (10,-90).
\helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition}
+\pythonnote{The wxPython version of this methods accepts only two
+parameters and returns xx and yy as a tuple of values.}
+
\membersection{wxScrolledWindow::CalcUnscrolledPosition}\label{wxscrolledwindowcalcunscrolledposition}
\constfunc{void}{CalcUnscrolledPosition}{
\helpref{CalcScrolledPosition}{wxscrolledwindowcalcscrolledposition}
+\pythonnote{The wxPython version of this methods accepts only two
+parameters and returns xx and yy as a tuple of values.}
+
\membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp
\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
\helpref{wxScrolledWindow::GetVirtualSize}{wxscrolledwindowgetvirtualsize}
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for xUnit and yUnit.}
+
+
\membersection{wxScrolledWindow::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize}
\constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}}
\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
\helpref{wxScrolledWindow::GetScrollPixelsPerUnit}{wxscrolledwindowgetscrollpixelsperunit}
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for x and y.}
+
\membersection{wxScrolledWindow::IsRetained}\label{wxscrolledwindowisretained}
\constfunc{bool}{IsRetained}{\void}
\func{virtual void}{OnDraw}{\param{wxDC\& }{dc}}
Called by the default paint event handler to allow the application to define
-painting behaviour without having to worry about calling
+painting behaviour without having to worry about calling
\helpref{wxScrolledWindow::PrepareDC}{wxscrolledwindowpreparedc}.
Instead of overriding this function you may also just process the paint event
\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for x and y.}
+
// key code is within legal range. we call event.Skip() so the
// event can be processed either in the base wxWindows class
// or the native control.
-
- event.Skip();
+
+ event.Skip();
}
else
{
// illegal key hit. we don't call event.Skip() so the
// event is not processed anywhere else.
-
+
wxBell();
}
}
\item Finally, {\bf ProcessEvent} is called on the wxApp object.
\end{enumerate}
+{\bf Pay close attention to Step 5.} People often overlook or get
+confused by this powerful feature of the wxWindows event processing
+system. To put it a different way, events derived either directly or
+indirectly from wxCommandEvent will travel up the containment
+heirarchy from child to parent until an event handler is found that
+doesn't call event.Skip(). Events not derived from wxCommandEvent are
+sent only to the window they occurred in and then stop.
+
+Typically events that deal with a window as a window (size, motion,
+paint, mouse, keyboard, etc.) are sent only to the window. Events
+that have a higher level of meaning and/or are generated by the window
+itself, (button click, menu select, tree expand, etc.) are command
+events and are sent up to the parent to see if it is interested in the
+event.
+
Note that your application may wish to override ProcessEvent to redirect processing of
events. This is done in the document/view framework, for example, to allow event handlers
to be defined in the document or view. To test for command events (which will probably
Returns the platform-specific handle of the physical window. Cast it to an appropriate
handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget} for GTK.
+\pythonnote{This method will return an integer in wxPython.}
+
\membersection{wxWindow::GetId}\label{wxwindowgetid}
\constfunc{int}{GetId}{\void}
\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{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{wxHtmlPrintout}{wxhtmlprintout}
\item \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}
\item \helpref{wxHtmlWindow}{wxhtmlwindow}
\item wxIconizeEvent
projects / wxWidgets.git / commitdiff
