From 4a6665c6eb3186919693aa8d1210fd00c55e2835 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Fri, 5 Dec 2008 21:06:09 +0000 Subject: [PATCH] document wxLogLevel, wxTraceMask antypes and wxLogLevelValues enum git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57129 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/log.h | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/interface/wx/log.h b/interface/wx/log.h index 0c0dd86c9c..fa6d099120 100644 --- a/interface/wx/log.h +++ b/interface/wx/log.h @@ -6,6 +6,41 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// + +/** + Different standard log levels (you may also define your own) used with + wxLog::OnLog() by standard wxLog functions wxLogError(), wxLogWarning(), + etc... +*/ +enum wxLogLevelValues +{ + wxLOG_FatalError, //!< program can't continue, abort immediately + wxLOG_Error, //!< a serious error, user must be informed about it + wxLOG_Warning, //!< user is normally informed about it but may be ignored + wxLOG_Message, //!< normal message (i.e. normal output of a non GUI app) + wxLOG_Status, //!< informational: might go to the status line of GUI app + wxLOG_Info, //!< informational message (a.k.a. 'Verbose') + wxLOG_Debug, //!< never shown to the user, disabled in release mode + wxLOG_Trace, //!< trace messages are also only enabled in debug mode + wxLOG_Progress, //!< used for progress indicator (not yet) + wxLOG_User = 100, //!< user defined levels start here + wxLOG_Max = 10000 +}; + +/** + The type used for trace masks. +*/ +typedef unsigned long wxTraceMask; + +/** + The type used to specify a log level. + + Default values of ::wxLogLevel used by wxWidgets are contained in the + ::wxLogLevelValues enumeration. +*/ +typedef unsigned long wxLogLevel; + + /** @class wxLogWindow @@ -785,8 +820,8 @@ public: static wxLog* SetActiveTarget(wxLog* logtarget); /** - Specifies that log messages with level logLevel should be ignored - and not sent to the active log target. + Specifies that log messages with level greater (numerically) than + @a logLevel should be ignored and not sent to the active log target. */ static void SetLogLevel(wxLogLevel logLevel); -- 2.45.2