Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

doxyoof.h File Reference


Detailed Description

Documentation file for Doxygen.

define macros here to force doxygen to include in generated docs as of 1.2.9.1 Doxygen doesn't handle #ifndef when parsing and gives warnings for \def directives for #defines that are not defined in the source. Most of the following are defined conditionally based on external settings or are defined by the programmer to control how OOFILE is built.

Warning:
you should never include this file in your source


Defines

#define OOFILE_CREATE_DLL
 OOFILE database & general classes will be linked in a DLL.

#define OOFREP_CREATE_DLL
 Report-writer classes will be linked in a DLL.

#define OOFGRAPH_CREATE_DLL
 Graph classes will be linked in a DLL.

#define OOFMFC_STATIC
 MFC classes will NOT be linked in a DLL.

#define OOF_EXCEPTIONS_AVAILABLE
 Indicates compiler supports exceptions.

#define OOF_USE_ANSI_STREAMS
 Will compile using older streams by default or standard iostreams.

#define OOF_HAS_ANSI_STREAMS
#define OOF_SUPPRESS_EXCEPTIONS
 Option to prevent using exceptions in OOFILE regardless of compiler or its settings.

#define OOF_USING_EXCEPTIONS
#define OOF_NO_STDLIB
 Define to suppress use of standard library strings and streams.

#define OOF_READ_XML
 Define to build the core database with ability to parse XML schema and import database from XML.

#define OOF_RTTI_ENABLED
 Indicates compiler is building with RTTI.

#define OOF_HAS_BOOL
 Indicates compiler implemements true c++ 'bool' data type.

#define OOF_DEBUG_LOG_NAME
 Define this as a filename to build a logging version of OOFILE .

#define OOF_PP17_TEXTEDIT
 Support LEditField and LTextEdit obsolete classes.

#define OOF_PP18_TEXTEDIT
 Support LEditText and LTextEditView classes.

#define OOF_MacStyleEnums
#define OOF_PRECARBON_PP_PRINTING
#define OOF_REP_NO_GUI
 Define to build the report writer for server use, no preview or print.

#define OOF_DEBUG_FORCE_POOL_CHECK
 Define that's expanded in hundreds of places through OOFILE code to check the pool.

#define OOF_MEM_DEBUG_LAST_INCLUDE
 Define as a file name to have a file included that is used for memory debugging.

#define OOF_MEM_DEBUG_FORCE_POOL_CHECK
#define OOF_MEM_DEBUG_REPORT_LEAKS
 Report all accumulated leaks (defined initially for DebugNew).

#define OOF_MEM_DEBUG_FORGET_LEAKS
 Wipe out any accumulated leaks (defined initially for DebugNew).

#define OOF_INVARIANT_DUMP_NAME
 Define this as a valid filename to cause detailed logging.

#define EXPATPP_EXPORT
#define OOF_REPEDIT_LOG_FILENAME
 Define to set filename for logging user interactions with report preview window.

#define OOF_RW_READ_REPORTS
 Define to build the report writer with ability to parse XML layouts.

#define OOF_RW_NOEDIT
 Define to be able to build a program using OOFILE reporting without having to link in all the OOFILE GUI classes.

#define OOF_RW_PREVIEW_HAS_BW_CHECKBOX
 Define to change the toolbar appearance in the preview window to have a checkbox instead of button for toggling Black & White printing.

#define OOF_RW_PREVIEW_NOZOOM
 Define to suppress zooming as a feature in the report preview, including the presence of a zoom icon on the toolbar.

#define _MSDOS
 This build is on pure MSDOS, not Windows.

#define _Macintosh
 This build is on Macintosh.

#define _Windows
 This build is on Windows.

#define _Unix
 This build is on pure Unix, possibly Darwin but not OS/X.

#define _Macintosh_Carbon
 This build is on Macintosh Classic with Carbon lib or OS/X.

#define _Macintosh_OSX
 This build is on Macintosh OS/X.

#define _Windows_CE
 This build is on pure Windows CE.


Define Documentation

#define EXPATPP_EXPORT
 

#define OOF_DEBUG_FORCE_POOL_CHECK
 

Define that's expanded in hundreds of places through OOFILE code to check the pool.

If defined, this should invoke an assert, eg: from oofSmartheap.h #define OOF_DEBUG_FORCE_POOL_CHECK assert(MemPoolCheck(MemDefaultPool));

#define OOF_HAS_ANSI_STREAMS
 

#define OOF_INVARIANT_DUMP_NAME
 

Define this as a valid filename to cause detailed logging.

Causes OOF_simpleRecordBackend::Invariant to call OOF_simpleRecordBackend::InvariantDump. Which results in the dump being called on entry to and exit from most OOFILE backend methods that affect the database.

#define OOF_MacStyleEnums
 

#define OOF_MEM_DEBUG_FORCE_POOL_CHECK
 

#define OOF_MEM_DEBUG_FORGET_LEAKS
 

Wipe out any accumulated leaks (defined initially for DebugNew).

See also:
oofDebugNew.h

#define OOF_MEM_DEBUG_LAST_INCLUDE
 

Define as a file name to have a file included that is used for memory debugging.

We rely on the programmer to make sure this include is the last one.

See also:
oofDebugNew.h oofSmartheap.h

#define OOF_MEM_DEBUG_REPORT_LEAKS
 

Report all accumulated leaks (defined initially for DebugNew).

Mechanism for reporting will vary depending on debug environment.

See also:
oofDebugNew.h

#define OOF_PRECARBON_PP_PRINTING
 

#define OOF_USING_EXCEPTIONS
 


Generated on Thu Jan 1 21:22:00 2004 for OOFILE by doxygen 1.3.5