docs/latex/wx/debugrptup.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        debugrptup.tex
   3 %% Purpose:     wxDebugReportUpload 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{wxDebugReportUpload}}\label{wxdebugreportupload}
  13
  14 This class is used to upload a compressed file using HTTP POST request. As this
  15 class derives from wxDebugReportCompress, before upload the report is
  16 compressed in a single .ZIP file.
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxDebugReportCompress}{wxdebugreportcompress}
  21
  22 \wxheading{Include files}
  23
  24 <wx/debugrpt.h>
  25
  26 \wxheading{Library}
  27
  28 \helpref{wxQa}{librarieslist}
  29
  30
  31 \latexignore{\rtfignore{\wxheading{Members}}}
  32
  33 \membersection{wxDebugReportUpload::wxDebugReportUpload}\label{wxdebugreportuploadwxdebugreportupload}
  34
  35 \func{}{wxDebugReportUpload}{\param{const wxString\& }{url}, \param{const wxString\& }{input}, \param{const wxString\& }{action}, \param{const wxString\& }{curl = \_T("curl")}}
  36
  37 This class will upload the compressed file created by its base class to an HTML
  38 multipart/form-data form at the specified address. The \arg{url} is the upload
  39 page address, \arg{input} is the name of the \texttt{"type=file"} control on
  40 the form used for the file name and \arg{action} is the value of the form
  41 action field. The report is uploaded using \texttt{\textit{curl}} program which
  42 should be available, the \arg{curl} parameter may be used to specify the full
  43 path to it.
  44
  45
  46 \membersection{wxDebugReportUpload::OnServerReply}\label{wxdebugreportuploadonserverreply}
  47
  48 \func{bool}{OnServerReply}{\param{const wxArrayString\& }{WXUNUSED(reply)}}
  49
  50 This function may be overridden in a derived class to show the output from
  51 curl: this may be an HTML page or anything else that the server returned.
  52 Value returned by this function becomes the return value of
  53 \helpref{wxDebugReport::Process()}{wxdebugreportprocess}.
  54
  55