Improve comment
[amule.git] / src / CaptchaDialog.h
blobb4b0392bf92b192d700da9d0d2d9adfa107ccf33
1 //
2 // This file is part of the aMule Project.
3 //
4 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
5 //
6 // Any parts of this program derived from the xMule, lMule or eMule project,
7 // or contributed by third-party developers are copyrighted by their
8 // respective authors.
9 //
10 // This program is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation; either version 2 of the License, or
13 // (at your option) any later version.
15 // This program is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
19 //
20 // You should have received a copy of the GNU General Public License
21 // along with this program; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
25 #ifndef CAPTCHADIALOG_H
26 #define CAPTCHADIALOG_H
28 #include <wx/dialog.h> // Needed for wxDialog
29 #include "Types.h"
31 /**
32 * The ClientDetailDialog class is responsible for showing the info about a client.
34 * It shows all releavant data about the client: ip, port, hash, name, client
35 * type and version, uploading/downloading data, credits, server... etc
37 * It's wxDialog, modal, with return value always '0'.
41 class CCaptchaDialog : public wxDialog
43 public:
44 /**
45 * Constructor.
47 * @param parent The window that created the dialog.
48 * @param client The client whose details we're showing.
50 CCaptchaDialog(wxWindow*parent, const wxImage& captchaImage, uint64 id);
52 /**
53 * Destructor.
55 virtual ~CCaptchaDialog();
57 protected:
59 /**
60 * Creates all the data objects in the dialog, filling them accordingly.
62 * Called when the dialog object is created.
64 virtual bool OnInitDialog();
66 /**
67 * Ends the dialog, calling EndModal with return value 0
69 * @param evt The close event, unused right now
71 void OnBnClose(wxCommandEvent& evt);
73 DECLARE_EVENT_TABLE()
75 private:
77 wxSizer * captchaDlg( wxWindow *parent );
79 class wxBitmap * m_captchaBitmap;
80 class wxTextCtrl * m_TextCtrl;
81 uint64 m_id;
83 #endif // CAPTCHADIALOG_H
84 // File_checked_for_headers