wxLog

Methods

• DoLogText
  Called to log the specified string.
• DoLogTextAtLevel
  Called to log the specified string at given level.
• Flush
  Some of wxLog implementations, most notably the standard wxLogGui class, buffer the messages (for example, to avoid showing the user a zillion of modal message boxes one after another -- which would be really annoying).

Static Methods

• AddTraceMask
  Add the mask to the list of allowed masks for wxLogTrace().
• ClearTraceMasks
  Removes all trace masks previously set with AddTraceMask().
• DisableTimestamp
  Disables time stamping of the log messages.
• DontCreateOnDemand
  Instructs wxLog to not create new log targets on the fly if there is none currently (see GetActiveTarget()).
• EnableLogging
  Globally enable or disable logging.
• FlushActive
  Flushes the current log target if any, does nothing if there is none.
• GetActiveTarget
  Returns the pointer to the active log target (may be NULL).
• GetLogLevel
  Returns the current log level limit.
• GetRepetitionCounting
  Returns whether the repetition counting mode is enabled.
• GetTimestamp
  Returns the current timestamp format string.
• GetTraceMasks
  Returns the currently allowed list of string trace masks.
• GetVerbose
  Returns whether the verbose mode is currently active.
• IsAllowedTraceMask
  Returns true if the mask is one of allowed masks for wxLogTrace().
• IsEnabled
  Returns true if logging is enabled at all now.
• IsLevelEnabled
  Returns true if logging at this level is enabled for the current thread.
• RemoveTraceMask
  Remove the mask from the list of allowed masks for wxLogTrace().
• Resume
  Resumes logging previously suspended by a call to Suspend().
• SetActiveTarget
  Sets the specified log target as the active one.
• SetComponentLevel
  Sets the log level for the given component.
• SetLogLevel
  Specifies that log messages with level greater (numerically) than logLevel should be ignored and not sent to the active log target.
• SetRepetitionCounting
  Enables logging mode in which a log message is logged once, and in case exactly the same message successively repeats one or more times, only the number of repetitions is logged.
• SetThreadActiveTarget
  Sets a thread-specific log target.
• SetTimestamp
  Sets the timestamp format prepended by the default log targets to all messages.
• SetVerbose
  Activates or deactivates verbose mode in which the verbose messages are logged as the normal ones instead of being silently dropped.
• Suspend
  Suspends the logging until Resume() is called.

AddTraceMask

static AddTraceMask ( string $mask )

Add the mask to the list of allowed masks for wxLogTrace().

ClearTraceMasks

static ClearTraceMasks ( )

Removes all trace masks previously set with AddTraceMask().

DisableTimestamp

static DisableTimestamp ( )

Disables time stamping of the log messages.

DoLogText

DoLogText ( string $msg )

Called to log the specified string.

DoLogTextAtLevel

DoLogTextAtLevel ( integer $level, string $msg )

Called to log the specified string at given level.

DontCreateOnDemand

static DontCreateOnDemand ( )

Instructs wxLog to not create new log targets on the fly if there is none currently (see GetActiveTarget()).

EnableLogging

static bool EnableLogging ( bool $enable=true )

Globally enable or disable logging.

Flush

Flush ( )

Some of wxLog implementations, most notably the standard wxLogGui class, buffer the messages (for example, to avoid showing the user a zillion of modal message boxes one after another -- which would be really annoying).

FlushActive

static FlushActive ( )

Flushes the current log target if any, does nothing if there is none.

GetActiveTarget

static wxLog& GetActiveTarget ( )

Returns the pointer to the active log target (may be NULL).

GetLogLevel

static integer GetLogLevel ( )

Returns the current log level limit.

GetRepetitionCounting

static bool GetRepetitionCounting ( )

Returns whether the repetition counting mode is enabled.

GetTimestamp

static string GetTimestamp ( )

Returns the current timestamp format string.

GetTraceMasks

static array GetTraceMasks ( )

Returns the currently allowed list of string trace masks.

GetVerbose

static bool GetVerbose ( )

Returns whether the verbose mode is currently active.

IsAllowedTraceMask

static bool IsAllowedTraceMask ( string $mask )

Returns true if the mask is one of allowed masks for wxLogTrace().

IsEnabled

static bool IsEnabled ( )

Returns true if logging is enabled at all now.

IsLevelEnabled

static bool IsLevelEnabled ( integer $level, string $component )

Returns true if logging at this level is enabled for the current thread.

RemoveTraceMask

static RemoveTraceMask ( string $mask )

Remove the mask from the list of allowed masks for wxLogTrace().

Resume

static Resume ( )

Resumes logging previously suspended by a call to Suspend().

SetActiveTarget

static wxLog& SetActiveTarget ( wxLog &$logtarget )

Sets the specified log target as the active one.

SetComponentLevel

static SetComponentLevel ( string $component, integer $level )

Sets the log level for the given component.

SetLogLevel

static SetLogLevel ( integer $logLevel )

Specifies that log messages with level greater (numerically) than logLevel should be ignored and not sent to the active log target.

SetRepetitionCounting

static SetRepetitionCounting ( bool $repetCounting=true )

Enables logging mode in which a log message is logged once, and in case exactly the same message successively repeats one or more times, only the number of repetitions is logged.

SetThreadActiveTarget

static wxLog& SetThreadActiveTarget ( wxLog &$logger )

Sets a thread-specific log target.

SetTimestamp

static SetTimestamp ( string $format )

Sets the timestamp format prepended by the default log targets to all messages.

SetVerbose

static SetVerbose ( bool $verbose=true )

Activates or deactivates verbose mode in which the verbose messages are logged as the normal ones instead of being silently dropped.

Suspend

static Suspend ( )

Suspends the logging until Resume() is called.