From c91108763b1621be54af24e24b2fab590db87325 Mon Sep 17 00:00:00 2001 From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Sat, 25 Dec 1999 20:34:56 +0000 Subject: [PATCH] fixes of documentation - replaced \tt{...}, \em{...}, \bf{...} by {\tt ...} etc. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5115 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/bitmap.tex | 8 +++--- docs/latex/wx/checklst.tex | 4 +-- docs/latex/wx/choice.tex | 4 +-- docs/latex/wx/classes.tex | 26 +++++++++++++++++ docs/latex/wx/colour.tex | 4 +-- docs/latex/wx/combobox.tex | 6 ++-- docs/latex/wx/config.tex | 12 ++++---- docs/latex/wx/cursor.tex | 4 +-- docs/latex/wx/dc.tex | 8 +++--- docs/latex/wx/grid.tex | 34 +++++++++++----------- docs/latex/wx/htmltags.tex | 8 ++++++ docs/latex/wx/image.tex | 20 ++++++------- docs/latex/wx/imaglist.tex | 8 +++--- docs/latex/wx/listbox.tex | 4 +-- docs/latex/wx/listctrl.tex | 22 +++++++-------- docs/latex/wx/mask.tex | 2 +- docs/latex/wx/menu.tex | 8 +++--- docs/latex/wx/print.tex | 2 +- docs/latex/wx/radiobox.tex | 20 ++++++------- docs/latex/wx/region.tex | 2 +- docs/latex/wx/settings.tex | 6 ++-- docs/latex/wx/size.tex | 4 +-- docs/latex/wx/sizer.tex | 2 +- docs/latex/wx/topics.tex | 1 - docs/latex/wx/treectrl.tex | 16 +++++------ docs/latex/wx/validatr.tex | 2 +- docs/latex/wx/window.tex | 58 +++++++++++++++++++------------------- docs/latex/wx/wxPython.tex | 50 ++++++++++++++++---------------- 28 files changed, 189 insertions(+), 156 deletions(-) diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index 8150715c47..334731ab8a 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -146,13 +146,13 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM. \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}} } diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex index fbb5812bd7..1094fdb4e3 100644 --- a/docs/latex/wx/checklst.tex +++ b/docs/latex/wx/checklst.tex @@ -72,8 +72,8 @@ 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 +\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}} diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex index 74d0664db4..e70287e75d 100644 --- a/docs/latex/wx/choice.tex +++ b/docs/latex/wx/choice.tex @@ -74,8 +74,8 @@ 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 +\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}} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index c6a7c56787..de69338efd 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -11,6 +11,8 @@ \input bitmap.tex \input bbutton.tex \input bmpdatob.tex +\input propbfva.tex +\input propblva.tex \input boxsizer.tex \input brush.tex \input busycurs.tex @@ -73,6 +75,7 @@ \input fildrptg.tex \input filehist.tex \input strmfile.tex +\input propflva.tex \input filesys.tex \input filesysh.tex \input filetype.tex @@ -120,6 +123,8 @@ \input ilayout.tex \input indlgevt.tex \input inputstr.tex +\input propifva.tex +\input propilva.tex \input ipvaddr.tex \input joystick.tex \input joyevent.tex @@ -130,6 +135,7 @@ \input listbox.tex \input listctrl.tex \input listevt.tex +\input proplosv.tex \input locale.tex \input log.tex \input longlong.tex @@ -173,11 +179,29 @@ \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 @@ -210,7 +234,9 @@ \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 diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 51ff6ce6f2..2cd926e19a 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -75,8 +75,8 @@ Copy constructor. \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}} } diff --git a/docs/latex/wx/combobox.tex b/docs/latex/wx/combobox.tex index 05feedbf5a..c09c0060a5 100644 --- a/docs/latex/wx/combobox.tex +++ b/docs/latex/wx/combobox.tex @@ -85,8 +85,8 @@ 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 +\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.} @@ -310,7 +310,7 @@ Selects the text between the two positions, in the combobox text field. \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} diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 4f6b45925e..5029b8b12d 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -623,9 +623,9 @@ not found, {\it defaultVal} is used instead. \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}} } @@ -699,9 +699,9 @@ on success. \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}} } diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex index 6358c7baf6..40c5b81d20 100644 --- a/docs/latex/wx/cursor.tex +++ b/docs/latex/wx/cursor.tex @@ -142,9 +142,9 @@ Note that not all cursors are available on all platforms.} \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}} } diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index c2f8055825..761c1d24f1 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -456,8 +456,8 @@ printer page: \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}} } @@ -488,8 +488,8 @@ 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 +\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}} } diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex index 95af331651..384d32438c 100644 --- a/docs/latex/wx/grid.tex +++ b/docs/latex/wx/grid.tex @@ -85,7 +85,7 @@ and widths, and/or default cell width and height. 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} @@ -157,8 +157,8 @@ The return value is wxLEFT, wxRIGHT or wxCENTRE. \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}} } @@ -173,8 +173,8 @@ Gets the background colour for the cell at the given position, or the global bac \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}} } @@ -195,8 +195,8 @@ Gets the text colour for the cell at the given position, or the global text colo \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}} } @@ -211,8 +211,8 @@ Gets the text font for the cell at the given position, or the global text font. \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}} } @@ -456,8 +456,8 @@ Sets the text alignment for the cell at the given position, or for the whole gri \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}} } @@ -472,8 +472,8 @@ Sets the background colour for the cell at the given position, or for the whole \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}} } @@ -488,8 +488,8 @@ Sets the text colour for the cell at the given position, or for the whole grid. \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}} } @@ -504,8 +504,8 @@ Sets the text font for the cell at the given position, or for the whole grid. \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}} } diff --git a/docs/latex/wx/htmltags.tex b/docs/latex/wx/htmltags.tex index 1fa5033245..ace5ea6b7e 100644 --- a/docs/latex/wx/htmltags.tex +++ b/docs/latex/wx/htmltags.tex @@ -33,6 +33,13 @@ We will use these substitutions in tags descriptions: +2 +3 +4 + 1 + 2 + 3 + 4 + 5 + 6 + 7 [pixels] integer value that represents dimension in pixels @@ -75,6 +82,7 @@ HR ALIGN=[alignment] FONT COLOR=[color] SIZE=[fontsize] + FACE=[comma-separated list of facenames] U diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 2428ee35fb..f041afaa93 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -95,14 +95,14 @@ initialization in order to work with JPEGs. \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}} } @@ -126,7 +126,7 @@ of a given handler class in an application session.} \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} @@ -363,9 +363,9 @@ TRUE if the operation succeeded, FALSE otherwise. \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}} } @@ -442,9 +442,9 @@ Depending on how wxWindows has been configured, not all formats may be available \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}} } diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex index 159e866cc4..149b343724 100644 --- a/docs/latex/wx/imaglist.tex +++ b/docs/latex/wx/imaglist.tex @@ -82,9 +82,9 @@ The original bitmap or icon is not affected by the {\bf Add} operation, and can \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} @@ -169,6 +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.} +\pythonnote{The second form is called {\tt ReplaceIcon} in wxPython.} diff --git a/docs/latex/wx/listbox.tex b/docs/latex/wx/listbox.tex index afa4f81355..59f09a388e 100644 --- a/docs/latex/wx/listbox.tex +++ b/docs/latex/wx/listbox.tex @@ -96,8 +96,8 @@ 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 +\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.} diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index a380164b24..ed9e3f49e0 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -200,9 +200,9 @@ the item after {\it start} or the beginning if {\it start} is -1. \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}} } @@ -402,9 +402,9 @@ For list view mode (only), inserts a column. For more details, see \helpref{wxLi \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}} } @@ -441,10 +441,10 @@ Insert an image/string item. \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}} } @@ -551,8 +551,8 @@ Sets a string field at a particular column. \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}} } diff --git a/docs/latex/wx/mask.tex b/docs/latex/wx/mask.tex index f57652789c..e850fb3f16 100644 --- a/docs/latex/wx/mask.tex +++ b/docs/latex/wx/mask.tex @@ -40,7 +40,7 @@ Constructs a mask from a monochrome bitmap. 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}} diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index 09419c7741..2d64a26785 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -125,9 +125,9 @@ creation of a menu or menubar. \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}} } @@ -268,7 +268,7 @@ Returns the menu item object, or NULL if it is not found. \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} diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex index c8510ba8d0..73424a6f45 100644 --- a/docs/latex/wx/print.tex +++ b/docs/latex/wx/print.tex @@ -806,7 +806,7 @@ checked) from within the overriden function, since it calls wxDC::StartDoc. \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} diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index 9b1d9be5a2..67b539b0cc 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -86,8 +86,8 @@ 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 +\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.} @@ -128,8 +128,8 @@ Enables or disables an individual button in the radiobox. \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}} } @@ -167,8 +167,8 @@ Returns the label for the given button. \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}} } @@ -210,8 +210,8 @@ Sets a label for a radio button. \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}} } @@ -256,8 +256,8 @@ Shows or hides individual buttons. \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}} } diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex index 6e9af5db8c..40d267c66d 100644 --- a/docs/latex/wx/region.tex +++ b/docs/latex/wx/region.tex @@ -285,7 +285,7 @@ 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}.} +\pythonnote{A wxPython alias for this operator is called {\tt Next}.} \membersection{wxRegionIterator::operator bool} diff --git a/docs/latex/wx/settings.tex b/docs/latex/wx/settings.tex index 2882173e62..39dede3d6c 100644 --- a/docs/latex/wx/settings.tex +++ b/docs/latex/wx/settings.tex @@ -69,7 +69,7 @@ Returns a system colour. \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} @@ -91,7 +91,7 @@ Not available in versions of Windows earlier than Windows 95 or Windows NT 4.0.} \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} @@ -150,5 +150,5 @@ where it would otherwise present the information only in audible form; zero othe \end{twocollist} \pythonnote{This static method is implemented in Python as a -standalone function named \tt{wxSystemSettings_GetSystemMetric}} +standalone function named {\tt wxSystemSettings_GetSystemMetric}} diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex index fdf4493367..a29fc06484 100644 --- a/docs/latex/wx/size.tex +++ b/docs/latex/wx/size.tex @@ -7,8 +7,8 @@ wxSize is used throughout wxWindows as well as wxPoint which, although almost 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. } diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex index 3d8c05f22c..f0dcb27bcb 100644 --- a/docs/latex/wx/sizer.tex +++ b/docs/latex/wx/sizer.tex @@ -23,7 +23,7 @@ the standard font as well as the overall design of Motif widgets requires more s 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} diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex index cb3888132e..5184dcd468 100644 --- a/docs/latex/wx/topics.tex +++ b/docs/latex/wx/topics.tex @@ -50,4 +50,3 @@ This chapter contains a selection of topic overviews, first things first: \input tdb.tex \input tipc.tex - diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index 922d3904af..b12fc3658b 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -204,8 +204,8 @@ if it was not (in this case {\it rect} is not changed) - for example, if the 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} @@ -277,7 +277,7 @@ Returns the tree item data associated with the item. \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}} } @@ -361,7 +361,7 @@ Returns the next visible item. 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} @@ -414,7 +414,7 @@ function can be called only if the control has the wxTR\_MULTIPLE style. 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} @@ -556,7 +556,7 @@ 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 +\twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python Object with the wxTreeItemData for the given item Id.} \end{twocollist}} } @@ -691,8 +691,8 @@ 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 +\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object} +\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the wxTreeItemData} \end{twocollist}} } diff --git a/docs/latex/wx/validatr.tex b/docs/latex/wx/validatr.tex index a8d9d9b0d3..cb23b95288 100644 --- a/docs/latex/wx/validatr.tex +++ b/docs/latex/wx/validatr.tex @@ -19,7 +19,7 @@ To specify a default, `null' validator, use the symbol {\bf wxDefaultValidator}. 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} diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 90f07698a3..98d2acabf5 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -215,8 +215,8 @@ a screen coordinate will be passed out.} \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}} } @@ -293,15 +293,15 @@ You can also use these functions programmatically. A convenience macro is define \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}} } @@ -334,8 +334,8 @@ Dialogs created using Dialog Editor optionally use dialog units. \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}} } @@ -421,8 +421,8 @@ 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} +\twocolitem{{\bf FindWindowById(id)}}{Accepts an integer} +\twocolitem{{\bf FindWindowByName(name)}}{Accepts a string} \end{twocollist}} } @@ -493,8 +493,8 @@ area which may be drawn on by the programmer, excluding title bar, border etc. \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}} } @@ -611,8 +611,8 @@ if no parent, relative to the whole display. \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}} } @@ -705,8 +705,8 @@ This gets the size of the entire window in pixels. \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}} } @@ -739,8 +739,8 @@ window with the currently selected font. \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}} } @@ -922,8 +922,8 @@ as the call: \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}} } @@ -1571,8 +1571,8 @@ by the window. \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}} } @@ -1683,8 +1683,8 @@ Converts from screen to client window coordinates. \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}} } @@ -1798,8 +1798,8 @@ around panel items, for example. \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}} } @@ -2176,9 +2176,9 @@ by wxWindows, or that the current value of the dimension should be used. \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}} } diff --git a/docs/latex/wx/wxPython.tex b/docs/latex/wx/wxPython.tex index e54567cc23..53d6881842 100644 --- a/docs/latex/wx/wxPython.tex +++ b/docs/latex/wx/wxPython.tex @@ -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 -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 @@ -160,14 +160,14 @@ 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. \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. @@ -176,15 +176,15 @@ 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 -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} @@ -199,7 +199,7 @@ 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 -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: @@ -292,9 +292,9 @@ 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 @@ -302,15 +302,15 @@ 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. -\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 @@ -325,15 +325,15 @@ 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 -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} -- 2.45.2