mirror of
https://github.com/wxWidgets/wxWidgets.git
synced 2026-09-23 14:45:04 +08:00
Added first batch of docs and notes for wxPython.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -16,10 +16,10 @@ either monochrome or colour.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxBitmap overview}{wxbitmapoverview},
|
||||
\helpref{supported bitmap file formats}{supportedbitmapformats},
|
||||
\helpref{wxDC::Blit}{wxdcblit},
|
||||
\helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxBitmap}{wxbitmap},
|
||||
\helpref{wxBitmap overview}{wxbitmapoverview},
|
||||
\helpref{supported bitmap file formats}{supportedbitmapformats},
|
||||
\helpref{wxDC::Blit}{wxdcblit},
|
||||
\helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxBitmap}{wxbitmap},
|
||||
\helpref{wxMemoryDC}{wxmemorydc}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -128,6 +128,17 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.
|
||||
|
||||
\helpref{wxBitmap::LoadFile}{wxbitmaploadfile}
|
||||
|
||||
\pythonnote{Constructors supported by wxPython are:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{wxBitmap(name, flag)}}{Loads a bitmap from a file}
|
||||
\twocolitem{\bf{wxNoRefBitmap(name, flag)}}{This one won't own the
|
||||
reference, so Python won't call the destructor, this is good for toolbars
|
||||
and such where the parent will manage the bitmap.}
|
||||
\twocolitem{\bf{wxEmptyBitmap(width, height, depth=-1)}}{Creates an
|
||||
empty bitmap with the given specifications}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxBitmap::\destruct{wxBitmap}}
|
||||
|
||||
\func{}{\destruct{wxBitmap}}{\void}
|
||||
|
||||
@@ -68,6 +68,10 @@ appropriately.}
|
||||
|
||||
\docparam{name}{Window name.}
|
||||
|
||||
\pythonnote{The wxCheckListBox constructor in wxPython reduces the \tt{n}
|
||||
and \tt{choices} arguments are to a single argument, which is
|
||||
a list of strings.}
|
||||
|
||||
\membersection{wxCheckListBox::\destruct{wxCheckListBox}}
|
||||
|
||||
\func{void}{\destruct{wxCheckListBox}}{\void}
|
||||
|
||||
@@ -74,6 +74,10 @@ appropriately.}
|
||||
|
||||
\helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
|
||||
|
||||
\pythonnote{The wxChoice constructor in wxPython reduces the \tt{n}
|
||||
and \tt{choices} arguments are to a single argument, which is
|
||||
a list of strings.}
|
||||
|
||||
\membersection{wxChoice::\destruct{wxChoice}}
|
||||
|
||||
\func{}{\destruct{wxChoice}}{\void}
|
||||
|
||||
@@ -57,6 +57,14 @@ Copy constructor.
|
||||
|
||||
\helpref{wxColourDatabase}{wxcolourdatabase}
|
||||
|
||||
\pythonnote{Constructors supported by wxPython are:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{wxColour(red=0, green=0, blue=0)}}{}
|
||||
\twocolitem{\bf{wxNamedColour(name)}}{}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
|
||||
\membersection{wxColour::Blue}\label{wxcolourblue}
|
||||
|
||||
\constfunc{unsigned char}{Blue}{\void}
|
||||
|
||||
@@ -85,6 +85,11 @@ appropriately.}
|
||||
|
||||
\helpref{wxComboBox::Create}{wxcomboboxcreate}, \helpref{wxValidator}{wxvalidator}
|
||||
|
||||
\pythonnote{The wxComboBox constructor in wxPython reduces the \tt{n}
|
||||
and \tt{choices} arguments are to a single argument, which is
|
||||
a list of strings.}
|
||||
|
||||
|
||||
\membersection{wxComboBox::\destruct{wxComboBox}}
|
||||
|
||||
\func{}{\destruct{wxComboBox}}{\void}
|
||||
|
||||
@@ -128,6 +128,14 @@ Note that not all cursors are available on all platforms.}
|
||||
|
||||
\docparam{cursor}{Pointer or reference to a cursor to copy.}
|
||||
|
||||
\pythonnote{Constructors supported by wxPython are:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{wxCursor(name, flags, hotSpotX=0,
|
||||
hotSpotY=0)}}{Constructs a cursor from a filename}
|
||||
\twocolitem{\bf{wxStockCursor(id)}}{Constructs a stock cursor }
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxCursor::\destruct{wxCursor}}
|
||||
|
||||
\func{}{\destruct{wxCursor}}{\void}
|
||||
|
||||
+25
-2
@@ -187,14 +187,14 @@ filling the shape.
|
||||
\func{void}{DrawEllipticArc}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height},
|
||||
\param{double}{ start}, \param{double}{ end}}
|
||||
|
||||
Draws an arc of an ellipse. The current pen is used for drawing the arc and
|
||||
Draws an arc of an ellipse. The current pen is used for drawing the arc and
|
||||
the current brush is used for drawing the pie. This function is currently only available for
|
||||
X window and PostScript device contexts.
|
||||
|
||||
{\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
|
||||
the ellipse.
|
||||
|
||||
{\it width} and {\it height} specify the width and height of the rectangle that contains
|
||||
{\it width} and {\it height} specify the width and height of the rectangle that contains
|
||||
the ellipse.
|
||||
|
||||
{\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock
|
||||
@@ -228,6 +228,9 @@ pointers to points, adding the optional offset coordinate. The current
|
||||
pen is used for drawing the lines. The programmer is responsible for
|
||||
deleting the list of points.
|
||||
|
||||
\pythonnote{The wxPython version of this method accepts a Python list
|
||||
of wxPoint objects.}
|
||||
|
||||
\membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
|
||||
|
||||
\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0},\\
|
||||
@@ -248,6 +251,9 @@ The programmer is responsible for deleting the list of points.
|
||||
|
||||
Note that wxWindows automatically closes the first and last points.
|
||||
|
||||
\pythonnote{The wxPython version of this method accepts a Python list
|
||||
of wxPoint objects.}
|
||||
|
||||
\membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
|
||||
|
||||
\func{void}{DrawPoint}{\param{long}{ x}, \param{long}{ y}}
|
||||
@@ -292,6 +298,9 @@ program `XFIG'.
|
||||
|
||||
Draws a three-point spline using the current pen.
|
||||
|
||||
\pythonnote{The wxPython version of this method accepts a Python list
|
||||
of wxPoint objects.}
|
||||
|
||||
\membersection{wxDC::DrawText}\label{wxdcdrawtext}
|
||||
|
||||
\func{void}{DrawText}{\param{const wxString\& }{text}, \param{long}{ x}, \param{long}{ y}}
|
||||
@@ -368,6 +377,9 @@ Gets the average character width of the currently set font.
|
||||
|
||||
Gets the rectangle surrounding the current clipping region.
|
||||
|
||||
\pythonnote{No arguments are required and the four values defining the
|
||||
rectangle are returned as a tuple.}
|
||||
|
||||
\membersection{wxDC::GetFont}\label{wxdcgetfont}
|
||||
|
||||
\func{wxFont\&}{GetFont}{\void}
|
||||
@@ -428,6 +440,9 @@ printer page:
|
||||
dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
|
||||
\end{verbatim}
|
||||
|
||||
\pythonnote{No arguments are required and the two values defining the
|
||||
size are returned as a tuple.}
|
||||
|
||||
\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
|
||||
|
||||
\func{wxColour\&}{GetTextBackground}{\void}
|
||||
@@ -453,6 +468,14 @@ the device context first.
|
||||
|
||||
See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
|
||||
|
||||
\pythonnote{The following methods are implemented in wxPython:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
|
||||
\twocolitem{\bf{GetFullTextExtent(string, font=NULL)}}{Returns a
|
||||
4-tuple, (width, height, descent, externalLeading) }
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
|
||||
|
||||
\func{wxColour\&}{GetTextForeground}{\void}
|
||||
|
||||
@@ -79,6 +79,14 @@ The new zero-based image index.
|
||||
|
||||
The original bitmap or icon is not affected by the {\bf Add} operation, and can be deleted afterwards.
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{Add(bitmap, mask=wxNullBitmap)}}{}
|
||||
\twocolitem{\bf{AddWithColourMask(bitmap, colour)}}{}
|
||||
\twocolitem{\bf{AddIcon(icon)}}{}
|
||||
\end{twocollist}}
|
||||
}
|
||||
\membersection{wxImageList::Create}\label{wximagelistcreate}
|
||||
|
||||
\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp
|
||||
@@ -161,4 +169,6 @@ TRUE if the replacement was successful, FALSE otherwise.
|
||||
|
||||
The original bitmap or icon is not affected by the {\bf Replace} operation, and can be deleted afterwards.
|
||||
|
||||
\pythonnote{The second form is called \tt{ReplaceIcon} in wxPython.}
|
||||
|
||||
|
||||
|
||||
@@ -95,6 +95,12 @@ appropriately.}
|
||||
|
||||
\helpref{wxListBox::Create}{wxlistboxcreate}, \helpref{wxValidator}{wxvalidator}
|
||||
|
||||
\pythonnote{The wxListBox constructor in wxPython reduces the \tt{n}
|
||||
and \tt{choices} arguments are to a single argument, which is
|
||||
a list of strings.}
|
||||
|
||||
|
||||
|
||||
\membersection{wxListBox::\destruct{wxListBox}}
|
||||
|
||||
\func{void}{\destruct{wxListBox}}{\void}
|
||||
|
||||
@@ -85,9 +85,9 @@
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
|
||||
\begin{center}
|
||||
Copyright (c) 1998 Julian Smart, Robert Roebling and other
|
||||
Copyright \copyright{} 1998 Julian Smart, Robert Roebling and other
|
||||
members of the wxWindows team\\
|
||||
Portions (c) 1996 Artificial Intelligence Applications Institute\\
|
||||
Portions \copyright{} 1996 Artificial Intelligence Applications Institute\\
|
||||
\end{center}
|
||||
|
||||
Please see the wxWindows licence files (preamble.txt, lgpl.txt, gpl.txt, licence.txt,
|
||||
@@ -97,6 +97,7 @@ licendoc.txt) for conditions of software and documentation use.
|
||||
\helpinput{classes.tex}
|
||||
\helpinput{category.tex}
|
||||
\helpinput{topics.tex}
|
||||
\helpinput{wxPython.tex}
|
||||
|
||||
\begin{comment}
|
||||
\newpage
|
||||
|
||||
@@ -434,6 +434,10 @@ automatically by the client window.
|
||||
\helpref{wxWindow}{wxwindowonsize},\rtfsp
|
||||
\helpref{wxMDIClientWindow}{wxmdiclientwindow}
|
||||
|
||||
|
||||
\pythonnote{The wxPython version of this method takes no arguments and
|
||||
returns a tuple containing width and height.}
|
||||
|
||||
\membersection{wxMDIParentFrame::GetActiveChild}\label{wxmdiparentframegetactivechild}
|
||||
|
||||
\constfunc{wxMDIChildFrame*}{GetActiveChild}{\void}
|
||||
|
||||
@@ -51,6 +51,15 @@ Constructs a wxMenu object.
|
||||
|
||||
\docparam{func}{A callback function if the menu is used as a popup using \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu}.}
|
||||
|
||||
\pythonnote{The wxPython version of the \tt{wxMenu} constructor
|
||||
doesn't accept the callback argument because of reference counting
|
||||
issues. There is a specialized wxMenu constructor called
|
||||
\tt{wxPyMenu} which does and can be used for PopupMenus when callbacks
|
||||
are needed. You must retain a reference to the menu while useing it
|
||||
otherwise your callback function will get dereferenced when the menu
|
||||
does.
|
||||
}
|
||||
|
||||
\membersection{wxMenu::\destruct{wxMenu}}
|
||||
|
||||
\func{}{\destruct{wxMenu}}{\void}
|
||||
@@ -108,6 +117,17 @@ creation of a menu or menubar.
|
||||
\helpref{wxMenu::AppendSeparator}{wxmenuappendseparator}, \helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp
|
||||
\helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem}
|
||||
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{Append(id, string, helpStr="", checkable=FALSE)}}{}
|
||||
\twocolitem{\bf{AppendMenu(id, string, aMenu, helpStr="")}}{}
|
||||
\twocolitem{\bf{AppendItem(aMenuItem)}}{}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
|
||||
\membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
|
||||
|
||||
\func{void}{AppendSeparator}{\void}
|
||||
@@ -389,6 +409,10 @@ menu bar.}
|
||||
|
||||
\docparam{titles}{An array of title strings. Deallocate this array after creating the menu bar.}
|
||||
|
||||
\pythonnote{Only the default constructor is supported in wxPython.
|
||||
Use wxMenuBar.Append instead.}
|
||||
|
||||
|
||||
\membersection{wxMenuBar::\destruct{wxMenuBar}}
|
||||
|
||||
\func{void}{\destruct{wxMenuBar}}{\void}
|
||||
|
||||
@@ -86,6 +86,11 @@ radiobox.}
|
||||
|
||||
\helpref{wxRadioBox::Create}{wxradioboxcreate}, \helpref{wxValidator}{wxvalidator}
|
||||
|
||||
\pythonnote{The wxRadioBox constructor in wxPython reduces the \tt{n}
|
||||
and \tt{choices} arguments are to a single argument, which is
|
||||
a list of strings.}
|
||||
|
||||
|
||||
\membersection{wxRadioBox::\destruct{wxRadioBox}}
|
||||
|
||||
\func{}{\destruct{wxRadioBox}}{\void}
|
||||
|
||||
@@ -285,6 +285,8 @@ Resets the iterator to the given region.
|
||||
|
||||
Increment operator. Increments the iterator to the next region.
|
||||
|
||||
\pythonnote{A wxPython alias for this operator is called \tt{Next}.}
|
||||
|
||||
\membersection{wxRegionIterator::operator bool}
|
||||
|
||||
\constfunc{}{operator bool}{\void}
|
||||
|
||||
@@ -3,6 +3,12 @@
|
||||
A {\bf wxSize} is a useful data structure for graphics operations.
|
||||
It simply contains integer {\it x} and {\it y} members.
|
||||
|
||||
\pythonnote{wxPython defines aliases for the \tt{x} and \tt{y} members
|
||||
named \tt{width} and \tt{height} since it makes much more sense for
|
||||
sizes. There is also coresponding aliases for the \tt{GetWidth} and
|
||||
\tt{GetHeight} methods.
|
||||
}
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
None
|
||||
|
||||
@@ -26,7 +26,8 @@ combineSubSections = yes
|
||||
\const [0] {{\bf const}}
|
||||
\constfunc [3] {{\bf #1} {\bf #2}(#3) {\bf const}\index{#2}}
|
||||
\windowstyle [1] {{\bf #1}\index{#1}}
|
||||
%\pythonnote [1] {{\bf wxPython note: }#1}
|
||||
\pythonnote [1] {}
|
||||
\bftt [1] {\bf{\tt{#1}}}
|
||||
\pythonnote [1] {{\bf \fcol{blue}{wxPython note:}}\\ #1}
|
||||
%\pythonnote [1] {}
|
||||
|
||||
|
||||
|
||||
+117
-5
@@ -164,6 +164,15 @@ a screen coordinate will be passed out.}
|
||||
|
||||
\docparam{pt}{The client position for the second form of the function.}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{ClientToScreen(point)}}{Accepts and returns a wxPoint}
|
||||
\twocolitem{\bf{ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
|
||||
\membersection{wxWindow::Close}\label{wxwindowclose}
|
||||
|
||||
\func{virtual bool}{Close}{\param{const bool}{ force = FALSE}}
|
||||
@@ -225,6 +234,23 @@ You can also use these functions programmatically. A convenience macro is define
|
||||
|
||||
\helpref{wxWindow::ConvertPixelsToDialog}{wxwindowconvertpixelstodialog}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
|
||||
\twocolitem{\bf{ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
|
||||
\end{twocollist}}
|
||||
|
||||
Additionally, the following helper functions are defined:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{wxDLG_PNT(win, point)}}{Converts a wxPoint from dialog
|
||||
units to pixels}
|
||||
\twocolitem{\bf{wxDLG_SZE(win, size)}}{Converts a wxSize from dialog
|
||||
units to pixels}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
|
||||
\membersection{wxWindow::ConvertPixelsToDialog}\label{wxwindowconvertpixelstodialog}
|
||||
|
||||
\func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}}
|
||||
@@ -248,6 +274,15 @@ Dialogs created using Dialog Editor optionally use dialog units.
|
||||
|
||||
\helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels}
|
||||
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
|
||||
\twocolitem{\bf{ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::Destroy}\label{wxwindowdestroy}
|
||||
|
||||
\func{virtual bool}{Destroy}{\void}
|
||||
@@ -327,6 +362,14 @@ Find a child of this window, by identifier.
|
||||
|
||||
Find a child of this window, by name.
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{FindWindowById(id)}}{Accepts an integer}
|
||||
\twocolitem{\bf{FindWindowByName(name)}}{Accepts a string}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::Fit}\label{wxwindowfit}
|
||||
|
||||
\func{virtual void}{Fit}{\void}
|
||||
@@ -379,6 +422,14 @@ area which may be drawn on by the programmer, excluding title bar, border etc.
|
||||
|
||||
\docparam{height}{Receives the client height in pixels.}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{wxGetClientSizeTuple()}}{Returns a 2-tuple of (width, height)}
|
||||
\twocolitem{\bf{wxGetClientSize()}}{Returns a wxSize object}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints}
|
||||
|
||||
\constfunc{wxLayoutConstraints*}{GetConstraints}{\void}
|
||||
@@ -399,7 +450,7 @@ Returns the associated drop target, which may be NULL.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
|
||||
\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
|
||||
\helpref{Drag and drop overview}{wxdndoverview}
|
||||
|
||||
\membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler}
|
||||
@@ -487,6 +538,14 @@ if no parent, relative to the whole display.
|
||||
|
||||
\docparam{y}{Receives the y position of the window.}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{GetPosition()}}{Returns a wxPoint}
|
||||
\twocolitem{\bf{GetPositionTuple()}}{Returns a tuple (x, y)}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::GetLabel}
|
||||
|
||||
\constfunc{virtual wxString\& }{GetLabel}{\void}
|
||||
@@ -589,6 +648,14 @@ This gets the size of the entire window in pixels.
|
||||
|
||||
\docparam{height}{Receives the window height.}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{GetSize()}}{Returns a wxSize}
|
||||
\twocolitem{\bf{GetSizeTuple()}}{Returns a 2-tuple (width, height)}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::GetTextExtent}
|
||||
|
||||
\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y},
|
||||
@@ -614,6 +681,17 @@ window with the currently selected font.
|
||||
|
||||
\docparam{use16}{If TRUE, {\it string} contains 16-bit characters. The default is FALSE.}
|
||||
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
|
||||
\twocolitem{\bf{GetFullTextExtent(string, font=NULL)}}{Returns a
|
||||
4-tuple, (width, height, descent, externalLeading) }
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
|
||||
\membersection{wxWindow::GetTitle}\label{wxwindowgettitle}
|
||||
|
||||
\func{virtual wxString}{GetTitle}{\void}
|
||||
@@ -754,6 +832,14 @@ as the call:
|
||||
|
||||
\helpref{wxWindow::SetSize}{wxwindowsetsize}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{Move(point)}}{Accepts a wxPoint}
|
||||
\twocolitem{\bf{MoveXY(x, y)}}{Accepts a pair of integers}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
|
||||
|
||||
\func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
|
||||
@@ -795,7 +881,7 @@ Note that the ASCII values do not have explicit key codes: they are passed as AS
|
||||
values.
|
||||
|
||||
Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
|
||||
keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
|
||||
keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
|
||||
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
|
||||
|
||||
Most, but not all, windows allow keypresses to be intercepted.
|
||||
@@ -990,7 +1076,7 @@ use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown}
|
||||
default function to achieve default keypress functionality.
|
||||
|
||||
Note that not all keypresses can be intercepted this way. If you wish to intercept special
|
||||
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
|
||||
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
|
||||
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
|
||||
|
||||
Most, but not all, windows allow keypresses to be intercepted.
|
||||
@@ -1019,7 +1105,7 @@ use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} hand
|
||||
default function to achieve default keypress functionality.
|
||||
|
||||
Note that not all keypresses can be intercepted this way. If you wish to intercept special
|
||||
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
|
||||
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
|
||||
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
|
||||
|
||||
Most, but not all, windows allow key up events to be intercepted.
|
||||
@@ -1478,6 +1564,15 @@ Converts from screen to client window coordinates.
|
||||
|
||||
\docparam{pt}{The screen position for the second form of the function.}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{ScreenToClient(point)}}{Accepts and returns a wxPoint}
|
||||
\twocolitem{\bf{ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
|
||||
\membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow}
|
||||
|
||||
\func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}}
|
||||
@@ -1570,6 +1665,14 @@ around panel items, for example.
|
||||
|
||||
\docparam{size}{The required client size.}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{SetClientSize(size)}}{Accepts a wxSize}
|
||||
\twocolitem{\bf{SetClientSizeWH(width, height)}}{}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::SetCursor}\label{wxwindowsetcursor}
|
||||
|
||||
\func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}}
|
||||
@@ -1650,7 +1753,7 @@ If the window already has a drop target, it is deleted.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
|
||||
\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
|
||||
\helpref{Drag and drop overview}{wxdndoverview}
|
||||
|
||||
\membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}
|
||||
@@ -1959,6 +2062,15 @@ by wxWindows, or that the current value of the dimension should be used.
|
||||
|
||||
\helpref{wxWindow::Move}{wxwindowmove}
|
||||
|
||||
\pythonnote{In place of a single overloaded method name, wxPython
|
||||
implements the following methods:\par
|
||||
\indented{2cm}{\begin{twocollist}
|
||||
\twocolitem{\bf{SetDimensions(x, y, width, height, sizeFlags=wxSIZE_AUTO)}}{}
|
||||
\twocolitem{\bf{SetSize(size)}}{}
|
||||
\twocolitem{\bf{SetPosition(point)}}{}
|
||||
\end{twocollist}}
|
||||
}
|
||||
|
||||
\membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
|
||||
|
||||
\func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user