Only show the default close button in wxInfoBar if there are no others.

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

diff --git a/interface/wx/debugrpt.h b/interface/wx/debugrpt.h
index 04e52b1d97cd71618c147887057fb0b54fda501c..0db0c4dd8fbe8ab3144f94e7b90aba0542875d21 100644 (file)
--- a/interface/wx/debugrpt.h
+++ b/interface/wx/debugrpt.h
@@ -44,7 +44,7 @@ public:
                  chose to cancel report generation or removed all files from
                  it.
     */
                  chose to cancel report generation or removed all files from
                  it.
     */

-    virtual bool Show(wxDebugReport& dbgrpt) const;
+    virtual bool Show(wxDebugReport& dbgrpt) const = 0;

 };
 
 
 };
 
 


@@ -67,11 +67,49 @@ public:
     */
     wxDebugReportCompress();
 
     */
     wxDebugReportCompress();
 

+    /**
+        Set the directory where the debug report should be generated.
+
+        By default, the debug report is generated under user temporary files
+        directory. This is usually fine if it is meant to be processed in some
+        way (e.g. automatically uploaded to a remote server) but if the user is
+        asked to manually upload or send the report, it may be more convenient
+        to generate it in e.g. the users home directory and this function
+        allows to do this.
+
+        Notice that it should be called before wxDebugReport::Process() or it
+        has no effect.
+
+        @param dir
+            The full path to an existing directory where the debug report file
+            should be generated.
+
+        @since 2.9.1
+     */
+    void SetCompressedFileDirectory(const wxString& dir);
+
+    /**
+        Set the base name of the generated debug report file.
+
+        This function is similar to SetCompressedFileDirectory() but allows to
+        change the base name of the file. Notice that the file extension will
+        always be @c .zip.
+
+        By default, a unique name constructed from wxApp::GetAppName(), the
+        current process id and the current date and time is used.
+
+        @param dir
+            The base name (i.e. without extension) of the file.
+
+        @since 2.9.1
+     */
+    void SetCompressedFileBaseName(const wxString& name);
+

     /**
         Returns the full path of the compressed file (empty if creation
         failed).
     */
     /**
         Returns the full path of the compressed file (empty if creation
         failed).
     */

-    const wxString GetCompressedFileName() const;
+    const wxString& GetCompressedFileName() const;

 };
 
 
 };
 
 


@@ -135,7 +173,7 @@ public:
         constructor with all the files it contains. Call Reset() to prevent
         this from happening.
     */
         constructor with all the files it contains. Call Reset() to prevent
         this from happening.
     */

-    ~wxDebugReport();
+    virtual ~wxDebugReport();

 
     /**
         Adds all available information to the report. Currently this includes a
 
     /**
         Adds all available information to the report. Currently this includes a


@@ -148,7 +186,7 @@ public:
         Add an XML file containing the current or exception context and the
         stack trace.
     */
         Add an XML file containing the current or exception context and the
         stack trace.
     */

-    bool AddContext(Context ctx);
+    virtual bool AddContext(Context ctx);

 
     /**
         The same as calling AddContext(Context_Current).
 
     /**
         The same as calling AddContext(Context_Current).


@@ -167,7 +205,7 @@ public:
         (@c dbghlp32.dll can be installed under older systems to make minidumps
         available).
     */
         (@c dbghlp32.dll can be installed under older systems to make minidumps
         available).
     */

-    bool AddDump(Context ctx);
+    virtual bool AddDump(Context ctx);

 
     /**
         The same as calling AddContext(Context_Exception).
 
     /**
         The same as calling AddContext(Context_Exception).


@@ -188,7 +226,7 @@ public:
 
         @see GetDirectory(), AddText()
     */
 
         @see GetDirectory(), AddText()
     */

-    void AddFile(const wxString& filename, const wxString& description);
+    virtual void AddFile(const wxString& filename, const wxString& description);

 
     /**
         This is a convenient wrapper around AddFile(). It creates the file with
 
     /**
         This is a convenient wrapper around AddFile(). It creates the file with


@@ -201,30 +239,6 @@ public:
     bool AddText(const wxString& filename, const wxString& text,
                  const wxString& description);
 
     bool AddText(const wxString& filename, const wxString& text,
                  const wxString& description);
 

-    /**
-        This function may be overridden to add arbitrary custom context to the
-        XML context file created by AddContext(). By default, it does nothing.
-    */
-    void DoAddCustomContext(wxXmlNode* nodeRoot);
-
-    /**
-        This function may be overridden to modify the contents of the exception
-        tag in the XML context file.
-    */
-    bool DoAddExceptionInfo(wxXmlNode* nodeContext);
-
-    /**
-        This function may be overridden to modify the contents of the modules
-        tag in the XML context file.
-    */
-    bool DoAddLoadedModules(wxXmlNode* nodeModules);
-
-    /**
-        This function may be overridden to modify the contents of the system
-        tag in the XML context file.
-    */
-    bool DoAddSystemInfo(wxXmlNode* nodeSystemInfo);
-

     /**
         This method should be used to construct the full name of the files
         which you wish to add to the report using AddFile().
     /**
         This method should be used to construct the full name of the files
         which you wish to add to the report using AddFile().


@@ -232,7 +246,7 @@ public:
         @return The name of the temporary directory used for the files in this
                  report.
     */
         @return The name of the temporary directory used for the files in this
                  report.
     */

-    const wxString GetDirectory() const;
+    const wxString& GetDirectory() const;

 
     /**
         Retrieves the name (relative to GetDirectory()) and the description of
 
     /**
         Retrieves the name (relative to GetDirectory()) and the description of


@@ -250,7 +264,7 @@ public:
         Gets the name used as a base name for various files, by default
         wxApp::GetAppName() is used.
     */
         Gets the name used as a base name for various files, by default
         wxApp::GetAppName() is used.
     */

-    wxString GetReportName() const;
+    virtual wxString GetReportName() const;

 
     /**
         Returns @true if the object was successfully initialized. If this
 
     /**
         Returns @true if the object was successfully initialized. If this


@@ -277,6 +291,32 @@ public:
         after this as it becomes uninitialized and invalid.
     */
     void Reset();
         after this as it becomes uninitialized and invalid.
     */
     void Reset();

+
+protected:
+
+    /**
+        This function may be overridden to add arbitrary custom context to the
+        XML context file created by AddContext(). By default, it does nothing.
+    */
+    virtual void DoAddCustomContext(wxXmlNode* nodeRoot);
+
+    /**
+        This function may be overridden to modify the contents of the exception
+        tag in the XML context file.
+    */
+    virtual bool DoAddExceptionInfo(wxXmlNode* nodeContext);
+
+    /**
+        This function may be overridden to modify the contents of the modules
+        tag in the XML context file.
+    */
+    virtual bool DoAddLoadedModules(wxXmlNode* nodeModules);
+
+    /**
+        This function may be overridden to modify the contents of the system
+        tag in the XML context file.
+    */
+    virtual bool DoAddSystemInfo(wxXmlNode* nodeSystemInfo);

 };
 
 
 };
 
 


@@ -335,12 +375,13 @@ public:
                         const wxString& action,
                         const wxString& curl = "curl");
 
                         const wxString& action,
                         const wxString& curl = "curl");
 

+protected:

     /**
         This function may be overridden in a derived class to show the output
         from curl: this may be an HTML page or anything else that the server
         returned. Value returned by this function becomes the return value of
         wxDebugReport::Process().
     */
     /**
         This function may be overridden in a derived class to show the output
         from curl: this may be an HTML page or anything else that the server
         returned. Value returned by this function becomes the return value of
         wxDebugReport::Process().
     */

-    bool OnServerReply(const wxArrayString& reply);
+    virtual bool OnServerReply(const wxArrayString& reply);

 };
 
 };