WxExtLib - Configuration
Daniel Käps
generated %%date(%Y-%m-%d), modified tag: 2007-03-31


%% [°{>>:WxExtLib Documentation Index:../doc/DocIndex.html}°]

========================================================================

=== Defines for core parts of WxExtLib

------------------------------------------------------------------------

==- WxExtLib class and function export declarators

- **settings**:
  - settings for wxMSW/Win32/VC++
``` #define M_WxExtLib_ExportDecl (not defined/__declspec(dllexport)/__declspec(dllimport))

  - settings for non-wxMSW/Win32/VC++:
``` #define M_WxExtLib_ExportDecl (not defined)

  - settings which automatically cause M_WxExtLib_ExportDecl
    to be defined as __declspec(dllexport)
``` #define M_WxExtLib_IsExtLibDllExport (defined/not defined)

  - settings which automatically cause M_WxExtLib_ExportDecl
    to be defined as __declspec(dllimport)
``` #define M_WxExtLib_IsExtLibDllImport (defined/not defined)

- **notes**:
  - some functions may have missing export declarator macros, because this
    DLL import/exports have not been used recently
  - declaration of DLL exports in Windows compilations is always 
    a bit tricky


-------------------------------------------------------------------------

==- WxMessageFormat additional std::string interface

- make wxMessageFormatter/wxFormat/wxFormatMessage to be usable for
  std::string 
- will emit classes/functions with names like 
  stMessageFormatter/stFormat/stFormatMessage
- both variants can be used in parallel (e.g. to have wxFormatMessage()
  and stFormatMessage() in a single program

- **settings**:
``` #define M_MessageFormat_StdString (defined/not defined)

- **notes**: 
  - for WxExtLib, wxString interface is always needed (and therefore
    set in WxExtLibConfig_Auto.h)
``` #define M_MessageFormat_WxString (always defined)

- **development**:
{{::NoteBox::
    WxMessageFormat.h,.cpp files are superseeded by StxFormatMessage.h,.cpp.
    Development and changes shall be made to StxFormatMessage.h,.cpp
    (not yet published).
}}::NoteBox::


------------------------------------------------------------------------

==- Inclusion of Stdafx.h header

- inclusion of "Stdafx.h" header first may be required if using MFC
  and precompiled headers with VC++ 
- this causes and '#include "Stdafx.h"' from WxExtLibConfig.h
- using it may be required when using M_WxExtLib_IsMFCCompatibility

- **settings**:
``` #define M_WxExtLib_IsIncludeStdafxHeader (defined/not defined)


------------------------------------------------------------------------

==- Use of Stx/Sontaia logging

- (this requires not yet published Sontaia library)
- **settings**:
``` #define M_WxExtLib_IsUseStxLogging (0/1)


------------------------------------------------------------------------

=== Defines for optional parts

==- wxFilteredDIB support

- requires ImageMagick library headers and linking with ImageMagick
  core library
- can currently probably be used only with wxMSW where required
  DIB functions/structure declarations are available

- **settings**:
``` #define M_WxExtLib_IsFilteredDIBEnabled (defined/not defined)


------------------------------------------------------------------------

==- MFC compatibility functions

- enable MFC compatibility function MSWCreateChildWindowForMFCFrame()

- **settings**:
``` #define M_WxExtLib_IsMFCCompatibility (defined/not defined)


------------------------------------------------------------------------

==- GraphicsHelper support

- requires GraphicsHelper.h header to be accessible during compilation

- **settings**:
``` #define M_WxExtLib_IsUseGraphicsHelper (1/0)


------------------------------------------------------------------------

==- RecordsetNavigationManag integration with OTL library

- currently used only in TRecordsetNavigationManag (in files
  RecordsetNavigationManag.h,.cpp)

- **settings**:
``` #define M_WxExtLib_IsUseOTL (0/1)

- **notes**:
  - RecordsetNavigationManag.h,.cpp is a not yet published
    part of WxExtLib


------------------------------------------------------------------------