-Installing wxWindows 2.5.0
---------------------------
+Installing wxWidgets 2.6.0
+-----------------------------------------------------------
-This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
-and Windows XP. This is an unstable development release. Note that unstable in
-this context doesn't mean that it crashes a lot, just that the library API may
-change in backwards incompatible way during the 2.5 branch life time.
+This is wxWidgets 2.6.0 for Microsoft Windows 9x/ME, Windows NT,
+Windows 2000, Windows XP and Windows CE.
+These installation notes can be found in docs/msw/install.txt
+in your wxWidgets distribution.
IMPORTANT NOTE: If you experience problems installing, please
re-read this instructions and other related files (changes.txt,
http://sourceforge.net/bugs/?group_id=9863
-
Unarchiving
-===========
+============================================================
A setup program is provided (setup.exe) to automatically copy
files to a directory on your hard disk. Do not install into a
-path that contains spaces. To avoid confusion with other
-wxWindows installations that might be on your machine, the
-installation program does not se the WXWIN environment variable;
-please set this by hand via the System applet if you wish to
-make it permanent.
+path that contains spaces.
The setup program contains the following:
-- All common, generic and MSW-specific wxWindows source;
-- samples;
-- documentation in Windows Help format;
+- All common, generic and MSW-specific wxWidgets source;
+- samples and demos;
+- documentation in MS HTML Help format;
- makefiles for most Windows compilers, plus CodeWarrior,
BC++ and VC++ IDE files;
- JPEG library source;
- TIFF library source;
-- Object Graphics Library;
-- Tex2RTF source;
-- Dialog Editor binary.
+- Object Graphics Library, Tex2RTF, wxSTC, etc.
Alternatively, you may unarchive the .zip form by hand:
wxMSW-x.y.z.zip where x.y.z is the version number.
Unarchive the required files plus any optional documentation
files into a suitable directory such as c:\wx.
-Other add-on packages are available from the wxWindows Web site, such as:
-
-- mmedia.zip. Audio, CD, video access for Windows and Linux.
-- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
-- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
- the same document source.
-
-
General installation notes
==========================
If installing from the CVS server, copy include/wx/msw/setup0.h to
include/wx/msw/setup.h and edit the resulting file to choose
-the features you would like to compile wxWindows with[out].
-
+the features you would like to compile wxWidgets with[out].
Compilation
===========
-The following sections explain how to compile wxWindows with each supported
+The following sections explain how to compile wxWidgets with each supported
compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
Cygwin/Mingw32 to quickly locate the instructions for your compiler.
Where compiled files are stored
-------------------------------
-After succesful compilation you'll find the libraries in a subdirectory
-of lib directory named after the compiler and DLL/staitc settings.
+After successful compilation you'll find the libraries in a subdirectory
+of lib directory named after the compiler and DLL/static settings.
A couple of examples:
lib\vc_lib VC++ compiled static libraries
lib\bcc_lib Static libraries for Borland C++
lib\wat_dll Watcom C++ DLLs
-Names of compiled wxWindows libraries follow this scheme: libraries that don't
+Names of compiled wxWidgets libraries follow this scheme: libraries that don't
depend on GUI components begin with "wxbase" followed by version number and
letters indicating if the library is compiled as Unicode ('u') and/or debug
-build ('d'). Last component of them name is name of wxWindows component
+build ('d'). Last component of them name is name of wxWidgets component
(unless you built the library as single monolithic library; look for
"Configuring the build" below). This is a typical set of release ANSI build
libraries (release versions on left, debug on right side):
Below are compiler specific notes followed by customizing instructions that
apply to all compilers (search for "Configuring the build").
-
Microsoft Visual C++ compilation
---------------------------------
+----------------------------------------------------------------
You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
informal and more detailed description of the process summarized below.
Using project files (VC++ 6 and later):
-1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
+1. Unarchive wxWidgets-x.y.z-vc.zip, the VC++ 6 project
makefiles (already included in wxMSW-x.y.z.zip and the setup version).
2. Open build\msw\wx.dsw, which has configurations for static
compilation or DLL compilation, and each of these available in
'nmake -f makefile.vc'
- to make the wxWindows core library as release DLL.
+ to make the wxWidgets core library as release DLL.
See "Configuring the build" for instruction how to build debug or static
libraries.
+
2. Change directory to samples and type 'nmake -f makefile.vc'
to make all the samples. You can also make them individually.
the headers. Alternatively, #undef new before including template headers.
You will also need to set wxUSE_IOSTREAMH to 0 if you will be
using templates, to avoid the non-template stream files being included
-within wxWindows.
+within wxWidgets.
Note (2): libraries and applications generated with makefiles and
project files are now (hopefully) compatible where static libraries
are concerned, but please exercise caution nevertheless and if
possible, use one method or the other.
-Note (3): VC++ 5's optimization code seems to be broken and can
-cause both compile and run-time problems: this can be seen when
-deleting an object Dialog Editor, in Release mode with optimizations
-on. If in doubt, switch off optimisations, although this will result in much
-larger executables. It seems possible that the library can be created with
-strong optimization, so long as the application is not strongly
-optimized. For example, in wxWindows project, set to 'Minimum
-Size'. In Dialog Editor project, set to 'Customize: Favor Small
-Code' (and no others). This will then work.
-
-Note (4): some crash problems can be due to inconsistent compiler
+Note (3): some crash problems can be due to inconsistent compiler
options. If strange/weird/impossible things start to happen please
check (dumping IDE project file as makefile and doing text comparison
if necessary) that the project settings, especially the list of defined
symbols, struct packing, etc. are exactly the same for all items in
the project. After this, delete everything (including PCH) and recompile.
-Note (5): to create your own IDE files, see the technical note on the
-wxWindows web site or CD-ROM, entitled "Compiling wxWindows
-applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
-wxWindows distribution). You can also copy .dsp and .dsw
-files from an existing wxWindows sample and adapt them.
-
-
-Visual C++ 1.5 compilation (16-bit)
------------------------------------
-
-No longer supported
-
+Note (4): to create your own IDE files, copy .dsp and .dsw
+files from an existing wxWidgets sample and adapt them, or
+visit http://wiki.wxwindows.org/wiki.pl?MSVC.
Borland C++ 5.0/5.5 compilation
--------------------------------
+----------------------------------------------------------------
Compiling using the makefiles (updated 24 Sept 02):
1. Change directory to build\msw. Type 'make -f makefile.bcc' to
- make the wxWindows core library. Ignore the compiler warnings.
- This produces a couple of libraries in the lib\bcc_mswdll directory.
+ make the wxWidgets core library. Ignore the compiler warnings.
+ This produces a couple of libraries in the lib\bcc_lib directory.
2. Change directory to a sample or demo such as samples\minimal, and type
'make -f makefile.bcc'. This produces a windows exe file - by default
- in the bcc_mswdll subdirectory.
+ in the bcc_mswd subdirectory.
-Note (1): the wxWindows makefiles assume dword structure alignment. Please
+Note (1): the wxWidgets makefiles assume dword structure alignment. Please
make sure that your own project or makefile settings use the
same alignment, or you could experience mysterious crashes. To
change the alignment, change CPPFLAGS in build\msw\config.bcc.
Note (2): if you get undefined _SQL... symbols at link time,
either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
-recompile wxWindows. The same applies if compiling using the IDE.
-
+recompile wxWidgets. The same applies if compiling using the IDE.
Note (3): If you wish debug messages to be sent to the console in
debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
Compiling using CBuilder (v1-v6): not supported - please
use version 2.4.1 (using the make utility in commandline mode works fine_
-
** REMEMBER **
-In all of your wxWindows applications, your source code should include
+In all of your wxWidgets applications, your source code should include
the following preprocessor directive:
#ifdef __BORLANDC__
(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
more details)
-
Borland 16 Bit compilation for Windows 3.1
-------------------------------------------
+----------------------------------------------------------------
-The last version of wxWindows to support 16-bit compilation with Borland was
+The last version of wxWidgets to support 16-bit compilation with Borland was
2.2.7 - Please download and read the instructions in that release
Watcom C++ 10.6/11 and OpenWatcom compilation
----------------------------------------------
+----------------------------------------------------------------
1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
- make the wxWindows core library.
+ make the wxWidgets core library.
+
2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
to make this sample. Repeat for other samples of interest.
-
Note (1): if your installation of Watcom doesn't have odbc32.lib file and
you need it (i.e. you have wxUSE_ODBC=1), you can use the file
from lib\watcom directory. See the notes in that directory.
try deleting .pch files in build\msw\wat_* and compiling
the sample again.
-
Metrowerks CodeWarrior compilation
-----------------------------------
+----------------------------------------------------------------
+
+1. CodeWarrior Pro 7 project files in XML format are already
+ included in wxMSW-2.6.0.zip and the setup version.
-1. CodeWarrior Pro7 project files in XML format are already
- included in wxMSW-2.5.0.zip and the setup version.
2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
you are working from the CVS version) to make sure the settings reflect
what you want. If you aren't sure, leave it alone and go with the
- wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
will be rather confusing due to interactions with the MSL ANSI
and runtime libs.
-3. The project file to build the Win32 wxWindows libraries relies on the
+
+3. The project file to build the Win32 wxWidgets libraries relies on the
Batch File Runner plug-in. This plug-in is not installed as part of
a normal CW7 installation. However, you can find this plug-in on the
CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
"Batch File Post Linker".
+
4. If you choose not to install the Batch File Runner plug-in, then you
need to do the following by hand:
(1) Create the directories lib\cw7msw\include\wx and copy the file
(2) Create the directories lib\cw7mswd\include\wx and copy the file
include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
working from the CVS version) to lib\cw7mswd\include\wx\setup.h
-5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
+
+5. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp.
Store this project file in directory src. You may get warnings about
not being able to find certain project paths; ignore these warnings, the
appropriate paths will be created during the build by the Batch File Runner.
+
6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
will get some warnings about hidden virtual functions, illegal conversions
from const pointers to pointers, etc., all of which you can safely ignore.
***Note: if you get errors that the compiler can't find "wx/setup.h", just
stop the build and build again. These errors occur because sometimes the
compiler starts doing its thing before the copying of setup.h has completed.
+
7. The following libraries will be produced depending on chosen
target:
- wx_x86.lib ANSI Release (static)
- wx_x86_d.lib ANSI Debug (static)
+
8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
Volunteers for this are welcome (as neither DLLs nor unicode builds are
big priorities for me ;).
+
9. CodeWarrior Pro7 project files (in XML format) are also provided for some
of the samples. In particular, there are project files for the minimal,
controls, dialogs, dnd, nd docview samples. You can use these project
files as templates for the other samples and for your own projects.
- - For example, to make a project file for the "newgrid" sample,
+ - For example, to make a project file for the "grid" sample,
just copy the project file for the "minimal" sample, minimalW7.mcp
(made by importing minimalW7.xml into CodeWarrior), into the
- sample/newgrid directory, calling it newgridW7.mcp. Open
+ sample/grid directory, calling it gridW7.mcp. Open
newgridW7.mcp and revise the project by deleting the files
minimal.rc and minimal.cpp and adding the files griddemo.rc and
griddemo.cpp. Build and run....
Cygwin/MinGW compilation
-------------------------
+----------------------------------------------------------------
-wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
+wxWidgets supports Cygwin (formerly GnuWin32) betas and
releases, and MinGW. Cygwin can be downloaded from:
http://sources.redhat.com/cygwin/
Both Cygwin and MinGW can be used with configure (assuming you have MSYS
installed in case of MinGW). You will need new enough MinGW version, preferably
MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
-than 2.95.3 don't work; you can use wxWindows 2.4 with them.
+than 2.95.3 don't work; you can use wxWidgets 2.4 with them.
NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
section (see OLD VERSIONS)
-There are two methods of compiling wxWindows, by using the
+There are two methods of compiling wxWidgets, by using the
makefiles provided or by using 'configure'.
Retrieve and install the latest version of Cygwin, or MinGW, as per
the instructions with either of these packages.
If using MinGW, you can download the add-on MSYS package to
-provide Unix-like tools that you'll need to build wxWindows using configure.
+provide Unix-like tools that you'll need to build wxWidgets using configure.
Using makefiles directly
-------------------------
+----------------------------------------------------------------
-NOTE: The makefile are for compilation under Cygwin, MSYS, or
- command.com/cmd.exe, they won't work in other environments
- (such as UNIX)
+NOTE: The makefile.gcc makefiles are for compilation under MinGW using
+ native make and Windows command interpreter (command.com/cmd.exe), they
+ won't work in other environments (such as UNIX or Unix-like, e.g. MSYS;
+ you have to use configure instead)
Here are the steps required using the provided makefiles:
- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
variable to "2.95".
-- Use the makefile.gcc files for compiling wxWindows and samples,
- e.g. to compile a debugging version of wxWindows:
+- If you are compiling with GCC 3.x using makefiles and with wxUSE_STL == 1
+ you need to manually add -DNO_GCC_PRAGMA to CXXFLAGS in config.gcc.
+
+- Use the makefile.gcc files for compiling wxWidgets and samples,
+ e.g. to compile a debugging version of wxWidgets:
> cd c:\wx\build\msw
> make -f makefile.gcc BUILD=debug
> cd c:\wx\samples\minimal
and other intermediate compiler files.
Using configure
----------------
+----------------------------------------------------------------
Instead of using the makefiles, you can use the configure
system to generate appropriate makefiles, as used on Unix
and Mac OS X systems.
-Change directory to the root of the wxWindows distribution,
+Change directory to the root of the wxWidgets distribution,
make a build directory, and run configure and make in this directory.
For example:
Notes:
1. See also the Cygwin/MinGW on the web site or CD-ROM for
- further information about using wxWindows with these compilers.
+ further information about using wxWidgets with these compilers.
2. libwx.a is 100 MB or more - but much less if compiled with no
debug info (-g0) and level 4 optimization (-O4).
as follows:
/usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
- /usr/local/include/wx - wxWindows header files
+ /usr/local/include/wx - wxWidgets header files
/usr/local/bin - wx-config
You may need to do this if using wx-config with the
flagged when the program quits. You can use Cygwin gdb
to debug MinGW executables.
-
OLD VERSIONS:
- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
- For Cygwin, make sure there's a \tmp directory on your
Windows drive or bison will crash (actually you don't need
- bison for ordinary wxWindows compilation: a pre-generated .c file is
+ bison for ordinary wxWidgets compilation: a pre-generated .c file is
supplied).
- If using GnuWin32 b18, you will need to copy windres.exe
Symantec & DigitalMars C++ compilation
---------------------------------------
+----------------------------------------------------------------
+
The DigitalMars compiler is a free succssor to the Symantec compiler
and can be downloaded from http://www.digitalmars.com/
1. You need to download and unzip in turn (later packages will overwrite
older files)
- Digital Mars C/C++ Compiler Version 8.33
- Basic utilities
- beta test C++ Compiler Version 8.34
- from http://www.digitalmars.com/download/freecompiler.html [02 may 03, CE]
+ Digital Mars C/C++ Compiler Version 8.40 or later
+ Basic utilities
+ from http://www.digitalmars.com/download/freecompiler.html
-2. Change directory to build\msw. Type 'make -f makefile.dm' to
- make the wxWindows core library.
-3. Change directory to samples\minimal and type 'make -f makefile.dm'
- to make this sample. The mdi and image sample also work; others may give
- linker erros due to missing libraries
+2. Change directory to build\msw and type 'make -f makefile.dmc' to
+ make the wxWidgets core library.
+
+3. Change directory to samples\minimal and type 'make -f makefile.dmc'
+ to make this sample. Most of the other samples also work.
+
+
+Note that if you don't have the files makefile.dmc you may create them yourself
+using bakefile tool according to the instructions in build\bakefiles\README:
+
+ cd build\bakefiles
+ bakefile_gen -f dmars -b wx.bkl
+ bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl
-16-bit compilation is no longer supported.
+16-bit compilation is no longer supported.
Configuring the build
-=====================
+================================================================
-So far the instructions only explained how to build release DLLs of wxWindows
+So far the instructions only explained how to build release DLLs of wxWidgets
and did not cover any configuration. It is possible to change many aspects of
the build, including debug/release and ANSI/Unicode settings. All makefiles in
build\msw directory use same options (with a few exceptions documented below)
names and in make invocation command.
Changing the settings
----------------------
+----------------------------------------------------------------
There are two ways to modify the settings: either by passing the values as
arguments when invoking make or by editing build\msw\config.$(compiler) file
where $(compiler) is same extension as the makefile you use has (see below).
The latter is good for setting options that never change in your development
process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
-wxWindows and use them side by side, the former method is better. Settings in
+wxWidgets and use them side by side, the former method is better. Settings in
config.* files are shared by all makefiles (samples, contrib, main library),
but if you pass the options as arguments, you must use same arguments you used
for the library when building samples or contrib libraries!
> nmake -f makefile.vc BUILD=debug UNICODE=1
Borland C++:
- > nmake -f makefile.bcc -DBUILD=debug -DUNICODE=1
+ > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
(Note that you have to use -D to set the variable, unlike in other make
tools!)
build\msw\config.* file; more detailed description follows.
Basic options
--------------
+----------------------------------------------------------------
-BUILD=debug
- Builds debug version of the library (default is 'release'). This affects
- name of the library ('d' is appended), __WXDEBUG__ is defined and debug
- information compiled into object files and the executable.
+BUILD=release
+ Builds release version of the library. It differs from default 'debug'
+ in lack of appended 'd' in name of library, does not define __WXDEBUG__
+ and not include debug information compiled into object files and the
+ executable.
-SHARED=0
- Build static libraries instead of DLLs. By default, DLLs are build
- (SHARED=1).
+SHARED=1
+ Build shared libraries (DLLs). By default, DLLs are not built
+ (SHARED=0).
UNICODE=1
To build Unicode versions of the libraries, add UNICODE=1 to make invocation
WXUNIV=1
Build wxUniversal instead of native wxMSW (see
- http://www.wxwindows.org/wxuniv.htm for more information).
+ http://www.wxwidgets.org/wxuniv.htm for more information).
Advanced options
-----------------
+----------------------------------------------------------------
MONOLITHIC=1
- Starting with version 2.5.0, wxWindows has the ability to be built as
+ Starting with version 2.5.1, wxWidgets has the ability to be built as
several smaller libraries instead of single big one as used to be the case
in 2.4 and older versions. This is called "multilib build" and is the
default behaviour of makefiles. You can still build single library
Do not build wxHTML library. If MONOLITHIC=1, then you must also
#define wxUSE_HTML 1 in setup.h.
+USE_XRC=0
+ Do not build XRC resources library. If MONOLITHIC=1, then you must also
+ #define wxUSE_HTML 1 in setup.h.
+
RUNTIME_LIBS=static
Links static version of C and C++ runtime libraries into the executable, so
that the program does not depend on DLLs provided with the compiler (e.g.
VENDOR=<your company name>
Set this to a short string identifying your company if you are planning to
- distribute wxWindows DLLs with your application. Default value is 'custom'.
- This string is included as part of DLL name. wxWindows DLLs contain compiler
+ distribute wxWidgets DLLs with your application. Default value is 'custom'.
+ This string is included as part of DLL name. wxWidgets DLLs contain compiler
name, version information and vendor name in them. For example
wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
default settings. If you set VENDOR=mycorp, the name will change to
wxmsw250_core_bcc_mycorp.dll.
CFG=<configuration name>
- Sets configuration name so that you can have multiple wxWindows build with
+ Sets configuration name so that you can have multiple wxWidgets builds with
different setup.h settings coexisting in same tree. See "Object and library
directories" below for more information.
Compiler specific options
--------------------------
+----------------------------------------------------------------
* MinGW
setting makes it possible.
Fine-tuning the compiler
-------------------------
+----------------------------------------------------------------
All makefiles have variables that you can use to specify additional options
passed to the compiler or linker. You won't need this in most cases, but if you
compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
Object and library directories
-------------------------------
+----------------------------------------------------------------
All object files produced during library build are stored in a directory under
build\msw. It's name is derived from build settings and CFG variable and from
lib\bcc_dllMyBuild
etc.
-By now it is clear for CFG is for: builds with different CFG settings don't
+By now it is clear what CFG is for: builds with different CFG settings don't
share any files and they use different setup.h files. This allows you to e.g.
have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
enabled (without CFG, both of them would be put into same directory and there
-would be conflict between the files).
-
+would be conflicts between the files).
General Notes
-=============
+=================================================================
- Debugging: under Windows 95, debugging output isn't output in
the same way that it is under NT or Windows 3.1.
- Please see DebugView (bin/dbgview.exe in the distribution), also
- available from http://www.sysinternals.com and on the wxWindows CD-ROM
- under Packages.
-
-- If you are installing wxWindows 2 from CVS, you may find that
- include/wx/msw/setup.h is missing. This is deliberate, to avoid
- developers' different setup.h configurations getting confused.
- Please copy setup0.h to setup.h before compiling. Also, read
- the BuildCVS.txt for other hints.
+ Please see DebugView available from http://www.sysinternals.com.
+
projects / wxWidgets.git / blobdiff