src/CatDialog.h

   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 // Copyright (c) 2002 quekky
   6 //
   7 // Any parts of this program derived from the xMule, lMule or eMule project,
   8 // or contributed by third-party developers are copyrighted by their
   9 // respective authors.
  10 //
  11 // This program is free software; you can redistribute it and/or modify
  12 // it under the terms of the GNU General Public License as published by
  13 // the Free Software Foundation; either version 2 of the License, or
  14 // (at your option) any later version.
  15 //
  16 // This program is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 // GNU General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  24 //
  25
  26 #ifndef CATDIALOG_H
  27 #define CATDIALOG_H
  28
  29 #include <wx/dialog.h>          // Needed for wxDialog
  30 #include "Types.h"              // Needed for uint32
  31 #include "OtherStructs.h"
  32
  33 class wxStaticBitmap;
  34 class wxBitmap;
  35 class wxColour;
  36
  37
  38 /**
  39  * This dialog takes of displaying either existing or new categories, so that
  40  * the user can add or change them.
  41  *
  42  * It is a self-contained entity, and does not rely on the categories staying
  43  * the same while the dialog is visble, though it will overwrite any changes
  44  * made to the selected category in the mean time. Also, if the selected category
  45  * has been deleted then it will simply be readded.
  46  *
  47  * It does however rely on the Transferwnd keeping its own list of categories up-
  48  * to-date.
  49  */
  50 class CCatDialog : public wxDialog
  51 {
  52 public:
  53         /**
  54          * Constructor.
  55          *
  56          * @param parent The parent of the new dialog.
  57          * @param catindex The category to be edited.
  58          *
  59          * The parameter catindex can be a valid index, in which case that category
  60          * will be selected, or it can be less than zero, in which case a new
  61          * category will be created.
  62          */
  63         CCatDialog(wxWindow* parent, bool allowbrowse, int catindex = -1 );
  64
  65         /**
  66          * Destructor.
  67          */
  68         ~CCatDialog();
  69
  70 private:
  71         /**
  72          * Helper function for making the color-preview.
  73          *
  74          * @param colour The color with which to fill the bitmap.
  75          *
  76          * This function creates a single-color 16x16 image, using the
  77          * specified colour.
  78          */
  79         wxBitmap MakeBitmap( wxColour colour );
  80
  81
  82         //! Variable used to store the user-selected color.
  83         uint32                  m_color;
  84
  85         //! Pointer to category to be edited or NULL if we are adding a new category.
  86         Category_Struct*        m_category;
  87
  88
  89         /**
  90          * Event-handler for selecting incomming dir.
  91          */
  92         void OnBnClickedBrowse(wxCommandEvent& evt);
  93
  94         /**
  95          * Event-handler for saving the changes.
  96          */
  97         void OnBnClickedOk(wxCommandEvent& evt);
  98
  99         /**
 100          * Event-handler for selecting category color.
 101          */
 102         void OnBnClickColor(wxCommandEvent& evt);
 103
 104         DECLARE_EVENT_TABLE()
 105 };
 106
 107 #endif
 108 // File_checked_for_headers