]> git.saurik.com Git - wxWidgets.git/blame - include/wx/setup_inc.h
added support for user-defined types to wxConfig (patch 1753875)
[wxWidgets.git] / include / wx / setup_inc.h
CommitLineData
99d80019
JS
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/setup_inc.h
3// Purpose: setup.h settings
4// Author: Vadim Zeitlin
5// Modified by:
6// Created:
7// RCS-ID: $Id$
8// Copyright: (c) Vadim Zeitlin
9// Licence: wxWindows licence
10///////////////////////////////////////////////////////////////////////////////
ff3a660b
VZ
11
12// ----------------------------------------------------------------------------
13// global settings
14// ----------------------------------------------------------------------------
15
16// define this to 0 when building wxBase library - this can also be done from
17// makefile/project file overriding the value here
18#ifndef wxUSE_GUI
19 #define wxUSE_GUI 1
20#endif // wxUSE_GUI
21
22// ----------------------------------------------------------------------------
23// compatibility settings
24// ----------------------------------------------------------------------------
25
dee1a63f 26// This setting determines the compatibility with 2.6 API: set it to 0 to
ff3a660b
VZ
27// flag all cases of using deprecated functions.
28//
29// Default is 1 but please try building your code with 0 as the default will
30// change to 0 in the next version and the deprecated functions will disappear
31// in the version after it completely.
32//
33// Recommended setting: 0 (please update your code)
abb6edd1
VS
34#define WXWIN_COMPATIBILITY_2_6 0
35
36// This setting determines the compatibility with 2.8 API: set it to 0 to
37// flag all cases of using deprecated functions.
38//
39// Default is 1 but please try building your code with 0 as the default will
40// change to 0 in the next version and the deprecated functions will disappear
41// in the version after it completely.
42//
43// Recommended setting: 0 (please update your code)
44#define WXWIN_COMPATIBILITY_2_8 1
ff3a660b 45
ed6dd18a
VZ
46// MSW-only: Set to 0 for accurate dialog units, else 1 for old behaviour when
47// default system font is used for wxWindow::GetCharWidth/Height() instead of
48// the current font.
ff3a660b 49//
ed6dd18a 50// Default is 0
ff3a660b 51//
ed6dd18a
VZ
52// Recommended setting: 0
53#define wxDIALOG_UNIT_COMPATIBILITY 0
ff3a660b
VZ
54
55// ----------------------------------------------------------------------------
56// debugging settings
57// ----------------------------------------------------------------------------
58
59// Generic comment about debugging settings: they are very useful if you don't
60// use any other memory leak detection tools such as Purify/BoundsChecker, but
61// are probably redundant otherwise. Also, Visual C++ CRT has the same features
62// as wxWidgets memory debugging subsystem built in since version 5.0 and you
63// may prefer to use it instead of built in memory debugging code because it is
64// faster and more fool proof.
65//
66// Using VC++ CRT memory debugging is enabled by default in debug mode
67// (__WXDEBUG__) if wxUSE_GLOBAL_MEMORY_OPERATORS is *not* enabled (i.e. is 0)
68// and if __NO_VC_CRTDBG__ is not defined.
69
70// If 1, enables wxDebugContext, for writing error messages to file, etc. If
71// __WXDEBUG__ is not defined, will still use the normal memory operators.
72//
73// Default is 0
74//
75// Recommended setting: 0
76#define wxUSE_DEBUG_CONTEXT 0
77
78// If 1, enables debugging versions of wxObject::new and wxObject::delete *IF*
79// __WXDEBUG__ is also defined.
80//
81// WARNING: this code may not work with all architectures, especially if
82// alignment is an issue. This switch is currently ignored for mingw / cygwin
83//
84// Default is 0
85//
86// Recommended setting: 1 if you are not using a memory debugging tool, else 0
87#define wxUSE_MEMORY_TRACING 0
88
89// In debug mode, cause new and delete to be redefined globally.
90// If this causes problems (e.g. link errors which is a common problem
91// especially if you use another library which also redefines the global new
92// and delete), set this to 0.
93// This switch is currently ignored for mingw / cygwin
94//
95// Default is 0
96//
97// Recommended setting: 0
98#define wxUSE_GLOBAL_MEMORY_OPERATORS 0
99
100// In debug mode, causes new to be defined to be WXDEBUG_NEW (see object.h). If
101// this causes problems (e.g. link errors), set this to 0. You may need to set
102// this to 0 if using templates (at least for VC++). This switch is currently
103// ignored for mingw / cygwin / CodeWarrior
104//
105// Default is 0
106//
107// Recommended setting: 0
108#define wxUSE_DEBUG_NEW_ALWAYS 0
109
110// wxHandleFatalExceptions() may be used to catch the program faults at run
111// time and, instead of terminating the program with a usual GPF message box,
112// call the user-defined wxApp::OnFatalException() function. If you set
113// wxUSE_ON_FATAL_EXCEPTION to 0, wxHandleFatalExceptions() will not work.
114//
115// This setting is for Win32 only and can only be enabled if your compiler
116// supports Win32 structured exception handling (currently only VC++ does)
117//
118// Default is 1
119//
120// Recommended setting: 1 if your compiler supports it.
6cbe14ba 121#define wxUSE_ON_FATAL_EXCEPTION 1
ff3a660b 122
eaff0f0d 123// Set this to 1 to be able to generate a human-readable (unlike
88783bc4 124// machine-readable minidump created by wxCrashReport::Generate()) stack back
eaff0f0d
VZ
125// trace when your program crashes using wxStackWalker
126//
127// Default is 1 if supported by the compiler.
128//
129// Recommended setting: 1, set to 0 if your programs never crash
130#define wxUSE_STACKWALKER 1
131
88783bc4
VZ
132// Set this to 1 to compile in wxDebugReport class which allows you to create
133// and optionally upload to your web site a debug report consisting of back
134// trace of the crash (if wxUSE_STACKWALKER == 1) and other information.
135//
136// Default is 1 if supported by the compiler.
137//
0978fcb3
VZ
138// Recommended setting: 1, it is compiled into a separate library so there
139// is no overhead if you don't use it
140#define wxUSE_DEBUGREPORT 1
88783bc4 141
ff3a660b
VZ
142// ----------------------------------------------------------------------------
143// Unicode support
144// ----------------------------------------------------------------------------
145
146// Set wxUSE_UNICODE to 1 to compile wxWidgets in Unicode mode: wxChar will be
147// defined as wchar_t, wxString will use Unicode internally. If you set this
148// to 1, you must use wxT() macro for all literal strings in the program.
149//
150// Unicode is currently only fully supported under Windows NT/2000/XP
151// (Windows 9x doesn't support it and the programs compiled in Unicode mode
152// will not run under 9x -- but see wxUSE_UNICODE_MSLU below).
153//
7da37f2c 154// Default is 0 (but only because of makefiles)
ff3a660b 155//
4fc1c0f0 156// Recommended setting: 1
ff3a660b 157#ifndef wxUSE_UNICODE
7da37f2c 158 #define wxUSE_UNICODE 0
ff3a660b
VZ
159#endif
160
ff3a660b
VZ
161// Setting wxUSE_WCHAR_T to 1 gives you some degree of Unicode support without
162// compiling the program in Unicode mode. More precisely, it will be possible
163// to construct wxString from a wide (Unicode) string and convert any wxString
164// to Unicode.
165//
166// Default is 1
167//
168// Recommended setting: 1
169#define wxUSE_WCHAR_T 1
170
171// ----------------------------------------------------------------------------
172// global features
173// ----------------------------------------------------------------------------
174
175// Compile library in exception-safe mode? If set to 1, the library will try to
176// behave correctly in presence of exceptions (even though it still will not
177// use the exceptions itself) and notify the user code about any unhandled
178// exceptions. If set to 0, propagation of the exceptions through the library
179// code will lead to undefined behaviour -- but the code itself will be
180// slightly smaller and faster.
181//
b39c4812
VZ
182// Note that like wxUSE_THREADS this option is automatically set to 0 if
183// wxNO_EXCEPTIONS is defined.
184//
ff3a660b
VZ
185// Default is 1
186//
187// Recommended setting: depends on whether you intend to use C++ exceptions
188// in your own code (1 if you do, 0 if you don't)
189#define wxUSE_EXCEPTIONS 1
190
191// Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI
192//
193// Default is 0
194//
28999ba6 195// Recommended setting: 0 (this is still work in progress...)
ff3a660b
VZ
196#define wxUSE_EXTENDED_RTTI 0
197
ff3a660b
VZ
198// Set wxUSE_STL to 1 to derive wxList(Foo) and wxArray(Foo) from
199// std::list<Foo*> and std::vector<Foo*>, with a compatibility interface,
200// and for wxHashMap to be implemented with templates.
201//
202// Default is 0
203//
204// Recommended setting: YMMV
205#define wxUSE_STL 0
206
207// Support for message/error logging. This includes wxLogXXX() functions and
208// wxLog and derived classes. Don't set this to 0 unless you really know what
209// you are doing.
210//
211// Default is 1
212//
213// Recommended setting: 1 (always)
214#define wxUSE_LOG 1
215
216// Recommended setting: 1
217#define wxUSE_LOGWINDOW 1
218
219// Recommended setting: 1
220#define wxUSE_LOGGUI 1
221
222// Recommended setting: 1
223#define wxUSE_LOG_DIALOG 1
224
225// Support for command line parsing using wxCmdLineParser class.
226//
227// Default is 1
228//
229// Recommended setting: 1 (can be set to 0 if you don't use the cmd line)
230#define wxUSE_CMDLINE_PARSER 1
231
232// Support for multithreaded applications: if 1, compile in thread classes
233// (thread.h) and make the library a bit more thread safe. Although thread
234// support is quite stable by now, you may still consider recompiling the
235// library without it if you have no use for it - this will result in a
236// somewhat smaller and faster operation.
237//
b39c4812
VZ
238// Notice that if wxNO_THREADS is defined, wxUSE_THREADS is automatically reset
239// to 0 in wx/chkconf.h, so, for example, if you set USE_THREADS to 0 in
b39c4812 240// build/msw/config.* file this value will have no effect.
ff3a660b
VZ
241//
242// Default is 1
243//
244// Recommended setting: 0 unless you do plan to develop MT applications
245#define wxUSE_THREADS 1
246
b0d969e8
VZ
247// If enabled, compiles wxWidgets streams classes
248//
249// wx stream classes are used for image IO, process IO redirection, network
250// protocols implementation and much more and so disabling this results in a
251// lot of other functionality being lost.
252//
253// Default is 1
254//
255// Recommended setting: 1 as setting it to 0 disables many other things
ff3a660b
VZ
256#define wxUSE_STREAMS 1
257
b0d969e8 258// Use standard C++ streams if 1 instead of wx streams in some places. If
3ff260ae 259// disabled (default), wx streams are used everywhere and wxWidgets doesn't
b0d969e8
VZ
260// depend on the standard streams library.
261//
262// Notice that enabling this does not replace wx streams with std streams
263// everywhere, in a lot of places wx streams are used no matter what.
264//
265// Default is 0
266//
267// Recommended setting: 1 if you use the standard streams anyhow and so
268// dependency on the standard streams library is not a
269// problem
ff3a660b
VZ
270#define wxUSE_STD_IOSTREAM 0
271
a70abf19 272// Enable conversion to standard C++ string if 1.
8bb9d852
MW
273//
274// Default is 1 for most compilers.
275//
276// Currently the Digital Mars and Watcom compilers come without standard C++
277// library headers by default, wxUSE_STD_STRING can be set to 1 if you do have
278// them (e.g. from STLPort).
279//
280// VC++ 5.0 does include standard C++ library header, however they produce
281// many warnings that can't be turned off when compiled at warning level 4.
282#if defined(__DMC__) || defined(__WATCOMC__) \
283 || (defined(_MSC_VER) && _MSC_VER < 1200)
284 #define wxUSE_STD_STRING 0
285#else
286 #define wxUSE_STD_STRING 1
287#endif
668d55c9 288
7a828c7f
VZ
289// Support for positional parameters (e.g. %1$d, %2$s ...) in wxVsnprintf.
290// Note that if the system's implementation does not support positional
291// parameters, setting this to 1 forces the use of the wxWidgets implementation
292// of wxVsnprintf. The standard vsnprintf() supports positional parameters on
293// many Unix systems but usually doesn't under Windows.
294//
295// Positional parameters are very useful when translating a program since using
296// them in formatting strings allow translators to correctly reorder the
297// translated sentences.
298//
299// Default is 1
300//
301// Recommended setting: 1 if you want to support multiple languages
7b4eedf6 302#define wxUSE_PRINTF_POS_PARAMS 1
7a828c7f 303
ff3a660b
VZ
304// ----------------------------------------------------------------------------
305// non GUI features selection
306// ----------------------------------------------------------------------------
307
308// Set wxUSE_LONGLONG to 1 to compile the wxLongLong class. This is a 64 bit
309// integer which is implemented in terms of native 64 bit integers if any or
310// uses emulation otherwise.
311//
312// This class is required by wxDateTime and so you should enable it if you want
313// to use wxDateTime. For most modern platforms, it will use the native 64 bit
314// integers in which case (almost) all of its functions are inline and it
315// almost does not take any space, so there should be no reason to switch it
316// off.
317//
318// Recommended setting: 1
319#define wxUSE_LONGLONG 1
320
4db03d26
VZ
321// Set wxUSE_BASE64 to 1, to compile in Base64 support. This is required for
322// storing binary data in wxConfig on most platforms.
323//
324// Default is 1.
325//
326// Recommended setting: 1 (but can be safely disabled if you don't use it)
327#define wxUSE_BASE64 1
328
a1873279
VZ
329// Set this to 1 to be able to use wxEventLoop even in console applications
330// (i.e. using base library only, without GUI). This is mostly useful for
331// processing socket events but is also necessary to use timers in console
332// applications
333//
334// Default is 1.
335//
336// Recommended setting: 1 (but can be safely disabled if you don't use it)
337#define wxUSE_CONSOLE_EVENTLOOP 1
338
ff3a660b
VZ
339// Set wxUSE_(F)FILE to 1 to compile wx(F)File classes. wxFile uses low level
340// POSIX functions for file access, wxFFile uses ANSI C stdio.h functions.
341//
342// Default is 1
343//
344// Recommended setting: 1 (wxFile is highly recommended as it is required by
345// i18n code, wxFileConfig and others)
346#define wxUSE_FILE 1
347#define wxUSE_FFILE 1
348
349// Use wxFSVolume class providing access to the configured/active mount points
350//
351// Default is 1
352//
353// Recommended setting: 1 (but may be safely disabled if you don't use it)
354#define wxUSE_FSVOLUME 1
355
07158944
VZ
356// Use wxStandardPaths class which allows to retrieve some standard locations
357// in the file system
358//
359// Default is 1
360//
361// Recommended setting: 1 (may be disabled to save space, but not much)
362#define wxUSE_STDPATHS 1
363
ff3a660b
VZ
364// use wxTextBuffer class: required by wxTextFile
365#define wxUSE_TEXTBUFFER 1
366
367// use wxTextFile class: requires wxFile and wxTextBuffer, required by
368// wxFileConfig
369#define wxUSE_TEXTFILE 1
370
371// i18n support: _() macro, wxLocale class. Requires wxTextFile.
372#define wxUSE_INTL 1
373
374// Set wxUSE_DATETIME to 1 to compile the wxDateTime and related classes which
375// allow to manipulate dates, times and time intervals. wxDateTime replaces the
376// old wxTime and wxDate classes which are still provided for backwards
377// compatibility (and implemented in terms of wxDateTime).
378//
379// Note that this class is relatively new and is still officially in alpha
380// stage because some features are not yet (fully) implemented. It is already
381// quite useful though and should only be disabled if you are aiming at
382// absolutely minimal version of the library.
383//
384// Requires: wxUSE_LONGLONG
385//
386// Default is 1
387//
388// Recommended setting: 1
389#define wxUSE_DATETIME 1
390
391// Set wxUSE_TIMER to 1 to compile wxTimer class
392//
393// Default is 1
394//
395// Recommended setting: 1
396#define wxUSE_TIMER 1
397
398// Use wxStopWatch clas.
399//
400// Default is 1
401//
402// Recommended setting: 1 (needed by wxSocket)
403#define wxUSE_STOPWATCH 1
404
405// Setting wxUSE_CONFIG to 1 enables the use of wxConfig and related classes
406// which allow the application to store its settings in the persistent
407// storage. Setting this to 1 will also enable on-demand creation of the
408// global config object in wxApp.
409//
410// See also wxUSE_CONFIG_NATIVE below.
411//
412// Recommended setting: 1
413#define wxUSE_CONFIG 1
414
415// If wxUSE_CONFIG is 1, you may choose to use either the native config
416// classes under Windows (using .INI files under Win16 and the registry under
417// Win32) or the portable text file format used by the config classes under
418// Unix.
419//
420// Default is 1 to use native classes. Note that you may still use
421// wxFileConfig even if you set this to 1 - just the config object created by
422// default for the applications needs will be a wxRegConfig or wxIniConfig and
423// not wxFileConfig.
424//
425// Recommended setting: 1
426#define wxUSE_CONFIG_NATIVE 1
427
428// If wxUSE_DIALUP_MANAGER is 1, compile in wxDialUpManager class which allows
429// to connect/disconnect from the network and be notified whenever the dial-up
430// network connection is established/terminated. Requires wxUSE_DYNAMIC_LOADER.
431//
432// Default is 1.
433//
434// Recommended setting: 1
435#define wxUSE_DIALUP_MANAGER 1
436
437// Compile in classes for run-time DLL loading and function calling.
438// Required by wxUSE_DIALUP_MANAGER.
439//
440// This setting is for Win32 only
441//
442// Default is 1.
443//
444// Recommended setting: 1
445#define wxUSE_DYNLIB_CLASS 1
446
447// experimental, don't use for now
448#define wxUSE_DYNAMIC_LOADER 1
449
450// Set to 1 to use socket classes
451#define wxUSE_SOCKETS 1
452
453// Set to 1 to enable virtual file systems (required by wxHTML)
454#define wxUSE_FILESYSTEM 1
455
456// Set to 1 to enable virtual ZIP filesystem (requires wxUSE_FILESYSTEM)
457#define wxUSE_FS_ZIP 1
458
26e422a9
MW
459// Set to 1 to enable virtual archive filesystem (requires wxUSE_FILESYSTEM)
460#define wxUSE_FS_ARCHIVE 1
461
ff3a660b
VZ
462// Set to 1 to enable virtual Internet filesystem (requires wxUSE_FILESYSTEM)
463#define wxUSE_FS_INET 1
464
81f90336 465// wxArchive classes for accessing archives such as zip and tar
9e8e867f 466#define wxUSE_ARCHIVE_STREAMS 1
81f90336 467
ff3a660b
VZ
468// Set to 1 to compile wxZipInput/OutputStream classes.
469#define wxUSE_ZIPSTREAM 1
470
26e422a9
MW
471// Set to 1 to compile wxTarInput/OutputStream classes.
472#define wxUSE_TARSTREAM 1
473
ff3a660b
VZ
474// Set to 1 to compile wxZlibInput/OutputStream classes. Also required by
475// wxUSE_LIBPNG
476#define wxUSE_ZLIB 1
477
478// If enabled, the code written by Apple will be used to write, in a portable
479// way, float on the disk. See extended.c for the license which is different
480// from wxWidgets one.
481//
482// Default is 1.
483//
484// Recommended setting: 1 unless you don't like the license terms (unlikely)
485#define wxUSE_APPLE_IEEE 1
486
487// Joystick support class
488#define wxUSE_JOYSTICK 1
489
ff427585
VZ
490// wxFontEnumerator class
491#define wxUSE_FONTENUM 1
492
ff3a660b
VZ
493// wxFontMapper class
494#define wxUSE_FONTMAP 1
495
496// wxMimeTypesManager class
497#define wxUSE_MIMETYPE 1
498
499// wxProtocol and related classes: if you want to use either of wxFTP, wxHTTP
500// or wxURL you need to set this to 1.
501//
502// Default is 1.
503//
504// Recommended setting: 1
505#define wxUSE_PROTOCOL 1
506
507// The settings for the individual URL schemes
508#define wxUSE_PROTOCOL_FILE 1
509#define wxUSE_PROTOCOL_FTP 1
510#define wxUSE_PROTOCOL_HTTP 1
511
512// Define this to use wxURL class.
513#define wxUSE_URL 1
514
515// Define this to use native platform url and protocol support.
516// Currently valid only for MS-Windows.
517// Note: if you set this to 1, you can open ftp/http/gopher sites
518// and obtain a valid input stream for these sites
519// even when you set wxUSE_PROTOCOL_FTP/HTTP to 0.
520// Doing so reduces the code size.
521//
522// This code is experimental and subject to change.
523#define wxUSE_URL_NATIVE 0
524
ca5c6ac3
VZ
525// Support for wxVariant class used in several places throughout the library,
526// notably in wxDataViewCtrl API.
527//
528// Default is 1.
529//
530// Recommended setting: 1 unless you want to reduce the library size as much as
531// possible in which case setting this to 0 can gain up to 100KB.
532#define wxUSE_VARIANT 1
533
ff3a660b
VZ
534// Support for regular expression matching via wxRegEx class: enable this to
535// use POSIX regular expressions in your code. You need to compile regex
536// library from src/regex to use it under Windows.
537//
538// Default is 0
539//
540// Recommended setting: 1 if your compiler supports it, if it doesn't please
541// contribute us a makefile for src/regex for it
542#define wxUSE_REGEX 1
543
544// wxSystemOptions class
545#define wxUSE_SYSTEM_OPTIONS 1
546
547// wxSound class
548#define wxUSE_SOUND 1
549
550// Use wxMediaCtrl
551//
552// Default is 1.
553//
912c3932 554// Recommended setting: 1
ff3a660b
VZ
555#define wxUSE_MEDIACTRL 1
556
fcfc65d3
RN
557// Use GStreamer for Unix (req a lot of dependancies)
558//
559// Default is 0
560//
561// Recommended setting: 1 (wxMediaCtrl won't work by default without it)
562#define wxUSE_GSTREAMER 0
ff3a660b
VZ
563
564// Use wxWidget's XRC XML-based resource system. Recommended.
565//
566// Default is 1
567//
568// Recommended setting: 1 (requires wxUSE_XML)
569#define wxUSE_XRC 1
570
571// XML parsing classes. Note that their API will change in the future, so
572// using wxXmlDocument and wxXmlNode in your app is not recommended.
573//
c969b007 574// Default is the same as wxUSE_XRC, i.e. 1 by default.
ff3a660b
VZ
575//
576// Recommended setting: 1 (required by XRC)
c969b007 577#define wxUSE_XML wxUSE_XRC
ff3a660b 578
5e4903f5
JS
579// Use wxWidget's AUI docking system
580//
581// Default is 1
582//
583// Recommended setting: 1
584#define wxUSE_AUI 1
585
29825f5f
PC
586// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla.
587//
588// Default is 1
589//
590// Recommended setting: 1
591#define wxUSE_STC 1
592
f43426c1
RD
593
594// Enable the new wxGraphicsPath and wxGraphicsContext classes for an advanced
595// 2D drawing API. (Still somewhat experimental)
596//
e88f6524
RD
597// Please note that on Windows you will need to link with gdiplus.lib (use
598// USE_GDIPLUS=1 for makefile builds) and distribute gdiplus.dll with your
599// application if you want it to be runnable on pre-XP systems.
600//
f43426c1
RD
601// Default is 0
602//
603// Recommended setting: 1
e88f6524 604#ifndef wxUSE_GRAPHICS_CONTEXT
f43426c1 605#define wxUSE_GRAPHICS_CONTEXT 0
e88f6524 606#endif
f43426c1 607
ff3a660b
VZ
608// ----------------------------------------------------------------------------
609// Individual GUI controls
610// ----------------------------------------------------------------------------
611
612// You must set wxUSE_CONTROLS to 1 if you are using any controls at all
613// (without it, wxControl class is not compiled)
614//
615// Default is 1
616//
617// Recommended setting: 1 (don't change except for very special programs)
618#define wxUSE_CONTROLS 1
619
620// wxPopupWindow class is a top level transient window. It is currently used
621// to implement wxTipWindow
622//
623// Default is 1
624//
625// Recommended setting: 1 (may be set to 0 if you don't wxUSE_TIPWINDOW)
626#define wxUSE_POPUPWIN 1
627
628// wxTipWindow allows to implement the custom tooltips, it is used by the
629// context help classes. Requires wxUSE_POPUPWIN.
630//
631// Default is 1
632//
633// Recommended setting: 1 (may be set to 0)
634#define wxUSE_TIPWINDOW 1
635
636// Each of the settings below corresponds to one wxWidgets control. They are
637// all switched on by default but may be disabled if you are sure that your
638// program (including any standard dialogs it can show!) doesn't need them and
639// if you desperately want to save some space. If you use any of these you must
640// set wxUSE_CONTROLS as well.
641//
642// Default is 1
643//
644// Recommended setting: 1
72045d57 645#define wxUSE_ANIMATIONCTRL 1 // wxAnimationCtrl
17e91437
VZ
646#define wxUSE_BUTTON 1 // wxButton
647#define wxUSE_BMPBUTTON 1 // wxBitmapButton
648#define wxUSE_CALENDARCTRL 1 // wxCalendarCtrl
649#define wxUSE_CHECKBOX 1 // wxCheckBox
650#define wxUSE_CHECKLISTBOX 1 // wxCheckListBox (requires wxUSE_OWNER_DRAWN)
651#define wxUSE_CHOICE 1 // wxChoice
912c3932 652#define wxUSE_COLLPANE 1 // wxCollapsiblePane
ec376c8f 653#define wxUSE_COLOURPICKERCTRL 1 // wxColourPickerCtrl
17e91437
VZ
654#define wxUSE_COMBOBOX 1 // wxComboBox
655#define wxUSE_DATAVIEWCTRL 1 // wxDataViewCtrl
656#define wxUSE_DATEPICKCTRL 1 // wxDatePickerCtrl
ec376c8f 657#define wxUSE_DIRPICKERCTRL 1 // wxDirPickerCtrl
56eeb973 658#define wxUSE_EDITABLELISTBOX 1 // wxEditableListBox
ec376c8f
VZ
659#define wxUSE_FILEPICKERCTRL 1 // wxFilePickerCtrl
660#define wxUSE_FONTPICKERCTRL 1 // wxFontPickerCtrl
17e91437
VZ
661#define wxUSE_GAUGE 1 // wxGauge
662#define wxUSE_HYPERLINKCTRL 1 // wxHyperlinkCtrl
663#define wxUSE_LISTBOX 1 // wxListBox
664#define wxUSE_LISTCTRL 1 // wxListCtrl
665#define wxUSE_RADIOBOX 1 // wxRadioBox
666#define wxUSE_RADIOBTN 1 // wxRadioButton
667#define wxUSE_SCROLLBAR 1 // wxScrollBar
3f7f284d 668#define wxUSE_SEARCHCTRL 1 // wxSearchCtrl
17e91437
VZ
669#define wxUSE_SLIDER 1 // wxSlider
670#define wxUSE_SPINBTN 1 // wxSpinButton
671#define wxUSE_SPINCTRL 1 // wxSpinCtrl
672#define wxUSE_STATBOX 1 // wxStaticBox
673#define wxUSE_STATLINE 1 // wxStaticLine
674#define wxUSE_STATTEXT 1 // wxStaticText
675#define wxUSE_STATBMP 1 // wxStaticBitmap
676#define wxUSE_TEXTCTRL 1 // wxTextCtrl
677#define wxUSE_TOGGLEBTN 1 // requires wxButton
678#define wxUSE_TREECTRL 1 // wxTreeCtrl
ff3a660b
VZ
679
680// Use a status bar class? Depending on the value of wxUSE_NATIVE_STATUSBAR
681// below either wxStatusBar95 or a generic wxStatusBar will be used.
682//
683// Default is 1
684//
685// Recommended setting: 1
686#define wxUSE_STATUSBAR 1
687
688// Two status bar implementations are available under Win32: the generic one
689// or the wrapper around native control. For native look and feel the native
690// version should be used.
691//
c67b4daf 692// Default is 1 for the platforms where native status bar is supported.
ff3a660b
VZ
693//
694// Recommended setting: 1 (there is no advantage in using the generic one)
695#define wxUSE_NATIVE_STATUSBAR 1
696
697// wxToolBar related settings: if wxUSE_TOOLBAR is 0, don't compile any toolbar
698// classes at all. Otherwise, use the native toolbar class unless
699// wxUSE_TOOLBAR_NATIVE is 0.
700//
701// Default is 1 for all settings.
702//
703// Recommended setting: 1 for wxUSE_TOOLBAR and wxUSE_TOOLBAR_NATIVE.
704#define wxUSE_TOOLBAR 1
705#define wxUSE_TOOLBAR_NATIVE 1
706
707// wxNotebook is a control with several "tabs" located on one of its sides. It
708// may be used to logically organise the data presented to the user instead of
709// putting everything in one huge dialog. It replaces wxTabControl and related
710// classes of wxWin 1.6x.
711//
712// Default is 1.
713//
714// Recommended setting: 1
715#define wxUSE_NOTEBOOK 1
716
717// wxListbook control is similar to wxNotebook but uses wxListCtrl instead of
718// the tabs
719//
720// Default is 1.
721//
722// Recommended setting: 1
723#define wxUSE_LISTBOOK 1
724
725// wxChoicebook control is similar to wxNotebook but uses wxChoice instead of
726// the tabs
727//
728// Default is 1.
729//
730// Recommended setting: 1
731#define wxUSE_CHOICEBOOK 1
732
eca15c0d
VZ
733// wxTreebook control is similar to wxNotebook but uses wxTreeCtrl instead of
734// the tabs
735//
736// Default is 1.
737//
738// Recommended setting: 1
739#define wxUSE_TREEBOOK 1
740
f4edf138
JS
741// wxToolbook control is similar to wxNotebook but uses wxToolBar instead of
742// tabs
743//
744// Default is 1.
745//
746// Recommended setting: 1
747#define wxUSE_TOOLBOOK 1
748
ff3a660b
VZ
749// wxTabDialog is a generic version of wxNotebook but it is incompatible with
750// the new class. It shouldn't be used in new code.
751//
752// Default is 0.
753//
754// Recommended setting: 0 (use wxNotebook)
755#define wxUSE_TAB_DIALOG 0
756
4f167b46
VZ
757// wxTaskBarIcon is a small notification icon shown in the system toolbar or
758// dock.
759//
760// Default is 1.
761//
762// Recommended setting: 1 (but can be set to 0 if you don't need it)
763#define wxUSE_TASKBARICON 1
764
ff3a660b
VZ
765// wxGrid class
766//
c67b4daf
VZ
767// Default is 1, set to 0 to cut down compilation time and binaries size if you
768// don't use it.
ff3a660b
VZ
769//
770// Recommended setting: 1
771//
772#define wxUSE_GRID 1
773
c67b4daf
VZ
774// wxMiniFrame class: a frame with narrow title bar
775//
776// Default is 1.
777//
778// Recommended setting: 1 (it doesn't cost almost anything)
779#define wxUSE_MINIFRAME 1
780
a57d600f 781// wxComboCtrl and related classes: combobox with custom popup window and
28cbbe69
VZ
782// not necessarily a listbox.
783//
784// Default is 1.
785//
786// Recommended setting: 1 but can be safely set to 0 except for wxUniv where it
787// it used by wxComboBox
a57d600f 788#define wxUSE_COMBOCTRL 1
28cbbe69
VZ
789
790// wxOwnerDrawnComboBox is a custom combobox allowing to paint the combobox
791// items.
792//
793// Default is 1.
794//
95a46303
RR
795// Recommended setting: 1 but can be safely set to 0, except where it is
796// needed as a base class for generic wxBitmapComboBox.
a57d600f 797#define wxUSE_ODCOMBOBOX 1
28cbbe69 798
95a46303
RR
799// wxBitmapComboBox is a combobox that can have images in front of text items.
800//
801// Default is 1.
802//
803// Recommended setting: 1 but can be safely set to 0
804#define wxUSE_BITMAPCOMBOBOX 1
805
ff3a660b
VZ
806// ----------------------------------------------------------------------------
807// Miscellaneous GUI stuff
808// ----------------------------------------------------------------------------
809
810// wxAcceleratorTable/Entry classes and support for them in wxMenu(Bar)
811#define wxUSE_ACCEL 1
812
813// Hotkey support (currently Windows only)
814#define wxUSE_HOTKEY 1
815
816// Use wxCaret: a class implementing a "cursor" in a text control (called caret
817// under Windows).
818//
819// Default is 1.
820//
821// Recommended setting: 1 (can be safely set to 0, not used by the library)
822#define wxUSE_CARET 1
823
824// Use wxDisplay class: it allows enumerating all displays on a system and
9e759756
VZ
825// their geometries as well as finding the display on which the given point or
826// window lies.
ff3a660b 827//
9e759756 828// Default is 1.
ff3a660b
VZ
829//
830// Recommended setting: 1 if you need it, can be safely set to 0 otherwise
9e759756 831#define wxUSE_DISPLAY 1
ff3a660b
VZ
832
833// Miscellaneous geometry code: needed for Canvas library
834#define wxUSE_GEOMETRY 1
835
836// Use wxImageList. This class is needed by wxNotebook, wxTreeCtrl and
837// wxListCtrl.
838//
839// Default is 1.
840//
841// Recommended setting: 1 (set it to 0 if you don't use any of the controls
842// enumerated above, then this class is mostly useless too)
843#define wxUSE_IMAGLIST 1
844
845// Use wxMenu, wxMenuBar, wxMenuItem.
846//
847// Default is 1.
848//
849// Recommended setting: 1 (can't be disabled under MSW)
850#define wxUSE_MENUS 1
851
852// Use wxSashWindow class.
853//
854// Default is 1.
855//
856// Recommended setting: 1
857#define wxUSE_SASH 1
858
859// Use wxSplitterWindow class.
860//
861// Default is 1.
862//
863// Recommended setting: 1
864#define wxUSE_SPLITTER 1
865
866// Use wxToolTip and wxWindow::Set/GetToolTip() methods.
867//
868// Default is 1.
869//
870// Recommended setting: 1
871#define wxUSE_TOOLTIPS 1
872
873// wxValidator class and related methods
874#define wxUSE_VALIDATORS 1
875
ff3a660b
VZ
876// ----------------------------------------------------------------------------
877// common dialogs
878// ----------------------------------------------------------------------------
879
880// On rare occasions (e.g. using DJGPP) may want to omit common dialogs (e.g.
881// file selector, printer dialog). Switching this off also switches off the
882// printing architecture and interactive wxPrinterDC.
883//
884// Default is 1
885//
886// Recommended setting: 1 (unless it really doesn't work)
887#define wxUSE_COMMON_DIALOGS 1
888
889// wxBusyInfo displays window with message when app is busy. Works in same way
890// as wxBusyCursor
891#define wxUSE_BUSYINFO 1
892
893// Use single/multiple choice dialogs.
894//
895// Default is 1
896//
897// Recommended setting: 1 (used in the library itself)
898#define wxUSE_CHOICEDLG 1
899
900// Use colour picker dialog
901//
902// Default is 1
903//
904// Recommended setting: 1
905#define wxUSE_COLOURDLG 1
906
907// wxDirDlg class for getting a directory name from user
908#define wxUSE_DIRDLG 1
909
910// TODO: setting to choose the generic or native one
911
912// Use file open/save dialogs.
913//
914// Default is 1
915//
916// Recommended setting: 1 (used in many places in the library itself)
917#define wxUSE_FILEDLG 1
918
919// Use find/replace dialogs.
920//
921// Default is 1
922//
923// Recommended setting: 1 (but may be safely set to 0)
924#define wxUSE_FINDREPLDLG 1
925
926// Use font picker dialog
927//
928// Default is 1
929//
930// Recommended setting: 1 (used in the library itself)
931#define wxUSE_FONTDLG 1
932
933// Use wxMessageDialog and wxMessageBox.
934//
935// Default is 1
936//
937// Recommended setting: 1 (used in the library itself)
938#define wxUSE_MSGDLG 1
939
940// progress dialog class for lengthy operations
941#define wxUSE_PROGRESSDLG 1
942
943// support for startup tips (wxShowTip &c)
944#define wxUSE_STARTUP_TIPS 1
945
946// text entry dialog and wxGetTextFromUser function
947#define wxUSE_TEXTDLG 1
948
949// number entry dialog
950#define wxUSE_NUMBERDLG 1
951
952// splash screen class
953#define wxUSE_SPLASH 1
954
955// wizards
956#define wxUSE_WIZARDDLG 1
957
9211cf3c
VZ
958// Compile in wxAboutBox() function showing the standard "About" dialog.
959//
960// Default is 1
961//
962// Recommended setting: 1 but can be set to 0 to save some space if you don't
963// use this function
964#define wxUSE_ABOUTDLG 1
965
ff3a660b
VZ
966// ----------------------------------------------------------------------------
967// Metafiles support
968// ----------------------------------------------------------------------------
969
970// Windows supports the graphics format known as metafile which is, though not
971// portable, is widely used under Windows and so is supported by wxWin (under
972// Windows only, of course). Win16 (Win3.1) used the so-called "Window
973// MetaFiles" or WMFs which were replaced with "Enhanced MetaFiles" or EMFs in
974// Win32 (Win9x, NT, 2000). Both of these are supported in wxWin and, by
975// default, WMFs will be used under Win16 and EMFs under Win32. This may be
976// changed by setting wxUSE_WIN_METAFILES_ALWAYS to 1 and/or setting
977// wxUSE_ENH_METAFILE to 0. You may also set wxUSE_METAFILE to 0 to not compile
978// in any metafile related classes at all.
979//
980// Default is 1 for wxUSE_ENH_METAFILE and 0 for wxUSE_WIN_METAFILES_ALWAYS.
981//
982// Recommended setting: default or 0 for everything for portable programs.
983#define wxUSE_METAFILE 1
984#define wxUSE_ENH_METAFILE 1
985#define wxUSE_WIN_METAFILES_ALWAYS 0
986
987// ----------------------------------------------------------------------------
988// Big GUI components
989// ----------------------------------------------------------------------------
990
991// Set to 0 to disable MDI support.
992//
993// Requires wxUSE_NOTEBOOK under platforms other than MSW.
994//
995// Default is 1.
996//
997// Recommended setting: 1, can be safely set to 0.
998#define wxUSE_MDI 1
999
1000// Set to 0 to disable document/view architecture
1001#define wxUSE_DOC_VIEW_ARCHITECTURE 1
1002
1003// Set to 0 to disable MDI document/view architecture
1004//
1005// Requires wxUSE_MDI && wxUSE_DOC_VIEW_ARCHITECTURE
1006#define wxUSE_MDI_ARCHITECTURE 1
1007
1008// Set to 0 to disable print/preview architecture code
1009#define wxUSE_PRINTING_ARCHITECTURE 1
1010
1011// wxHTML sublibrary allows to display HTML in wxWindow programs and much,
1012// much more.
1013//
1014// Default is 1.
1015//
1016// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a
1017// smaller library.
1018#define wxUSE_HTML 1
1019
1020// Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL
1021// headers and libraries to be able to compile the library with wxUSE_GLCANVAS
1022// set to 1. Note that for some compilers (notably Microsoft Visual C++) you
1023// will need to manually add opengl32.lib and glu32.lib to the list of
1024// libraries linked with your program if you use OpenGL.
1025//
1026// Default is 0.
1027//
1028// Recommended setting: 1 if you intend to use OpenGL, 0 otherwise
1029#define wxUSE_GLCANVAS 0
1030
5d7836c4
JS
1031// wxRichTextCtrl allows editing of styled text.
1032//
1033// Default is 1.
1034//
1035// Recommended setting: 1, set to 0 if you want compile a
1036// smaller library.
1037#define wxUSE_RICHTEXT 1
1038
ff3a660b
VZ
1039// ----------------------------------------------------------------------------
1040// Data transfer
1041// ----------------------------------------------------------------------------
1042
1043// Use wxClipboard class for clipboard copy/paste.
1044//
1045// Default is 1.
1046//
1047// Recommended setting: 1
1048#define wxUSE_CLIPBOARD 1
1049
1050// Use wxDataObject and related classes. Needed for clipboard and OLE drag and
1051// drop
1052//
1053// Default is 1.
1054//
1055// Recommended setting: 1
1056#define wxUSE_DATAOBJ 1
1057
1058// Use wxDropTarget and wxDropSource classes for drag and drop (this is
1059// different from "built in" drag and drop in wxTreeCtrl which is always
1060// available). Requires wxUSE_DATAOBJ.
1061//
1062// Default is 1.
1063//
1064// Recommended setting: 1
1065#define wxUSE_DRAG_AND_DROP 1
1066
1067// Use wxAccessible for enhanced and customisable accessibility.
1068// Depends on wxUSE_OLE.
1069//
1070// Default is 0.
1071//
1072// Recommended setting (at present): 0
1073#define wxUSE_ACCESSIBILITY 0
1074
1075// ----------------------------------------------------------------------------
1076// miscellaneous settings
1077// ----------------------------------------------------------------------------
1078
1079// wxSingleInstanceChecker class allows to verify at startup if another program
1080// instance is running (it is only available under Win32)
1081//
1082// Default is 1
1083//
1084// Recommended setting: 1 (the class is tiny, disabling it won't save much
1085// space)
1086#define wxUSE_SNGLINST_CHECKER 1
1087
1088#define wxUSE_DRAGIMAGE 1
1089
1090#define wxUSE_IPC 1
1091 // 0 for no interprocess comms
1092#define wxUSE_HELP 1
1093 // 0 for no help facility
ff3a660b 1094
f05b5b77
VZ
1095// Should we use MS HTML help for wxHelpController? If disabled, neither
1096// wxCHMHelpController nor wxBestHelpController are available.
1097//
a1584ea1 1098// Default is 1 under MSW, 0 is always used for the other platforms.
f05b5b77
VZ
1099//
1100// Recommended setting: 1, only set to 0 if you have trouble compiling
1101// wxCHMHelpController (could be a problem with really ancient compilers)
1102#define wxUSE_MS_HTML_HELP 1
1103
1104
ff3a660b
VZ
1105// Use wxHTML-based help controller?
1106#define wxUSE_WXHTML_HELP 1
1107
ff3a660b
VZ
1108#define wxUSE_CONSTRAINTS 1
1109 // 0 for no window layout constraint system
1110
1111#define wxUSE_SPLINES 1
1112 // 0 for no splines
1113
1114#define wxUSE_MOUSEWHEEL 1
1115 // Include mouse wheel support
1116
1117// ----------------------------------------------------------------------------
b0fc907f 1118// wxDC classes for various output formats
ff3a660b
VZ
1119// ----------------------------------------------------------------------------
1120
1121// Set to 1 for PostScript device context.
1122#define wxUSE_POSTSCRIPT 0
1123
1124// Set to 1 to use font metric files in GetTextExtent
1125#define wxUSE_AFM_FOR_POSTSCRIPT 1
1126
b0fc907f
VZ
1127// Set to 1 to compile in support for wxSVGFileDC, a wxDC subclass which allows
1128// to create fiels in SVG (Scalable Vector Graphics) format.
1129#define wxUSE_SVG 1
1130
ff3a660b
VZ
1131// ----------------------------------------------------------------------------
1132// database classes
1133// ----------------------------------------------------------------------------
1134
1135// Define 1 to use ODBC classes
1136#define wxUSE_ODBC 0
1137
1138// For backward compatibility reasons, this parameter now only controls the
1139// default scrolling method used by cursors. This default behavior can be
1140// overriden by setting the second param of wxDB::wxDbGetConnection() or
1141// wxDb() constructor to indicate whether the connection (and any wxDbTable()s
1142// that use the connection) should support forward only scrolling of cursors,
1143// or both forward and backward support for backward scrolling cursors is
1144// dependent on the data source as well as the ODBC driver being used.
1145#define wxODBC_FWD_ONLY_CURSORS 1
1146
1147// Default is 0. Set to 1 to use the deprecated classes, enum types, function,
3103e8a9 1148// member variables. With a setting of 1, full backward compatibility with the
ff3a660b
VZ
1149// 2.0.x release is possible. It is STRONGLY recommended that this be set to 0,
1150// as future development will be done only on the non-deprecated
1151// functions/classes/member variables/etc.
1152#define wxODBC_BACKWARD_COMPATABILITY 0
1153
1154// ----------------------------------------------------------------------------
1155// other compiler (mis)features
1156// ----------------------------------------------------------------------------
1157
1158// Set this to 0 if your compiler can't cope with omission of prototype
1159// parameters.
1160//
1161// Default is 1.
1162//
1163// Recommended setting: 1 (should never need to set this to 0)
1164#define REMOVE_UNUSED_ARG 1
1165
1166// VC++ 4.2 and above allows <iostream> and <iostream.h> but you can't mix
1167// them. Set to 1 for <iostream.h>, 0 for <iostream>. Note that VC++ 7.1
1168// and later doesn't support wxUSE_IOSTREAMH == 1 and so <iostream> will be
1169// used anyhow.
1170//
1171// Default is 1.
1172//
1173// Recommended setting: whatever your compiler likes more
1174#define wxUSE_IOSTREAMH 1
1175
1176// ----------------------------------------------------------------------------
1177// image format support
1178// ----------------------------------------------------------------------------
1179
1180// wxImage supports many different image formats which can be configured at
1181// compile-time. BMP is always supported, others are optional and can be safely
1182// disabled if you don't plan to use images in such format sometimes saving
1183// substantial amount of code in the final library.
1184//
1185// Some formats require an extra library which is included in wxWin sources
1186// which is mentioned if it is the case.
1187
1188// Set to 1 for wxImage support (recommended).
1189#define wxUSE_IMAGE 1
1190
1191// Set to 1 for PNG format support (requires libpng). Also requires wxUSE_ZLIB.
1192#define wxUSE_LIBPNG 1
1193
1194// Set to 1 for JPEG format support (requires libjpeg)
1195#define wxUSE_LIBJPEG 1
1196
1197// Set to 1 for TIFF format support (requires libtiff)
1198#define wxUSE_LIBTIFF 1
1199
3af706cc
VZ
1200// Set to 1 for TGA format support (loading only)
1201#define wxUSE_TGA 1
1202
ff3a660b
VZ
1203// Set to 1 for GIF format support
1204#define wxUSE_GIF 1
1205
1206// Set to 1 for PNM format support
1207#define wxUSE_PNM 1
1208
1209// Set to 1 for PCX format support
1210#define wxUSE_PCX 1
1211
1212// Set to 1 for IFF format support (Amiga format)
1213#define wxUSE_IFF 0
1214
1215// Set to 1 for XPM format support
1216#define wxUSE_XPM 1
1217
1218// Set to 1 for MS Icons and Cursors format support
1219#define wxUSE_ICO_CUR 1
1220
1221// Set to 1 to compile in wxPalette class
1222#define wxUSE_PALETTE 1
1223
4353a8df
VZ
1224// ----------------------------------------------------------------------------
1225// wxUniversal-only options
1226// ----------------------------------------------------------------------------
1227
1228// Set to 1 to enable compilation of all themes, this is the default
1229#define wxUSE_ALL_THEMES 1
1230
1231// Set to 1 to enable the compilation of individual theme if wxUSE_ALL_THEMES
1232// is unset, if it is set these options are not used; notice that metal theme
1233// uses Win32 one
1234#define wxUSE_THEME_GTK 0
1235#define wxUSE_THEME_METAL 0
1236#define wxUSE_THEME_MONO 0
1237#define wxUSE_THEME_WIN32 0
1238
1239