The tree only sets the focus in response to a TVN_SELCHANGINGW event if the tree...

[wxWidgets.git] / docs / msw / install.txt

diff --git a/docs/msw/install.txt b/docs/msw/install.txt
index bcb980f7807ea1e9a7379ee32bb52a282d75a7f3..74f4101987bdd9c486d8712db04974c32b80c957 100644 (file)
--- a/docs/msw/install.txt
+++ b/docs/msw/install.txt
@@ -24,8 +24,15 @@ fixing the problems so this ensures that your report will be
 addressed sooner.
 
 
 addressed sooner.
 
 

-Unarchiving
-===========
+Table of Contents:
+ - Installation
+ - Building wxWidgets
+ - Configuring the Build
+ - Building Applications Using wxWidgets
+
+
+Installation
+============

 
 Please simply uncompress the .zip file manually into any directory.
 However we advise avoiding using directories with spaces in their
 
 Please simply uncompress the .zip file manually into any directory.
 However we advise avoiding using directories with spaces in their


@@ -33,9 +40,6 @@ names (notably "C:\Program Files") as this risks creating problems
 with makefiles and other command-line tools.
 
 
 with makefiles and other command-line tools.
 
 

-Configuration
-=============
-

 In the majority of cases, you don't need to change the default
 library build configuration. If you wish to change some of the build
 options you need to edit the include/wx/msw/setup.h file enabling or
 In the majority of cases, you don't need to change the default
 library build configuration. If you wish to change some of the build
 options you need to edit the include/wx/msw/setup.h file enabling or


@@ -50,13 +54,21 @@ Notice that this file is later copied into a directory under lib for
 each of the build configurations which allows to have different
 build options for different configurations too.
 
 each of the build configurations which allows to have different
 build options for different configurations too.
 

+See "Configuring the Build" section for more information.

 
 

-Compilation
-===========
+
+Building wxWidgets
+==================

 
 The following sections explain how to compile wxWidgets 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.
+compiler, see the "Building Applications" section about the instructions for
+building your application using wxWidgets.
+
+Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/Cygwin/Mingw32
+to quickly locate the instructions for your compiler. Notice that the primary
+compilers for wxWidgets under MSW are Microsoft Visual C++ and GNU g++, other
+compilers are more rarely tested and might not work so please consider using
+one of these two if possible.

 
 All makefiles and project are located in build\msw directory.
 
 
 All makefiles and project are located in build\msw directory.
 


@@ -142,8 +154,7 @@ Using project files (VC++ 6 and later):
    Alternatively, use the special wx_dll.dsw project which adds the
    dependencies to force the correct order (but, because of this, doesn't work
    for the static libraries) or simply redo the build several times until all
    Alternatively, use the special wx_dll.dsw project which adds the
    dependencies to force the correct order (but, because of this, doesn't work
    for the static libraries) or simply redo the build several times until all

-   DLLs are linked correctly. Please notice that it's normal that dbgrid project
-   doesn't build if wxUSE_ODBC is set to 0 (default).
+   DLLs are linked correctly.

 3. Open a sample project file, choose a configuration such as
    Win32 Debug using Build | Set Active Configuration..., and compile.
    The project files don't use precompiled headers, to save disk
 3. Open a sample project file, choose a configuration such as
    Win32 Debug using Build | Set Active Configuration..., and compile.
    The project files don't use precompiled headers, to save disk


@@ -300,12 +311,7 @@ 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.
 
 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 wxWidgets. The same applies if compiling using the IDE.
-
-Note (3): If you wish debug messages to be sent to the console in
+Note (2): 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.
 
 Using the Debugger and IDE in BDS or Turbo Explorer
 debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
 
 Using the Debugger and IDE in BDS or Turbo Explorer


@@ -355,22 +361,18 @@ Watcom C++ 10.6/11 and OpenWatcom Compilation
 2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
    to make this sample. Repeat for other samples of interest.
 
 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.
-
-Note (2): if variant.cpp is compiled with date/time class options, the linker
+Note (1): if variant.cpp is compiled with date/time class options, the linker

           gives up. So the date/time option is switched off for Watcom C++.
           Also, wxAutomationObject is not compiled with Watcom C++ 10.
 
           gives up. So the date/time option is switched off for Watcom C++.
           Also, wxAutomationObject is not compiled with Watcom C++ 10.
 

-Note (3): RawBitmaps won't work at present because they use unsupported template
+Note (2): RawBitmaps won't work at present because they use unsupported template

           classes
 
           classes
 

-Note (4): if Watcom can't read the precompiled header when building a sample,
+Note (3): if Watcom can't read the precompiled header when building a sample,

           try deleting .pch files in build\msw\wat_* and compiling
           the sample again.
 
           try deleting .pch files in build\msw\wat_* and compiling
           the sample again.
 

-Note (5): wxUSE_STD_STRING is disabled in wx/string.h for Watcom as this
+Note (4): wxUSE_STD_STRING is disabled in wx/string.h for Watcom as this

           compiler doesn't come with standard C++ library headers by default.
           If you install STLPort or another STL implementation, you'll need to
           edit wx/string.h and remove the check for Digital Mars in it (search
           compiler doesn't come with standard C++ library headers by default.
           If you install STLPort or another STL implementation, you'll need to
           edit wx/string.h and remove the check for Digital Mars in it (search


@@ -692,10 +694,10 @@ Basic Options
 ----------------------------------------------------------------
 
 BUILD=release
 ----------------------------------------------------------------
 
 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.
+  Builds release version of the library. It differs from default 'debug' in
+  lack of appended 'd' in name of library and uses the release CRT libraries
+  instead of debug ones. Notice that even release builds do include debug
+  information by default, see DEBUG_FLAG for more information about it.

 
 SHARED=1
   Build shared libraries (DLLs). By default, DLLs are not built
 
 SHARED=1
   Build shared libraries (DLLs). By default, DLLs are not built


@@ -735,11 +737,6 @@ USE_OPENGL=1
   OpenGL library is always built as additional library, even in monolithic
   build!
 
   OpenGL library is always built as additional library, even in monolithic
   build!
 

-USE_ODBC=1
-  Build two additional libraries in multilib mode, one with database
-  classes and one with wxGrid database support. You must
-  #define wxUSE_ODBC 1 in setup.h
-

 USE_HTML=0
   Do not build wxHTML library. If MONOLITHIC=1, then you must also
   #define wxUSE_HTML 1 in setup.h.
 USE_HTML=0
   Do not build wxHTML library. If MONOLITHIC=1, then you must also
   #define wxUSE_HTML 1 in setup.h.


@@ -766,16 +763,22 @@ MSLU=1
 
 DEBUG_FLAG=0
 DEBUG_FLAG=1
 
 DEBUG_FLAG=0
 DEBUG_FLAG=1

-  If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
-  sanity checks at runtime. If set to 0, don't do it. By default, this is
-  governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
-  but it is sometimes desirable to modify default behaviour and e.g. define
-  __WXDEBUG__ even in release builds.
+DEBUG_FLAG=2
+  Specifies the level of debug support in wxWidgets. Notice that
+  this is independent from both BUILD and DEBUG_INFO options. By default
+  always set to 1 meaning that debug support is enabled: asserts are compiled
+  into the code (they are inactive by default in release builds of the
+  application but can be enabled), wxLogDebug() and wxLogTrace() are available
+  and __WXDEBUG__ is defined. Setting it to 0 completely disables all
+  debugging code in wxWidgets while setting it to 2 enables even the time
+  consuming assertions and checks which are deemed to be unsuitable for
+  production environment.

 
 DEBUG_INFO=0
 DEBUG_INFO=1
 
 DEBUG_INFO=0
 DEBUG_INFO=1

-  Same as DEBUG_FLAG in behaviour, this option affects whether debugging
-  information is included in the executable or not.
+  This option affects whether debugging information is generated. If
+  omitted or set to 'default' its value is determined the value of
+  the BUILD option.

 
 TARGET_CPU=AMD64|IA64
   (VC++ only.) Set this variable to build for x86_64 systems. If unset, x86
 
 TARGET_CPU=AMD64|IA64
   (VC++ only.) Set this variable to build for x86_64 systems. If unset, x86


@@ -883,10 +886,40 @@ you to have two static debug builds, one with wxUSE_SOCKETS=0 and one with socke
 enabled (without CFG, both of them would be put into same directory and there
 would be conflicts between the files).
 
 enabled (without CFG, both of them would be put into same directory and there
 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 available from http://www.sysinternals.com.

 
 

+Building Applications Using wxWidgets
+=====================================
+
+NB: The makefiles and project files provided with wxWidgets samples show which
+    flags should be used when building applications using wxWidgets so in case
+    of a problem, e.g. if the instructions here are out of date, you can always
+    simply copy a makefile or project file from samples\minimal or some other
+    sample and adapt it to your application.
+
+Independently of the compiler and make/IDE you are using you must do the
+following to use wxWidgets:
+
+* Add $WXWIN/include to the
+  - compiler
+  - resource compiler
+  include paths.
+* Define the following symbols for the preprocessor:
+  - __WXMSW__ to ensure you use the correct wxWidgets port.
+  - _UNICODE unless you want to use deprecated ANSI build of wxWidgets.
+  - NDEBUG if you want to build in release mode, i.e. disable asserts.
+  - WXUSINGDLL if you are using DLL build of wxWidgets.
+* Add $WXWIN/lib/prefix_lib-or-dll to the libraries path. The prefix depends
+  on the compiler, by default it is "vc" for MSVC, "gcc" for g++ and so on.
+* Add the list of libraries to link with to the linker input. The exact list
+  depends on which libraries you use and whether you built wxWidgets in
+  monolithic or default multlib mode and basically should include all the
+  relevant libraries from the directory above, e.g. "wxmsw29ud_core.lib
+  wxbase29ud.lib wxtiffd.lib wxjpegd.lib wxpngd.lib wxzlibd.lib wxregexud.lib
+  wxexpatd.lib" for a debug build of an application using the core library only
+  (all wxWidgets applications use the base library).
+
+
+Microsoft Visual C++ users can simplify the linker setup by prepending the
+directory $WXWIN/msvc to the include path (it must come before $WXWIN/include
+directory!) and omitting the last step: the required libraries will be linked
+in automatically using the "#pragma comment(lib)" feature of this compiler.