\pythonnote{Constructors supported by wxPython are:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{wxBitmap(name, flag)}}{Loads a bitmap from a file}
-\twocolitem{\bf{wxBitmapFromData(data, type, width, height, depth=1)}}{Creates
+\twocolitem{{\bf wxBitmap(name, flag)}}{Loads a bitmap from a file}
+\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
+\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
+\twocolitem{{\bf wxEmptyBitmap(width, height, depth = -1)}}{Creates an
empty bitmap with the given specifications}
\end{twocollist}}
}
\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
+\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}}
\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
+\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}}
\input bitmap.tex
\input bbutton.tex
\input bmpdatob.tex
+\input propbfva.tex
+\input propblva.tex
\input boxsizer.tex
\input brush.tex
\input busycurs.tex
\input fildrptg.tex
\input filehist.tex
\input strmfile.tex
+\input propflva.tex
\input filesys.tex
\input filesysh.tex
\input filetype.tex
\input ilayout.tex
\input indlgevt.tex
\input inputstr.tex
+\input propifva.tex
+\input propilva.tex
\input ipvaddr.tex
\input joystick.tex
\input joyevent.tex
\input listbox.tex
\input listctrl.tex
\input listevt.tex
+\input proplosv.tex
\input locale.tex
\input log.tex
\input longlong.tex
\input process.tex
\input progdlg.tex
\input procevt.tex
+\input property.tex
+\input propford.tex
+\input propforf.tex
+\input propforp.tex
+\input propforv.tex
+\input propfovi.tex
+\input proplisd.tex
+\input proplisf.tex
+\input proplisp.tex
+\input propliva.tex
+\input proplstv.tex
+\input propsht.tex
+\input propvald.tex
+\input propregv.tex
+\input propval.tex
+\input propview.tex
\input protocol.tex
\input query.tex
\input qylayevt.tex
\input radiobox.tex
\input radiobut.tex
+\input proprfva.tex
+\input proprlva.tex
\input realpoin.tex
\input rect.tex
\input recrdset.tex
\input strmbase.tex
\input stream.tex
\input wxstring.tex
+\input propstfv.tex
\input strlist.tex
+\input propslv.tex
\input tokenizr.tex
\input sysclevt.tex
\input settings.tex
\pythonnote{Constructors supported by wxPython are:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{wxColour(red=0, green=0, blue=0)}}{}
-\twocolitem{\bf{wxNamedColour(name)}}{}
+\twocolitem{{\bf wxColour(red=0, green=0, blue=0)}}{}
+\twocolitem{{\bf wxNamedColour(name)}}{}
\end{twocollist}}
}
\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
+\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.}
\docparam{to}{The second position.}
-\pythonnote{The second form of this method is called \tt{SetMark} in
+\pythonnote{The second form of this method is called {\tt SetMark} in
wxPython.}
\membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{Read(key, default="")}}{Returns a string.}
-\twocolitem{\bf{ReadInt(key, default=0)}}{Returns an int.}
-\twocolitem{\bf{ReadFloat(key, default=0.0)}}{Returns a floating point number.}
+\twocolitem{{\bf Read(key, default="")}}{Returns a string.}
+\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an int.}
+\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number.}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{Write(key, value)}}{Writes a string.}
-\twocolitem{\bf{WriteInt(key, value)}}{Writes an int.}
-\twocolitem{\bf{WriteFloat(key, value)}}{Writes a floating point number.}
+\twocolitem{{\bf Write(key, value)}}{Writes a string.}
+\twocolitem{{\bf WriteInt(key, value)}}{Writes an int.}
+\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number.}
\end{twocollist}}
}
\pythonnote{Constructors supported by wxPython are:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{wxCursor(name, flags, hotSpotX=0,
+\twocolitem{{\bf wxCursor(name, flags, hotSpotX=0,
hotSpotY=0)}}{Constructs a cursor from a filename}
-\twocolitem{\bf{wxStockCursor(id)}}{Constructs a stock cursor }
+\twocolitem{{\bf wxStockCursor(id)}}{Constructs a stock cursor }
\end{twocollist}}
}
\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)}
+\twocolitem{{\bf GetSize()}}{Returns a wxSize}
+\twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)}
\end{twocollist}}
}
\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
+\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}}
}
Call this function after creating the wxGrid object.
-\pythonnote{Currently the \tt{cellValues} and \tt{widths} parameters
+\pythonnote{Currently the {\tt cellValues} and {\tt widths} parameters
don't exisit in the wxPython version of this method. So in other
words, the definition of the wxPython version of this method looks like this:
\begin{verbatim}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{GetCellAlignment(row, col)}}{}
-\twocolitem{\bf{GetDefCellAlignment()}}{}
+\twocolitem{{\bf GetCellAlignment(row, col)}}{}
+\twocolitem{{\bf GetDefCellAlignment()}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{GetCellBackgroundColour(row, col)}}{}
-\twocolitem{\bf{GetDefCellBackgroundColourt()}}{}
+\twocolitem{{\bf GetCellBackgroundColour(row, col)}}{}
+\twocolitem{{\bf GetDefCellBackgroundColourt()}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{GetCellTextColour(row, col)}}{}
-\twocolitem{\bf{GetDefCellTextColour()}}{}
+\twocolitem{{\bf GetCellTextColour(row, col)}}{}
+\twocolitem{{\bf GetDefCellTextColour()}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{GetCellTextFont(row, col)}}{}
-\twocolitem{\bf{GetDefCellTextFont()}}{}
+\twocolitem{{\bf GetCellTextFont(row, col)}}{}
+\twocolitem{{\bf GetDefCellTextFont()}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetCellAlignment(alignment, row, col)}}{}
-\twocolitem{\bf{SetDefCellAlignment(alignment)}}{}
+\twocolitem{{\bf SetCellAlignment(alignment, row, col)}}{}
+\twocolitem{{\bf SetDefCellAlignment(alignment)}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetCellBackgroundColour(colour, row, col)}}{}
-\twocolitem{\bf{SetDefCellBackgroundColour(colour)}}{}
+\twocolitem{{\bf SetCellBackgroundColour(colour, row, col)}}{}
+\twocolitem{{\bf SetDefCellBackgroundColour(colour)}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetCellTextColour(colour, row, col)}}{}
-\twocolitem{\bf{SetDefCellTextColour(colour)}}{}
+\twocolitem{{\bf SetCellTextColour(colour, row, col)}}{}
+\twocolitem{{\bf SetDefCellTextColour(colour)}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetCellTextFont(font, row, col)}}{}
-\twocolitem{\bf{SetDefCellTextFont(font)}}{}
+\twocolitem{{\bf SetCellTextFont(font, row, col)}}{}
+\twocolitem{{\bf SetDefCellTextFont(font)}}{}
\end{twocollist}}
}
+2
+3
+4
+ 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
[pixels] integer value that represents dimension in pixels
FONT COLOR=[color]
SIZE=[fontsize]
+ FACE=[comma-separated list of facenames]
U
\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
+\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
+\twocolitem{{\bf wxEmptyImage(width, height)}}{Creates an empty image
of the given size}
-\twocolitem{\bf{wxImageFromMime(name, mimetype}}{Creates an image from
+\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
+\twocolitem{{\bf wxImageFromBitmap(bitmap)}}{Creates an image from a
platform-dependent bitmap}
\end{twocollist}}
}
\helpref{wxImageHandler}{wximagehandler}
-\pythonnote{In wxPython this static method is named \tt{wxImage_AddHandler}.}
+\pythonnote{In wxPython this static method is named {\tt wxImage_AddHandler}.}
\membersection{wxImage::CleanUpHandlers}
\func{static void}{CleanUpHandlers}{\void}
\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
+\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
+\twocolitem{{\bf LoadMimeFile(filename, mimetype)}}{Loads an image of the given
mimetype from a file}
\end{twocollist}}
}
\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
+\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
+\twocolitem{{\bf SaveMimeFile(filename, mimetype)}}{Saves the image using the given
mimetype to the named file}
\end{twocollist}}
}
\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)}}{}
+\twocolitem{{\bf Add(bitmap, mask=wxNullBitmap)}}{}
+\twocolitem{{\bf AddWithColourMask(bitmap, colour)}}{}
+\twocolitem{{\bf AddIcon(icon)}}{}
\end{twocollist}}
}
\membersection{wxImageList::Create}\label{wximagelistcreate}
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.}
+\pythonnote{The second form is called {\tt ReplaceIcon} in wxPython.}
\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
+\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.}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{FindItem(start, str, partial=FALSE)}}{}
-\twocolitem{\bf{FindItemData(start, data)}}{}
-\twocolitem{\bf{FindItemAtPos(start, point, direction)}}{}
+\twocolitem{{\bf FindItem(start, str, partial=FALSE)}}{}
+\twocolitem{{\bf FindItemData(start, data)}}{}
+\twocolitem{{\bf FindItemAtPos(start, point, direction)}}{}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{InsertColumn(col, heading, format=wxLIST\_FORMAT\_LEFT,
+\twocolitem{{\bf InsertColumn(col, heading, format=wxLIST\_FORMAT\_LEFT,
width=-1)}}{Creates a column using a header string only.}
-\twocolitem{\bf{InsertColumnInfo(col, item)}}{Creates a column using a
+\twocolitem{{\bf InsertColumnInfo(col, item)}}{Creates a column using a
wxListInfo.}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{InsertItem(item)}}{Inserts an item using a wxListItem.}
-\twocolitem{\bf{InsertStringItem(index, label)}}{Inserts a string item.}
-\twocolitem{\bf{InsertImageItem(index, imageIndex)}}{Inserts an image item.}
-\twocolitem{\bf{InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
+\twocolitem{{\bf InsertItem(item)}}{Inserts an item using a wxListItem.}
+\twocolitem{{\bf InsertStringItem(index, label)}}{Inserts a string item.}
+\twocolitem{{\bf InsertImageItem(index, imageIndex)}}{Inserts an image item.}
+\twocolitem{{\bf InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetItem(item)}}{Sets information about the given wxListItem.}
-\twocolitem{\bf{SetStringItem(index, col, label, imageId)}}{Sets a
+\twocolitem{{\bf SetItem(item)}}{Sets information about the given wxListItem.}
+\twocolitem{{\bf SetStringItem(index, col, label, imageId)}}{Sets a
string or image at a given location.}
\end{twocollist}}
}
Constructs a mask from a bitmap and a colour that indicates the background.
\pythonnote{wxPython has an alternate wxMask constructor matching this
-form called \tt{wxMaskColour}.}
+form called {\tt wxMaskColour}.}
\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
\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)}}{}
+\twocolitem{{\bf Append(id, string, helpStr="", checkable=FALSE)}}{}
+\twocolitem{{\bf AppendMenu(id, string, aMenu, helpStr="")}}{}
+\twocolitem{{\bf AppendItem(aMenuItem)}}{}
\end{twocollist}}
}
\helpref{wxMenu::FindItem}{wxmenufinditem}
-\pythonnote{The name of this method in wxPython is \tt{FindItemById}
+\pythonnote{The name of this method in wxPython is {\tt FindItemById}
and it does not support the second parameter.}
\membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}
\pythonnote{If this method is overriden in a Python class then the
base class version can be called by using the method
-\tt{base_OnBeginDocument(startPage, endPage)}. }
+{\tt base_OnBeginDocument(startPage, endPage)}. }
\membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
\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
+\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.}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{Enable(flag)}}{Enables or disables the entire radiobox.}
-\twocolitem{\bf{EnableItem(n, flag)}}{Enables or disables an
+\twocolitem{{\bf Enable(flag)}}{Enables or disables the entire radiobox.}
+\twocolitem{{\bf EnableItem(n, flag)}}{Enables or disables an
individual button in the radiobox.}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{GetLabel()}}{Returns the radiobox label.}
-\twocolitem{\bf{GetItemLabel(n)}}{Returns the label for the given button.}
+\twocolitem{{\bf GetLabel()}}{Returns the radiobox label.}
+\twocolitem{{\bf GetItemLabel(n)}}{Returns the label for the given button.}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetLabel(string)}}{Sets the radiobox label.}
-\twocolitem{\bf{SetItemLabel(n, string)}}{Sets a label for a radio button.}
+\twocolitem{{\bf SetLabel(string)}}{Sets the radiobox label.}
+\twocolitem{{\bf SetItemLabel(n, string)}}{Sets a label for a radio button.}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{Show(flag)}}{Shows or hides the entire radiobox.}
-\twocolitem{\bf{ShowItem(n, flag)}}{Shows or hides individual buttons.}
+\twocolitem{{\bf Show(flag)}}{Shows or hides the entire radiobox.}
+\twocolitem{{\bf ShowItem(n, flag)}}{Shows or hides individual buttons.}
\end{twocollist}}
}
Increment operator. Increments the iterator to the next region.
-\pythonnote{A wxPython alias for this operator is called \tt{Next}.}
+\pythonnote{A wxPython alias for this operator is called {\tt Next}.}
\membersection{wxRegionIterator::operator bool}
\end{twocollist}
\pythonnote{This static method is implemented in Python as a
-standalone function named \tt{wxSystemSettings_GetSystemColour}}
+standalone function named {\tt wxSystemSettings_GetSystemColour}}
\membersection{wxSystemSettings::GetSystemFont}\label{wxsystemsettingsgetsystemfont}
\end{twocollist}
\pythonnote{This static method is implemented in Python as a
-standalone function named \tt{wxSystemSettings_GetSystemFont}}
+standalone function named {\tt wxSystemSettings_GetSystemFont}}
\membersection{wxSystemSettings::GetSystemMetric}\label{wxsystemsettingsgetsystemmetric}
\end{twocollist}
\pythonnote{This static method is implemented in Python as a
-standalone function named \tt{wxSystemSettings_GetSystemMetric}}
+standalone function named {\tt wxSystemSettings_GetSystemMetric}}
equivalent to wxSize, has a different meaning: wxPoint represents a position
while wxSize - the size.
-\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
+\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.
}
on Windows, the intial dialog size will automatically be bigger on Motif than on Windows.
\pythonnote{If you wish to create a sizer class in wxPython you should
-derive the class from \tt{wxPySizer} in order to get Python-aware
+derive the class from {\tt wxPySizer} in order to get Python-aware
capabilities for the various virtual methods.}
\wxheading{Derived from}
\input tdb.tex
\input tipc.tex
-
item is currently invisible.
\pythonnote{The wxPython version of this method requires only the
-\tt{item} and \tt{textOnly} parameters. The return value is either a
-\tt{wxRect} object or \tt{None}.}
+{\tt item} and {\tt textOnly} parameters. The return value is either a
+{\tt wxRect} object or {\tt None}.}
\membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
\pythonnote{wxPython provides the following shortcut method:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{GetPyData(item)}}{Returns the Python Object
+\twocolitem{{\bf GetPyData(item)}}{Returns the Python Object
associated with the wxTreeItemData for the given item Id.}
\end{twocollist}}
}
Returns the item's parent.
-\pythonnote{This method is named \tt{GetItemParent} to avoid a name
+\pythonnote{This method is named {\tt GetItemParent} to avoid a name
clash with wxWindow::GetParent.}
\membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling}
Returns the number of selected items.
\pythonnote{The wxPython version of this method accepts no parameters
-and returns a Python list of \tt{wxTreeItemId}'s.}
+and returns a Python list of {\tt wxTreeItemId}'s.}
\membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist}
\pythonnote{wxPython provides the following shortcut method:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetPyData(item, obj)}}{Associate the given Python
+\twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python
Object with the wxTreeItemData for the given item Id.}
\end{twocollist}}
}
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
+\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object}
+\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the
wxTreeItemData}
\end{twocollist}}
}
For more information, please see \helpref{Validator overview}{validatoroverview}.
\pythonnote{If you wish to create a validator class in wxPython you should
-derive the class from \tt{wxPyValidator} in order to get Python-aware
+derive the class from {\tt wxPyValidator} in order to get Python-aware
capabilities for the various virtual methods.}
\wxheading{Derived from}
\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)}
+\twocolitem{{\bf ClientToScreen(point)}}{Accepts and returns a wxPoint}
+\twocolitem{{\bf ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)}
\end{twocollist}}
}
\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}
+\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
+\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
+\twocolitem{{\bf wxDLG\_SZE(win, size)}}{Converts a wxSize from dialog
units to pixels}
\end{twocollist}}
}
\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}
+\twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
+\twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
\end{twocollist}}
}
\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}
+\twocolitem{{\bf FindWindowById(id)}}{Accepts an integer}
+\twocolitem{{\bf FindWindowByName(name)}}{Accepts a string}
\end{twocollist}}
}
\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}
+\twocolitem{{\bf wxGetClientSizeTuple()}}{Returns a 2-tuple of (width, height)}
+\twocolitem{{\bf wxGetClientSize()}}{Returns a wxSize object}
\end{twocollist}}
}
\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)}
+\twocolitem{{\bf GetPosition()}}{Returns a wxPoint}
+\twocolitem{{\bf GetPositionTuple()}}{Returns a tuple (x, y)}
\end{twocollist}}
}
\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)}
+\twocolitem{{\bf GetSize()}}{Returns a wxSize}
+\twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)}
\end{twocollist}}
}
\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
+\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}}
}
\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}
+\twocolitem{{\bf Move(point)}}{Accepts a wxPoint}
+\twocolitem{{\bf MoveXY(x, y)}}{Accepts a pair of integers}
\end{twocollist}}
}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{PopupMenu(menu, point)}}{Specifies position with a wxPoint}
-\twocolitem{\bf{PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)}
+\twocolitem{{\bf PopupMenu(menu, point)}}{Specifies position with a wxPoint}
+\twocolitem{{\bf PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)}
\end{twocollist}}
}
\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)}
+\twocolitem{{\bf ScreenToClient(point)}}{Accepts and returns a wxPoint}
+\twocolitem{{\bf ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)}
\end{twocollist}}
}
\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)}}{}
+\twocolitem{{\bf SetClientSize(size)}}{Accepts a wxSize}
+\twocolitem{{\bf SetClientSizeWH(width, height)}}{}
\end{twocollist}}
}
\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)}}{}
+\twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE\_AUTO)}}{}
+\twocolitem{{\bf SetSize(size)}}{}
+\twocolitem{{\bf SetPosition(point)}}{}
\end{twocollist}}
}
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
-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
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
- \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.
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
-directory under \tt{\$(WXWIN)/utils/wxPython/modules} and run the build
+directory under {\tt \$(WXWIN)/utils/wxPython/modules} and run the build
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:
-\tt{python demo.py}
+{\tt python demo.py}
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}
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{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
-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
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++.
-\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
-\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.
\item At lines 17 to 21 notice that there are no saved references to
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
-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
-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}
projects / wxWidgets.git / commitdiff
