From 05d6c206225b4e345a3b6b625f70c147d8a11204 Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Fri, 22 Apr 2005 14:33:06 +0000 Subject: [PATCH] updated ReST docs git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@33828 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- wxPython/docs/BUILD.html | 32 +++--- wxPython/docs/CHANGES.html | 157 +++++++++++++++++++++--------- wxPython/docs/INSTALL.html | 8 +- wxPython/docs/MigrationGuide.html | 34 ++++--- 4 files changed, 149 insertions(+), 82 deletions(-) diff --git a/wxPython/docs/BUILD.html b/wxPython/docs/BUILD.html index b6b5d9140b..78e7a8ba69 100644 --- a/wxPython/docs/BUILD.html +++ b/wxPython/docs/BUILD.html @@ -4,17 +4,17 @@ -Building wxPython 2.5 for Development and Testing +Building wxPython 2.6 for Development and Testing -
-

Building wxPython 2.5 for Development and Testing

+
+

Building wxPython 2.6 for Development and Testing

This file describes how I build wxWidgets and wxPython while doing development and testing, and is meant to help other people that want to do the same thing. I'll assume that you are using either a CVS snapshot from http://wxWidgets.org/snapshots/, a checkout from CVS, or -one of the released wxPython-src-2.5.* tarballs. I'll also assume that +one of the released wxPython-src-2.6.* tarballs. I'll also assume that you know your way around your system, the compiler, etc. and most importantly, that you know what you are doing! ;-)

If you want to also install the version of wxPython you build to be in @@ -71,7 +71,7 @@ before:

cd $WXDIR mkdir bld cd bld -../configure --prefix=/opt/wx/2.5 \ +../configure --prefix=/opt/wx/2.6 \ --with-gtk \ --with-opengl \ --enable-debug \ @@ -92,11 +92,11 @@ to the monolithic build of wxWidgets just add this configure flag:

 --enable-monolithic \
 
-

By default GTK2 will be selected if its development pacakge is -installed on your build system. To force the use of GTK 1.2.x -instead add this flag:

+

By default GTK 2.x will be used for the build. If you woudl rather +use GTK 1.2.x for some reason then you can force configure to use +it by changing the --with-gtk flag to specify it like this:

---disable-gtk2 \
+--with-gtk=1 \
 

To make the wxWidgets build be unicode enabled (strongly recommended if you are building with GTK2) then add the following. @@ -107,14 +107,14 @@ will actually be unicode objects.:

 --enable-unicode \
 
-

Notice that I used a prefix of /opt/wx/2.5. You can use whatever +

Notice that I used a prefix of /opt/wx/2.6. You can use whatever path you want, such as a path in your HOME dir or even one of the standard prefix paths such as /usr or /usr/local if you like, but using /opt this way lets me easily have multiple versions and ports of wxWidgets "installed" and makes it easy to switch between them, without impacting any versions of wxWidgets that may have been installed via an RPM or whatever. For the rest of the steps below -be sure to also substitute "/opt/wx/2.5" with whatever prefix you +be sure to also substitute "/opt/wx/2.6" with whatever prefix you choose for your build.

If you want to use the image and zlib libraries included with wxWidgets instead of those already installed on your system, (for @@ -146,9 +146,9 @@ the execute bit on .make first!:

.make install

When it's done you should have an installed set of files under -/opt/wx/2.5 containing just wxWidgets. Now to use this version of -wxWidgets you just need to add /opt/wx/2.5/bin to the PATH and set -LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.5/lib.

+/opt/wx/2.6 containing just wxWidgets. Now to use this version of +wxWidgets you just need to add /opt/wx/2.6/bin to the PATH and set +LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.6/lib.

  • I also have a script to help me build wxPython and it is checked in to the CVS as wxWidgets/wxPython/b, but you probably don't want to @@ -177,7 +177,7 @@ python2.3 setup.py build_ext --inplace --debug other version of it found first, then you can add this to the command line to ensure your new one is used instead:

    -WX_CONFIG=/opt/wx/2.5/bin/wx-config
    +WX_CONFIG=/opt/wx/2.6/bin/wx-config
     

    By default setup.py will assume that you built wxWidgets to use GTK2. If you built wxWidgets to use GTK 1.2.x then you should add @@ -210,7 +210,7 @@ located in the wx package.

    PYTHONPATH to the wxPython dir located in the source tree. For example:

    -export LD_LIBRARY_PATH=/opt/wx/2.5/lib
    +export LD_LIBRARY_PATH=/opt/wx/2.6/lib
     export PYTHONPATH=$WXDIR/wxPython
     cd $WXDIR/wxPython/demo
     python2.3 demo.py
    diff --git a/wxPython/docs/CHANGES.html b/wxPython/docs/CHANGES.html
    index 2c483d7add..70570ea38c 100644
    --- a/wxPython/docs/CHANGES.html
    +++ b/wxPython/docs/CHANGES.html
    @@ -11,7 +11,72 @@
     

    Recent Changes for wxPython

    -

    2.5.5.0

    +

    2.6.0.0

    +

    wxMSW: Fixed wx.TransientPopupWindow (and therefore wx.TipWindow) to +auto-dismiss when the mouse is clicked outside of the popup like it is +supposed to.

    +

    wxMSW: Fixed bug #1167891 wx.Notebook display problem with wx.NB_MULTILINE.

    +

    wxMSW: Fixed bad cliping of hidden windows inside of wx.StaticBox.

    +

    wxGTK: The configure flags for selecting GTK+ 1.2.x or 2.x has +changed slightly. It is now --with-gtk[=VERSION] where VERSION is +either '1', '2' or 'any'. The default is '2'.

    +

    wx.stc.StyledTextCtrl: Added the following methods for alternate ways +to set and fetch text from the document buffer. They work similarly +to the existing methods of the same name, except that they don't go +through the same string/unicode <--> wxString conversions. The "Raw" +methods will do no conversions at all and in a unicode build of +wxPython the strings will be in the utf-8 encoding and in an ansi +build no assumption is made about the encoding. The "UTF8" functions +will attempt to always get/set utf-8 text, which it will always be +able to do in a unicode build, and in an ansi build it will depend on +the content of the utf-8 used being compatible with the current +encoding, (you'll get an exception otherwise.)

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AddTextRawAddTextUTF8
    InsertTextRawInsertTextUTF8
    GetCurLineRawGetCurLineUTF8
    GetLineRawGetLineUTF8
    GetSelectedTextRawGetSelectedTextUTF8
    GetTextRangeRawGetTextRangeUTF8
    SetTextRawSetTextUTF8
    GetTextRawGetTextUTF8
    AppendTextRawAppendTextUTF8
    +
    +

    wx.stc.StyledTextCtrl: Added the StyleSetFontEncoding(style, enc) +method that allows you to set the encoding to be used by the font for +a particular style.

    +

    wxMac: Fixed wx.ComboBox to forward the EVT_CHAR, EVT_KEY_DOWN, +EVT_KEY_UP and EVT_TEXT events from its embedded text control.

    +

    wxMac: Corrected refresh bugs in wxGrid.

    +
    +
    +

    2.5.5.1

    wxMSW: Fixed bug #1022383, 'several ComboBoxes appear selected'

    wx.grid.Grid: Fixed bug #1163384. Moved the code that handles activating the cell editors to a EVT_CHAR event handler. This is done @@ -38,7 +103,7 @@ crash when using nVidia cards (patch 1155132)

    wx.lib.mixins.listctrl: Patches from Toni Brkic:
    • Bugfix for TextEditMixin when the view can't be scrolled
    • -
    • Enhancement for ListCtrlAutoWidthMixin, allowing it to manage +
    • Enhancement for ListCtrlAutoWidthMixin, allowing it to manage the width of any column.
    @@ -76,8 +141,8 @@ list of top-level windows that currently exist in the application.

    folks.

    Added the ActiveGrid IDE as a sample application.

    -
    -

    2.5.4.1

    +
    +

    2.5.4.1

    wx.Sizer Add, Insert, and Prepend functions now return a reference to the wx.SizerItem that was added to the sizer, and the wx.SizerItem has a GetRect accessor to give the position of the item on the parent window.

    @@ -88,7 +153,7 @@ consecutive (there may be intervening controls). Without this fix, an out-of-sync assert is generated when clicking on a radio button and then calling GetValue().

    -
    Some XRC changes:
    +
    Some XRC changes:
    • Added 'icon' property to wxFrame and wxDialog
    • No longer ignores menu bitmaps on non-MSW platforms
    • @@ -307,8 +372,8 @@ wx.Image.

    -
    -

    2.5.3.1

    +
    +

    2.5.3.1

    wxMac focus and border refreshes corrected.

    Updated internal PNG library.

    wxMac fix for metal appearance on wx.ToolBar.

    @@ -331,7 +396,7 @@ button will be used. For example, the following will result in a button with "Cancel" as the label and if run on wxGTK2 then there will also be an image of a red X:

    -b = wx.Button(parent, wx.ID_CANCEL) 
    +b = wx.Button(parent, wx.ID_CANCEL)
     

    Added wx.lib.ticker.Ticker class from Chris Mellon.

    Fix some incorrect clipping regions in wxSTC on wxGTK.

    @@ -449,7 +514,7 @@ Migrarion Guide for more information.

    • wxPython/demo/ListCtrl_edit.py (new demo)
    • wxPython/demo/Main.py (include new demo in demo app)
    • -
    • wxPython/wx/lib/mixins/listctrl.py (several improvements to +
    • wxPython/wx/lib/mixins/listctrl.py (several improvements to TextEditMixin)
    • wxPython/wx/lib/wxpTag.py (some small fixes)
    @@ -461,8 +526,8 @@ it.

    wxPython on OSX can now be built in Unicode mode, can support multiple version installs, and comes with an uninstaller script.

    -
    -

    2.5.2.8

    +
    +

    2.5.2.8

    Predominantly a bug-fix release.

      @@ -490,8 +555,8 @@ wxCheckListBox.
    -
    -

    2.5.2.7

    +
    +

    2.5.2.7

    wx.ADJUST_MINSIZE is now the default behaviour for window items in sizers. This means that the item's GetMinSize and/or GetBestSize will be called when calculating layout and the return value from that will @@ -586,8 +651,8 @@ in the PyShell:

    wxGTK: Applied wxNO_BORDER patch (#1098374) for text control and combo box.

    -
    -

    2.5.1.5

    +
    +

    2.5.1.5

    (See also the MigrationGuide file for details about some of the big changes that have happened in this release and how you should adapt your code.)

    @@ -668,8 +733,8 @@ migrating away from using activexwrapper as well. Please see the MigrationGuide for more details on using the new module.

    Floats are allowed again as function parameters where ints are expected.

    -
    -

    2.4.2.4

    +
    +

    2.4.2.4

    Use wxSTC in the demo for displaying the soucre code of the samples.

    Lots of bug fixes and such from the wxWindows folks.

    Added wxPython.lib.newevent from Miki Tebeka. Its usage is @@ -678,8 +743,8 @@ demonstrated in the Threads sample in the demo.

    Added wxMaskedNumCtrl.

    Added Chris Barker's FloatCanvas.

    -
    -

    2.4.1.2

    +
    +

    2.4.1.2

    Added wxScrolledPanel from Will Sadkin

    Added SetShape method to top level windows (e.g. wxFrame.)

    Changed wxSWIG to not generate Python code using apply, (since it will @@ -730,8 +795,8 @@ release,) SetItemMinSize can now take a wxSize (or 2-tuple) parameter, and Spacers can be specified with a wxSize (or 2-tuple) parameter

    Added wxCursorFromBits.

    -
    -

    2.4.0.7

    +
    +

    2.4.0.7

    Gave up on generating a warning upon the use of the old true/false or TRUE/FALSE values.

    Fixed wxGenericTreeCtrl (used on wxGTK and wxMac for wxTreeCtrl) so @@ -761,8 +826,8 @@ think I am testing in the future...

    Updated pycolourchooser.

    Updated to 0.9b of PyCrust.

    -
    -

    2.4.0.4

    +
    +

    2.4.0.4

    Added missing wxRect methods

    Add OOR support for wxApp objects too.

    Added wxCursorFromImage, which works on wxMSW and wxGTK so far.

    @@ -818,25 +883,25 @@ doesn't have a standard place for them.

    Fixed typemaps for wxGridCellCoordsArray.

    Updated to the 0.9a version of PyCrust

    -
    -

    2.4.0.2

    +
    +

    2.4.0.2

    Several bug fixes.

    Added wxIntCtrl from Will Sadkin.

    Added wxPyColourChooser by Michael Gilfix.

    -
    -

    2.4.0.1

    +
    +

    2.4.0.1

    No major new features since 2.3.4.2, mostly bug fixes and minor enhancements.

    Added function wrappers for the common dialogs from Kevin Altis. See wxPython/lib/dialogs.py for more details.

    -
    -

    2.3.4.2

    +
    +

    2.3.4.2

    Various bug fixes.

    -
    -

    2.3.4.1

    +
    +

    2.3.4.1

    Updated XRCed and wxTimeCtrl contribs.

    Show a couple new wxGrid features in the demo.

    Several bug fixes in wxWindows.

    @@ -890,8 +955,8 @@ windows when desired.

    HTMLHelp viewer does. Changed how the wxPythonDocs tarball is built and added a script to launch the doc viewer.

    -
    -

    2.3.3.1

    +
    +

    2.3.3.1

    Added wxSplashScreen.

    Added wxGenericDirCtrl.

    Added wxMultiChoiceDialog.

    @@ -1033,15 +1098,15 @@ example.

    Added wxPython.lib.mixins.rubberband module from Robb Shecter.

    Added wxTimeCtrl from Will Sadkin.

    -
    -

    2.3.2.1

    +
    +

    2.3.2.1

    Changed (again) how the Python global interpreter lock is handled as well as the Python thread state. This time it works on SMP machines without barfing and is also still compatible with Python debuggers.

    Added some patches from library contributors.

    -
    -

    2.3.2

    +
    +

    2.3.2

    Added EVT_HELP, EVT_HELP_RANGE, EVT_DETAILED_HELP, EVT_DETAILED_HELP_RANGE, EVT_CONTEXT_MENU, wxHelpEvent, wxContextMenuEvent, wxContextHelp, wxContextHelpButton, wxTipWindow, @@ -1123,8 +1188,8 @@ SendCommand method, but it is still quite powerful. See wxPython/contrib/dllwidget and wxPython/demo/dllwidget for more details.

    -
    -

    2.3.1

    +
    +

    2.3.1

    Added EVT_GRID_EDITOR_CREATED and wxGridEditorCreatedEvent so the user code can get access to the edit control when it is created, (to push on a custom event handler for example.)

    @@ -1137,8 +1202,8 @@ subclass wxXmlResourceHandler, etc...

    Fixed img2py to work correctly with Python 2.1.

    Added enhanced wxVTKRenderWindow by Prabhu Ramachandran

    -
    -

    2.3.0

    +
    +

    2.3.0

    Removed initial startup dependency on the OpenGL DLLs so only the glcanvasc.pyd depends on them, (on wxMSW.)

    Changed wxFont, wxPen, wxBrush to not implicitly use the @@ -1234,13 +1299,13 @@ please send it to me for inclusion in this package.

    by having smaller functional apps to play with. They can be found in wxPython/samples.

    -
    -

    2.2.6

    +
    +

    2.2.6

    No changes happened in the Python wrappers for this release, only changes and fixes in the wxWindows library.

    -
    -

    2.2.5

    +
    +

    2.2.5

    New typemaps for wxString when compiling for Python 2.0 and beyond that allow Unicode objects to be passed as well as String objects. If a Unicode object is passed PyString_AsStringAndSize is used to convert @@ -1782,7 +1847,7 @@ compatibility with the current wxWindows.

    What's new in 0.5.0

    -

    Changed the import semantics from "from wxPython import *" to +

    Changed the import semantics from "from wxPython import *" to "from wxPython.wx import *" This is for people who are worried about namespace pollution, they can use "from wxPython import wx" and then prefix all the wxPython identifiers with "wx."

    diff --git a/wxPython/docs/INSTALL.html b/wxPython/docs/INSTALL.html index a48c51f67a..5f12453e98 100644 --- a/wxPython/docs/INSTALL.html +++ b/wxPython/docs/INSTALL.html @@ -4,12 +4,12 @@ -Installing wxPython 2.5 from Source +Installing wxPython 2.6 from Source -
    -

    Installing wxPython 2.5 from Source

    +
    +

    Installing wxPython 2.6 from Source

    This document will describe the few differences and additions to the content in the BUILD document for installing wxPython built from source. Please follow the intstructions both in this file and in @@ -49,7 +49,7 @@ find the wxWidgets shared libraries. You can hard code the library path into the binaries by using the rpath option when configuring wxWidgets. For example:

    ---enable-rpath=/opt/wx/2.5/lib \
    +--enable-rpath=/opt/wx/2.6/lib \
     

    SOLARIS NOTE: The --enable-rpath option may cause problems when using wxGTK on Solaris when compiling wxPython as described below. diff --git a/wxPython/docs/MigrationGuide.html b/wxPython/docs/MigrationGuide.html index 62d63a669b..e96b3db197 100644 --- a/wxPython/docs/MigrationGuide.html +++ b/wxPython/docs/MigrationGuide.html @@ -4,14 +4,14 @@ -wxPython 2.5 Migration Guide +wxPython 2.6 Migration Guide -

    -

    wxPython 2.5 Migration Guide

    +
    +

    wxPython 2.6 Migration Guide

    This document will help explain some of the major changes in wxPython -2.5 since the 2.4 series and let you know what you need to do to adapt +2.6 since the 2.4 series and let you know what you need to do to adapt your programs to those changes. Be sure to also check in the CHANGES file like usual to see info about the not so major changes and other things that have been added to wxPython.

    @@ -304,7 +304,7 @@ SetClippingRect(self, rect)

    wxPython's setup.py script now expects to use existing libraries for the contribs (gizmos, stc, xrc, etc.) rather than building local copies of them. If you build your own copies of wxPython please be -aware that you now need to also build the ogl, stc, xrc, and gizmos +aware that you now need to also build the stc, xrc, animate and gizmos libraries in addition to the main wx lib.

    The wxPython.h and other header files are now in .../wxPython/include/wx/wxPython instead of in wxPython/src. You @@ -622,18 +622,20 @@ fully transparent.

  • OGL is dead! LONG LIVE OGL!

    [Changed in 2.5.2.x]

    -

    The wx.ogl module has been deprecated in favor of the new Python port -of the OGL library located at wx.lib.ogl contributed by Pierre Hjälm. -This will hopefully greatly extend the life of OGL within wxPython by -making it more easily maintainable and less prone to getting rusty as -there seems to be less and less interest in maintaining the C++ -version.

    +

    The wx.ogl module was deprecated in version 2.5.2 in favor of the new +Python port of the OGL library located at wx.lib.ogl contributed by +Pierre Hjälm. Starting in version 2.5.5 the old ogl is no longer +being built in the distributed binaries, however the source code is +still in the source tree so people can built it themselves if desired.

    +

    The reason this changes was done was to greatly extend the life of OGL +within wxPython by making it more easily maintainable and less prone +to getting rusty as there seems to be less and less interest in +maintaining the C++ version.

    There are only a few known compatibility issues at this time. First -is that the ogl.DrawnShape has not been reimplemented yet. Next is the -location of OGL. The deprecated version is located in the wx.ogl -module, and the new version is in the wx.lib.ogl package. So this -just means that to start using the new version you need to adjust your -imports. So if your code currently has something like this:

    +is the location of OGL. The old version was located in the +wx.ogl module, and the new version is in the wx.lib.ogl package. So +this just means that to start using the new version you need to adjust +your imports. So if your code currently has something like this:

     import wx
     import wx.ogl as ogl
    -- 
    2.45.2