Add wxTimerEvent to Events category

[wxWidgets.git] / wxPython / docs / BUILD.txt

diff --git a/wxPython/docs/BUILD.txt b/wxPython/docs/BUILD.txt
index 6f5d4f519fa7e592ce14eb43c1bdbadbd5078323..02702fe52e6c323926a469b729f47312b580c702 100644 (file)
--- a/wxPython/docs/BUILD.txt
+++ b/wxPython/docs/BUILD.txt
@@ -12,11 +12,14 @@ importantly, that you know what you are doing!  ;-)
 If you want to also install the version of wxPython you build to be in
 your site-packages dir and be your default version of wxPython, then a
 few additional steps are needed, and you may want to use slightly
 If you want to also install the version of wxPython you build to be in
 your site-packages dir and be your default version of wxPython, then a
 few additional steps are needed, and you may want to use slightly

-different options.  See INSTALL.txt for more details.  If you only use
-the instructions in this BUILD.txt file then you will end up with a
-separate installation of wxPython and you can switch back and forth
-between this and the release version that you may already have
-installed.
+different options.  See the INSTALL_ document for more details.  If
+you only use the instructions in this BUILD_ document file then you
+will end up with a separate installation of wxPython and you can
+switch back and forth between this and the release version that you
+may already have installed.
+
+.. _INSTALL: INSTALL.html
+.. _BUILD: BUILD.html

 
 If you want to make changes to any of the ``*.i`` files, (SWIG interface
 definition files,) or to regenerate the extension sources or renamer
 
 If you want to make changes to any of the ``*.i`` files, (SWIG interface
 definition files,) or to regenerate the extension sources or renamer


@@ -31,6 +34,23 @@ command-line variable named SWIG to be the full path name of the
 executable and the wxPython build will use it.  See below for an
 example.
 
 executable and the wxPython build will use it.  See below for an
 example.
 

+In the text below I'll use WXDIR with environment variable syntax
+(either $WXDIR or %WXDIR%) to refer to the top level directory were
+your wxWidgerts and wxPython sources are located.  It will equate to
+whereever you checked out the wxWidgets module from CVS, or untarred
+the wxPythonSrc tarball to.  You can either substitute the $WXDIR text
+below with your actual dir, or set the value in the environment and
+use it just like you see it below.
+
+If you run into what appears to be compatibility issues between
+wxWidgets and wxPython while building wxPython, be sure you are using
+the wxWidgets sources included with the wxPythonSrc tarball or the CVS
+snapshot, and not a previously installed version or a version
+installed from one of the standard wxWidgets installers.  With the
+"unstable" releases (have a odd-numbered minor release value, where
+the APIs are allowed to change) there are often significant
+differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
+release of wxPython.

 
 
 
 
 
 


@@ -51,23 +71,24 @@ place, then do the same for wxPython.
    rerun the script without having to remember the options I used
    before::
 
    rerun the script without having to remember the options I used
    before::
 

-        mkdir bld
-        cd bld
-        ../configure --prefix=/opt/wx/2.5 \
-                     --with-gtk \
-                     --with-opengl \
-                     --disable-monolithic \
-                     --enable-debug \
-                     --enable-geometry \
-                     --enable-sound \
-                     --enable-display \
-                     
+        cd $WXDIR
+         mkdir bld
+         cd bld
+         ../configure --prefix=/opt/wx/2.5 \
+                      --with-gtk \
+                      --with-opengl \
+                      --disable-monolithic \
+                      --enable-debug \
+                      --enable-geometry \
+                      --enable-sound --with-sdl \
+                      --enable-display \
+                      

 
    On OS X of course you'll want to use --with-mac instead of
    --with-gtk.  For GTK2 and unicode add::
 
    On OS X of course you'll want to use --with-mac instead of
    --with-gtk.  For GTK2 and unicode add::

-                        
-                     --enable-gtk2 \
-                     --enable-unicode \
+                         
+                      --enable-gtk2 \
+                      --enable-unicode \

 
    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever
    path you want, such as a path in your HOME dir or even one of the
 
    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever
    path you want, such as a path in your HOME dir or even one of the


@@ -107,7 +128,7 @@ place, then do the same for wxPython.
    the execute bit on .make first!::
 
          .make
    the execute bit on .make first!::
 
          .make

-        .make install
+         .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
 
    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


@@ -116,16 +137,17 @@ place, then do the same for wxPython.
 
 
 3. I also have a script to help me build wxPython and it is checked in
 
 
 3. I also have a script to help me build wxPython and it is checked in

-   to the CVS as wxWidgets/wxPython/b, but probably don't want to use
-   it as it's very cryptic and expects that you want to run SWIG, so
-   if you don't have the latest patched up version of SWIG then you'll
-   probably get stuck.  So I'll just give the raw commands instead.
+   to the CVS as wxWidgets/wxPython/b, but you probably don't want to
+   use it as it's very cryptic and expects that you want to run SWIG,
+   so if you don't have the latest patched up version of SWIG then
+   you'll probably get stuck.  So I'll just give the raw commands
+   instead.

 
    We're not going to install the development version of wxPython with
    these commands, so it won't impact your already installed version
    of the latest release.  You'll be able test with this version when
    you want to, and use the installed release version the rest of the
 
    We're not going to install the development version of wxPython with
    these commands, so it won't impact your already installed version
    of the latest release.  You'll be able test with this version when
    you want to, and use the installed release version the rest of the

-   time.  If do want to install the development verison please read
+   time.  If you want to install the development version please read

    INSTALL.txt.
 
    If you have more than one version of Python on your system then be
    INSTALL.txt.
 
    If you have more than one version of Python on your system then be


@@ -134,53 +156,54 @@ place, then do the same for wxPython.
    using python2.3.
 
    Make sure that the first wx-config found on the PATH is the one you
    using python2.3.
 
    Make sure that the first wx-config found on the PATH is the one you

-   installed above, and then change to the wxWidgets/wxPython dir and
+   installed above, and then change to the $WXDIR/wxPython dir and

    run the this command::
 
    run the this command::
 

-         cd wxPython
-        python2.3 setup.py build_ext --inplace --debug
+         cd $WXDIR/wxPython
+         python2.3 setup.py build_ext --inplace --debug

 
    If your new wx-config script is not on the PATH, or there is some
    other version of it found first, then you can add this to the
    command line to ensure your new one is used instead::
 
 
    If your new wx-config script is not on the PATH, or there is some
    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.5/bin/wx-config

 
    If you are building with GTK2 then add the following flags to the
    command line::
 
 
    If you are building with GTK2 then add the following flags to the
    command line::
 

-        WXPORT=gtk2 UNICODE=1
+         WXPORT=gtk2 UNICODE=1

 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
    where to find the new swig executable, so add these flags::
 
 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
    where to find the new swig executable, so add these flags::
 

-        USE_SWIG=1 SWIG=/opt/swig/bin/swig
+         USE_SWIG=1 SWIG=/opt/swig/bin/swig

 
 

-   If you get errors about wxGLCanvas or being unable to find libGLU
-   or something like that then you can add BUILD_GLCANVAS=0 to the
-   setup.py command line to disable the building of the glcanvas
-   module.
+   If you get errors about being unable to find libGLU, wxGLCanvas
+   being undeclared, or something similar then you can add
+   BUILD_GLCANVAS=0 to the setup.py command line to disable the
+   building of the glcanvas module.

 
    When the setup.py command is done you should have fully populated
 
    When the setup.py command is done you should have fully populated

-   wxPython and wx packages locally in wxWidgets/wxPython/wxPython and
-   .../wx, with all the extension modules (``*.so`` files) located in the
-   wx package.
+   wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
+   $WXDIR/wxPython/wx, with all the extension modules (``*.so`` files)
+   located in the wx package.

 
 
 
 

-4. To run code with the development verison of wxPython, just set the
-   PYTHONPATH to the wxPython dir in the CVS tree.  For example::
+4. To run code with the development version of wxPython, just set the
+   PYTHONPATH to the wxPython dir located in the source tree.  For
+   example::

 
 

-        export LD_LIBRARY=/opt/wx/2.5/lib
-       export PYTHONPATH=/myprojects/wxWidgets/wxPython
-       cd /myprojects/wxWidgets/wxPython/demo
-       python2.3 demo.py
+        export LD_LIBRARY_PATH=/opt/wx/2.5/lib
+        export PYTHONPATH=$WXDIR/wxPython
+        cd $WXDIR/wxPython/demo
+        python2.3 demo.py

 
    OS X NOTE: You need to use "pythonw" on the command line to run
    wxPython applications.  This version of the Python executable is
    part of the Python Framework and is allowed to interact with the
    display.  You can also double click on a .py or a .pyw file from
 
    OS X NOTE: You need to use "pythonw" on the command line to run
    wxPython applications.  This version of the Python executable is
    part of the Python Framework and is allowed to interact with the
    display.  You can also double click on a .py or a .pyw file from

-   the finder (assuming that PythonLauncher is still associated with
+   the finder (assuming that the PythonLauncher app is associated with

    these file extensions) and it will launch the Framework version of
    Python for you.  For information about creating Applicaiton Bundles
    of your wxPython apps please see the wiki and the mail lists.
    these file extensions) and it will launch the Framework version of
    Python for you.  For information about creating Applicaiton Bundles
    of your wxPython apps please see the wiki and the mail lists.


@@ -207,12 +230,13 @@ modules using that compiler, and then make a few changes to setup.py
 to accomodate that.  (And send the patches to me.)  If you plan on
 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 have to build Python and any other extension modules that you use with
 to accomodate that.  (And send the patches to me.)  If you plan on
 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 have to build Python and any other extension modules that you use with

-that compiler because a different version of the C runtime likbrary is
+that compiler because a different version of the C runtime library is

 used.  The Python executable that comes from PythonLabs and the
 wxPython extensions that I distribute are built with MSVC 6 with all
 used.  The Python executable that comes from PythonLabs and the
 wxPython extensions that I distribute are built with MSVC 6 with all

-the Service Packs applied.
+the Service Packs applied.  This policy will change with Python 2.4
+and MSVC 7.1 will be used starting with that version.

 
 

-If you want to build a debugable version of wxWidgets and wxPython you
+If you want to build a debuggable version of wxWidgets and wxPython you

 will need to have also built a debug version of Python and any other
 extension modules you need to use.  You can tell if you have them
 already if there is a _d in the file names, for example python_d.exe
 will need to have also built a debug version of Python and any other
 extension modules you need to use.  You can tell if you have them
 already if there is a _d in the file names, for example python_d.exe


@@ -223,56 +247,62 @@ it.
 
 Just like the unix versions I also use some scripts to help me build
 wxWidgets, but I use some non-standard stuff to do it.  So if you want
 
 Just like the unix versions I also use some scripts to help me build
 wxWidgets, but I use some non-standard stuff to do it.  So if you want

-to use them too you'll need to get a copy or 4DOS or 4NT from
+to use my scripts you'll need to get a copy or 4DOS or 4NT from

 http://www.jpsoft.com/ and also a copy of unix-like cat and sed
 programs.  You can also do by hand what my scripts are doing, but
 http://www.jpsoft.com/ and also a copy of unix-like cat and sed
 programs.  You can also do by hand what my scripts are doing, but

-there are a lof steps involved and I won't be going into details
-here.  There is a copy of my build scripts in wxWidgets\wxPython\distrib\msw
+there are alot of steps involved and I won't be going into details
+here.  There is a copy of my build scripts in %WXDIR%\\wxPython\\distrib\\msw
+that you can use for reference (if you don't use them directly) for
+adapting these instructions to your specific needs.  The directions
+below assume that you are using my scripts.

 
 
 1. Set an environment variable to the root of the wxWidgets source
 
 
 1. Set an environment variable to the root of the wxWidgets source

-   tree::
+   tree.  This is used by the makefiles::

 
 

-        set WXWIN=e:\projects\wxWidgets
+         set WXWIN=%WXDIR%

 
 

-2. Copy setup0.h to setup.h
+2. Copy setup0.h to setup.h::

 
 

-        cd %WXWIN%\include\wx\msw
-        copy setup0.h setup.h
+         cd %WXDIR%\include\wx\msw
+         copy setup0.h setup.h

 
 
 
 

-3. Edit %WXWIN%\include\wx\msw\setup.h and change a few settings.
+3. Edit %WXDIR%\\include\\wx\\msw\\setup.h and change a few settings.

    Some of them are changed by my build scripts depending on the type
    of build (debug/hybrid, unicode/ansi). I change a few of the other
    defaults to have these values::
 
    Some of them are changed by my build scripts depending on the type
    of build (debug/hybrid, unicode/ansi). I change a few of the other
    defaults to have these values::
 

-        wxDIALOG_UNIT_COMPATIBILITY    0
-        wxUSE_DEBUG_CONTEXT            1
-        wxUSE_MEMORY_TRACING           1
-        wxUSE_DIALUP_MANAGER           0
-        wxUSE_GLCANVAS                 1
-        wxUSE_POSTSCRIPT               1
-        wxUSE_AFM_FOR_POSTSCRIPT       0
-        
+         wxDIALOG_UNIT_COMPATIBILITY    0
+         wxUSE_DEBUG_CONTEXT            1
+         wxUSE_MEMORY_TRACING           1
+         wxUSE_DIALUP_MANAGER           0
+         wxUSE_GLCANVAS                 1
+         wxUSE_POSTSCRIPT               1
+         wxUSE_AFM_FOR_POSTSCRIPT       0
+         wxUSE_DISPLAY                  1
+         

 
 

-4. Make a %WXWIN%\BIN directory and add it to the PATH.  My build
-   scripts will copy the wxWidgets DLLs there.
+4. Make sure that %WXDIR%\\lib\\vc_dll directory is on the PATH.  The
+   wxWidgets DLLs will end up there as part of the build and so you'll
+   need it on the PATH for them to be found at runtime.

 
 
 
 

-5. Change to the %WXWIN%\build\msw directory and copy my build scripts
-   there.
+5. Change to the %WXDIR%\\build\\msw directory and copy my build scripts
+   there from their default location in %WXDIR%\\wxPython\\distrib\\msw
+   if they are not present already.

 
 
 6. Use the .make.btm command to build wxWidgets.  It needs one
    command-line parameter which controls what kind of build(s) to do.
    Use one of the following::
 
 
 
 6. Use the .make.btm command to build wxWidgets.  It needs one
    command-line parameter which controls what kind of build(s) to do.
    Use one of the following::
 

-        debug          Build debug version
-        hybrid         Build hybrid version
-        both           Both debug and hybrid
-        debug-uni      Build a debug unicode library
-        hybrid-uni     Hybrid unicode (see the pattern yet? ;-)
-        both-uni       and finally both unicode libraries
+         debug          Build debug version
+         hybrid         Build hybrid version
+         both           Both debug and hybrid
+         debug-uni      Build a debug unicode library
+         hybrid-uni     Hybrid unicode (see the pattern yet? ;-)
+         both-uni       and finally both unicode libraries

 
    For example::
 
 
    For example::
 


@@ -286,9 +316,8 @@ here.  There is a copy of my build scripts in wxWidgets\wxPython\distrib\msw
 
 
 7.  When that is done it will have built the main wxWidgets DLLs and
 
 
 7.  When that is done it will have built the main wxWidgets DLLs and

-    also some of the contribs DLLs.  There should be a ton of DLLs in
-    %WXDIR%\bin and lots of lib files and other stuff in
-    %WXDIR%\lib\vc_dll.
+    also some of the contribs DLLs.  There should be a ton of DLLs and
+    lots of lib files and other stuff in %WXDIR%\\lib\\vc_dll.

 
 
 8. Building wxPython on Windows is very similar to doing it for the
 
 
 8. Building wxPython on Windows is very similar to doing it for the


@@ -297,20 +326,20 @@ here.  There is a copy of my build scripts in wxWidgets\wxPython\distrib\msw
    installed version of the latest release.  You'll be able to test
    with this version when you want to, and use the installed release
    version the rest of the time.  If you ever do want to install the
    installed version of the latest release.  You'll be able to test
    with this version when you want to, and use the installed release
    version the rest of the time.  If you ever do want to install the

-   development verison please refer to INSTALL.txt.
+   development version please refer to INSTALL.txt.

 
 

-   Change to the wxWidgets\wxPython dir and run the this command,
+   Change to the %WXDIR%\\wxPython dir and run the this command,

    makeing sure that you use the version of python that you want to
    build for (if you have more than one on your system)::
 
    makeing sure that you use the version of python that you want to
    build for (if you have more than one on your system)::
 

-         cd %WXWIN%\wxPython
-        python setup.py build_ext --inplace 
+         cd %WXDIR%\wxPython
+         python setup.py build_ext --inplace 

 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
    where to find the new swig executable, so add these flags::
 
 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
    where to find the new swig executable, so add these flags::
 

-        USE_SWIG=1 SWIG=e:\projects\SWIG-cvs\swig.exe
+         USE_SWIG=1 SWIG=e:\projects\SWIG-cvs\swig.exe

 
    If you built a Unicode version of wxWidgets and want to also build
    the Unicode version of wxPython then add this flag::
 
    If you built a Unicode version of wxWidgets and want to also build
    the Unicode version of wxPython then add this flag::


@@ -324,16 +353,16 @@ here.  There is a copy of my build scripts in wxWidgets\wxPython\distrib\msw
    use them.  The debug and hybrid(release) versions can coexist.
 
    When the setup.py command is done you should have fully populated
    use them.  The debug and hybrid(release) versions can coexist.
 
    When the setup.py command is done you should have fully populated

-   wxPython and wx packages locally in wxWidgets/wxPython/wxPython and
-   wxWidgets/wxPython/wx, with all the extension modules (``*.pyd``
+   wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
+   %WXDIR%/wxPython/wx, with all the extension modules (``*.pyd``

    files) located in the wx package.
 
 
    files) located in the wx package.
 
 

-9. To run code with the development verison of wxPython, just set the
+9. To run code with the development version of wxPython, just set the

    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 

-       set PYTHONPATH=e:\projects\wxWidgets\wxPython
-       cd e:\projects\wxWidgets\wxPython
-       python demo.py
+        set PYTHONPATH=%WXDIR%\wxPython
+       cd %WXDIR\wxPython\demo
+        python demo.py