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