X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..390f44afb6076b672fc673ef9e0c89f018ea7e75:/interface/debugrpt.h diff --git a/interface/debugrpt.h b/interface/debugrpt.h index 3480b5c88e..c79b13dcb8 100644 --- a/interface/debugrpt.h +++ b/interface/debugrpt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: debugrpt.h -// Purpose: documentation for wxDebugReportPreview class +// Purpose: interface of wxDebugReportPreview // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -43,10 +43,11 @@ public: report should be processed or @false if the user chose to cancel report generation or removed all files from it. */ - bool Show(wxDebugReport& dbgrpt); + bool Show(wxDebugReport& dbgrpt) const; }; + /** @class wxDebugReportCompress @wxheader{debugrpt.h} @@ -69,10 +70,11 @@ public: /** Returns the full path of the compressed file (empty if creation failed). */ - const wxString GetCompressedFileName(); + const wxString GetCompressedFileName() const; }; + /** @class wxDebugReport @wxheader{debugrpt.h} @@ -80,7 +82,7 @@ public: wxDebugReport is used to generate a debug report, containing information about the program current state. It is usually used from wxApp::OnFatalException as shown in the - sample. + sample(). A wxDebugReport object contains one or more files. A few of them can be created by the @@ -209,7 +211,7 @@ public: This method should be used to construct the full name of the files which you wish to add to the report using AddFile(). */ - const wxString GetDirectory(); + const wxString GetDirectory() const; /** Retrieves the name (relative to @@ -217,25 +219,25 @@ public: file with the given index. If @a n is greater than or equal to the number of filse, @false is returned. */ - bool GetFile(size_t n, wxString* name, wxString* desc); + bool GetFile(size_t n, wxString* name, wxString* desc) const; /** Gets the current number files in this report. */ - size_t GetFilesCount(); + size_t GetFilesCount() const; /** Gets the name used as a base name for various files, by default wxApp::GetAppName is used. */ - wxString GetReportName(); + wxString GetReportName() const; /** Returns @true if the object was successfully initialized. If this method returns @false the report can't be used. */ - bool IsOk(); + bool IsOk() const; /** Processes this report: the base class simply notifies the user that the @@ -259,6 +261,7 @@ public: }; + /** @class wxDebugReportPreviewStd @wxheader{debugrpt.h} @@ -283,10 +286,11 @@ public: wxDebugReportPreview::Show for more information. */ - bool Show(wxDebugReport& dbgrpt); + bool Show(wxDebugReport& dbgrpt) const; }; + /** @class wxDebugReportUpload @wxheader{debugrpt.h} @@ -323,3 +327,4 @@ public: */ bool OnServerReply(); }; +