document that dragging in wxTreeCtrl needs to be explicitely allowed (fixes #3915)

[wxWidgets.git] / interface / wx / log.h

diff --git a/interface/wx/log.h b/interface/wx/log.h
index 9c4b772c650ceaec4cc5f5d61898909d4378f0fc..97f022309825ea65c309f7446843db006e13ad8a 100644 (file)
--- a/interface/wx/log.h
+++ b/interface/wx/log.h
@@ -26,9 +26,9 @@ public:
     /**
         Creates the log frame window and starts collecting the messages in it.
 
-        @param parent
+        @param pParent
             The parent window for the log frame, may be @NULL
-        @param title
+        @param szTitle
             The title for the log frame
         @param show
             @true to show the frame initially (default), otherwise
@@ -396,7 +396,7 @@ public:
         Constructs a log target which sends all the log messages to the given
         output stream. If it is @NULL, the messages are sent to @c cerr.
     */
-    wxLogStream(std::ostream ostr = NULL);
+    wxLogStream(std::ostream *ostr = NULL);
 };
 
 
@@ -405,8 +405,10 @@ public:
     @class wxLogStderr
 
     This class can be used to redirect the log messages to a C file stream (not to
-    be confused with C++ streams). It is the default log target for the non-GUI
-    wxWidgets applications which send all the output to @c stderr.
+    be confused with C++ streams).
+
+    It is the default log target for the non-GUI wxWidgets applications which
+    send all the output to @c stderr.
 
     @library{wxbase}
     @category{logging}
@@ -527,6 +529,9 @@ public:
     Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
     you may not even know about its existence.
 
+    @note For console-mode applications, the default target is wxLogStderr, so
+          that all @e wxLogXXX() functions print on @c stderr when @c wxUSE_GUI = 0.
+
 
     @section log_derivingyours Deriving your own log target
 
@@ -609,7 +614,8 @@ public:
     standard @e strftime() function. For example, the default format is
     "[%d/%b/%y %H:%M:%S] " which gives something like "[17/Sep/98 22:10:16] "
     (without quotes) for the current date. Setting an empty string as the time
-    format disables timestamping of the messages completely.
+    format or calling the shortcut wxLog::DisableTimestamp(), disables timestamping
+    of the messages completely.
 
     See also
     @li AddTraceMask()
@@ -626,7 +632,8 @@ public:
     @li SetRepetitionCounting()
     @li GetRepetitionCounting()
 
-    @note Timestamping is disabled for Visual C++ users in debug builds by
+    @note
+    Timestamping is disabled for Visual C++ users in debug builds by
     default because otherwise it would be impossible to directly go to the line
     from which the log message was generated by simply clicking in the debugger
     window on the corresponding error message. If you wish to enable it, please
@@ -676,33 +683,6 @@ public:
     */
     static void ClearTraceMasks();
 
-    /**
-        Disables time stamping of the log messages.
-
-        @since 2.9.0
-    */
-    static void SetTimestamp(const wxString& format);
-
-    /**
-        Called to process the message of the specified severity. @a msg is the text
-        of the message as specified in the call of @e wxLogXXX() function which
-        generated it and @a timestamp is the moment when the message was generated.
-
-        The base class version prepends the timestamp to the message, adds a prefix
-        corresponding to the log level and then calls
-        DoLogString() with the resulting string.
-    */
-    virtual void DoLog(wxLogLevel level, const wxString& msg, time_t timestamp);
-
-    /**
-        Called to log the specified string. The timestamp is already included in the
-        string but still passed to this function.
-
-        A simple implementation may just send the string to @c stdout or, better,
-        @c stderr.
-    */
-    virtual void DoLogString(const wxString& msg, time_t timestamp);
-
     /**
         Instructs wxLog to not create new log targets on the fly if there is none
         currently. (Almost) for internal use only: it is supposed to be called by the
@@ -820,6 +800,13 @@ public:
     */
     static void SetTimestamp(const wxString& format);
 
+    /**
+        Disables time stamping of the log messages.
+
+        @since 2.9.0
+    */
+    static void DisableTimestamp();
+
     /**
         Sets the trace mask, see @ref log_derivingyours section for details.
     */
@@ -846,6 +833,28 @@ public:
         @see Resume(), wxLogNull
     */
     static void Suspend();
+
+protected:
+
+    /**
+        Called to process the message of the specified severity. @a msg is the text
+        of the message as specified in the call of @e wxLogXXX() function which
+        generated it and @a timestamp is the moment when the message was generated.
+
+        The base class version prepends the timestamp to the message, adds a prefix
+        corresponding to the log level and then calls
+        DoLogString() with the resulting string.
+    */
+    virtual void DoLog(wxLogLevel level, const wxString& msg, time_t timestamp);
+
+    /**
+        Called to log the specified string. The timestamp is already included in the
+        string but still passed to this function.
+
+        A simple implementation may just send the string to @c stdout or, better,
+        @c stderr.
+    */
+    virtual void DoLogString(const wxString& msg, time_t timestamp);
 };