[wxWidgets.git] / docs / latex / wx / debugrptpvw.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        debugrptpvw.tex
%% Purpose:     wxDebugReportPreview documentation
%% Author:      Vadim Zeitlin
%% Modified by:
%% Created:     2005-03-21
%% RCS-ID:      $Id$
%% Copyright:   (c) Vadim Zeitlin 2005
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxDebugReportPreview}}\label{wxdebugreportpreview}

This class presents the debug report to the user and allows him to veto report
entirely or remove some parts of it. Although not mandatory, using this class
is strongly recommended as data included in the debug report might contain
sensitive private information and the user should be notified about it as well
as having a possibility to examine the data which had been gathered to check
whether this is effectively the case and discard the debug report if it is.

wxDebugReportPreview is an abstract base class, currently the only concrete
class deriving from it is 
\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/debugrpt.h>


\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxDebugReportPreview::wxDebugReportPreview}\label{wxdebugreportpreviewwxdebugreportpreview}

\func{}{wxDebugReportPreview}{\void}

Trivial default constructor.


\membersection{wxDebugReportPreview::\destruct{wxDebugReportPreview}}\label{wxdebugreportpreviewdtor}

\func{}{\destruct{wxDebugReportPreview}}{\void}

dtor is trivial as well but should be virtual for a base class


\membersection{wxDebugReportPreview::Show}\label{wxdebugreportpreviewshow}

\constfunc{bool}{Show}{\param{wxDebugReport\& }{dbgrpt}}

Present the report to the user and allow him to modify it by removing some or
all of the files and, potentially, adding some notes. Return \true if the
report should be processed or \false if the user chose to cancel report
generation or removed all files from it.
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
	33
	34	\latexignore{\rtfignore{\wxheading{Members}}}
	35
	36
	37	\membersection{wxDebugReportPreview::wxDebugReportPreview}\label{wxdebugreportpreviewwxdebugreportpreview}
	38
	39	\func{}{wxDebugReportPreview}{\void}
	40
	41	Trivial default constructor.
	42
	43
	44	\membersection{wxDebugReportPreview::\destruct{wxDebugReportPreview}}\label{wxdebugreportpreviewdtor}
	45
	46	\func{}{\destruct{wxDebugReportPreview}}{\void}
	47
	48	dtor is trivial as well but should be virtual for a base class
	49
	50
	51	\membersection{wxDebugReportPreview::Show}\label{wxdebugreportpreviewshow}
	52
	53	\constfunc{bool}{Show}{\param{wxDebugReport\& }{dbgrpt}}
	54
	55	Present the report to the user and allow him to modify it by removing some or
	56	all of the files and, potentially, adding some notes. Return \true if the
	57	report should be processed or \false if the user chose to cancel report
	58	generation or removed all files from it.
	59