X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/802fa22622ff0e179592b70aab49052f621144f3..e815120e412d91e79c98dd0afac2a1e399f10810:/docs/latex/wx/debugrpt.tex?ds=sidebyside diff --git a/docs/latex/wx/debugrpt.tex b/docs/latex/wx/debugrpt.tex index ef3ef801cb..df438049c0 100644 --- a/docs/latex/wx/debugrpt.tex +++ b/docs/latex/wx/debugrpt.tex @@ -51,6 +51,10 @@ No base class +\wxheading{Library} + +\helpref{wxQa}{librarieslist} + \wxheading{Data structures} This enum is used for functions that report either the current state @@ -142,14 +146,32 @@ The same as \helpref{AddDump(Context\_Exception)}{wxdebugreportadddump}. \membersection{wxDebugReport::AddFile}\label{wxdebugreportaddfile} -\func{void}{AddFile}{\param{const wxString\& }{name}, \param{const wxString\& }{description}} +\func{void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxString\& }{description}} -Add another file to the report: the file must already exist on disk. Its name -is relative to \helpref{GetDirectory()}{wxdebugreportgetdirectory}. +Add another file to the report. If \arg{filename} is an absolute path, it is +copied to a file in the debug report directory with the same name. Otherwise +the file should already exist in this directory -\arg{description} only exists to be shown to the user in the report summary +\arg{description} only exists to be displayed to the user in the report summary shown by \helpref{wxDebugReportPreview}{wxdebugreportpreview}. +\wxheading{See also } + +\helpref{GetDirectory()}{wxdebugreportgetdirectory},\\ +\helpref{AddText()}{wxdebugreportaddtext} + + +\membersection{wxDebugReport::AddText}\label{wxdebugreportaddtext} + +\func{bool}{AddText}{\param{const wxString\& }{filename}, \param{const wxString\& }{text}, \param{const wxString\& }{description}} + +This is a convenient wrapper around \helpref{AddFile}{wxdebugreportaddfile}. It +creates the file with the given \arg{name} and writes \arg{text} to it, then +adds the file to the report. The \arg{filename} shouldn't contain the path. + +Returns \true if file could be added successfully, \false if an IO error +occurred. + \membersection{wxDebugReport::DoAddCustomContext}\label{wxdebugreportdoaddcustomcontext}