projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 4e0e7d39 VZ |
1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: debugrptpvw.tex | |
| 3 | %% Purpose: wxDebugReportPreview documentation | |
| 4 | %% Author: Vadim Zeitlin | |
| 5 | %% Modified by: | |
| 6 | %% Created: 2005-03-21 | |
| 7 | %% RCS-ID: $Id$ | |
| 8 | %% Copyright: (c) Vadim Zeitlin 2005 | |
| 9 | %% License: wxWindows license | |
| 10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
| 11 | ||
| 12 | \section{\class{wxDebugReportPreview}}\label{wxdebugreportpreview} | |
| 13 | ||
| 14 | This class presents the debug report to the user and allows him to veto report | |
| 15 | entirely or remove some parts of it. Although not mandatory, using this class | |
| 16 | is strongly recommended as data included in the debug report might contain | |
| 17 | sensitive private information and the user should be notified about it as well | |
| 18 | as having a possibility to examine the data which had been gathered to check | |
| 19 | whether this is effectively the case and discard the debug report if it is. | |
| 20 | ||
| 21 | wxDebugReportPreview is an abstract base class, currently the only concrete | |
| 22 | class deriving from it is | |
| 23 | \helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}. | |
| 24 | ||
| 25 | \wxheading{Derived from} | |
| 26 | ||
| 27 | No base class | |
| 28 | ||
| 29 | \wxheading{Include files} | |
| 30 | ||
| 31 | <wx/debugrpt.h> | |
| 32 | ||
| a7af285d VZ |
33 | \wxheading{Library} |
| 34 | ||
| 35 | \helpref{wxQa}{librarieslist} | |
| 36 | ||
| 4e0e7d39 VZ |
37 | |
| 38 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 39 | ||
| 40 | ||
| 41 | \membersection{wxDebugReportPreview::wxDebugReportPreview}\label{wxdebugreportpreviewwxdebugreportpreview} | |
| 42 | ||
| 43 | \func{}{wxDebugReportPreview}{\void} | |
| 44 | ||
| 45 | Trivial default constructor. | |
| 46 | ||
| 47 | ||
| 48 | \membersection{wxDebugReportPreview::\destruct{wxDebugReportPreview}}\label{wxdebugreportpreviewdtor} | |
| 49 | ||
| 50 | \func{}{\destruct{wxDebugReportPreview}}{\void} | |
| 51 | ||
| 52 | dtor is trivial as well but should be virtual for a base class | |
| 53 | ||
| 54 | ||
| 55 | \membersection{wxDebugReportPreview::Show}\label{wxdebugreportpreviewshow} | |
| 56 | ||
| 57 | \constfunc{bool}{Show}{\param{wxDebugReport\& }{dbgrpt}} | |
| 58 | ||
| 59 | Present the report to the user and allow him to modify it by removing some or | |
| 60 | all of the files and, potentially, adding some notes. Return \true if the | |
| 61 | report should be processed or \false if the user chose to cancel report | |
| 62 | generation or removed all files from it. | |
| 63 |