src/TransferWnd.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 Merkur ( devs@emule-project.net / http://www.emule-project.net )
   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 TRANSFERWND_H
  27 #define TRANSFERWND_H
  28
  29 #include <wx/panel.h>   // Needed for wxPanel
  30 #include <wx/notebook.h>        // needed for wxBookCtrlEvent in wx 2.8
  31 #include "Types.h"              // Needed for uint32
  32 #include "OtherStructs.h"
  33
  34 class CSourceListCtrl;
  35 class CDownloadListCtrl;
  36 class CMuleNotebook;
  37 class wxListCtrl;
  38 class wxSplitterEvent;
  39 class wxCommandEvent;
  40 class wxMouseEvent;
  41 class wxEvent;
  42 class wxMenu;
  43
  44 /**
  45  * This class takes care of managing the lists and other controls contained
  46  * in the transfer-window. It's primary function is to manage the user-defined
  47  * categories.
  48  */
  49 class CTransferWnd : public wxPanel
  50 {
  51 public:
  52         /**
  53          * Constructor.
  54          */
  55         CTransferWnd(wxWindow* pParent = NULL);
  56
  57         /**
  58          * Destructor.
  59          */
  60         ~CTransferWnd();
  61
  62
  63         /**
  64          * Adds the specified category to the end of the list.
  65          *
  66          * @param category A pointer to the new category.
  67          *
  68          * This function should be called after a category has been
  69          * added to the lists of categories. The new category is assumed
  70          * to be the last, and thus will be appended to the end of the tabs
  71          * on the category-notebook.
  72          */
  73         void AddCategory( Category_Struct* category );
  74
  75         /**
  76          * Updates the title of the specified category.
  77          *
  78          * @param index The index of the category on the notebook. -1 will update all categories.
  79          */
  80         void UpdateCategory(int index);
  81
  82         /**
  83          * Remove category
  84          */
  85         void RemoveCategory(int index);
  86         void RemoveCategoryPage(int index);
  87
  88         /**
  89          * This functions updates the displayed client-numbers*
  90          *
  91          * @param number The number of clients on the upload queue.
  92          *
  93          * This function updates both the number of clients on the queue,
  94          * as well as the number of banned clients.
  95          */
  96         void    ShowQueueCount(uint32 number);
  97
  98         /**
  99          * Helper-function which updates the displayed titles of all existing categories.
 100          */
 101         void    UpdateCatTabTitles() { UpdateCategory(-1); }
 102
 103
 104         /**
 105          * Call this function before displaying the dialog.
 106          *
 107          * This functions does a few tasks to ensure that the dialog is looking the right way.
 108          */
 109         void    Prepare();
 110
 111         //! Pointer to the download-queue.
 112         CDownloadListCtrl*      downloadlistctrl;
 113         //! Pointer to the list of clients.
 114         CSourceListCtrl*        clientlistctrl;
 115
 116 private:
 117         //! Contains the current (or last if the clientlist is hidden) position of the splitter.
 118         int m_splitter;
 119         //! Minimum position of splitter bar
 120         static const int s_splitterMin = 90;
 121
 122         /**
 123          * Event-handler for the set status by category menu-item.
 124          */
 125         void OnSetCatStatus( wxCommandEvent& event );
 126
 127         /**
 128          * Event-handler for the set priority by category menu-item.
 129          */
 130         void OnSetCatPriority( wxCommandEvent& event );
 131
 132         /**
 133          * Event-handler for the "Add Category" menu-item.
 134          */
 135         void OnAddCategory( wxCommandEvent& event );
 136
 137         /**
 138          * Event-handler for the "Delete Category" menu-item.
 139          */
 140         void OnDelCategory( wxCommandEvent& event );
 141
 142         /**
 143          * Event-handler for the "Edit Category" menu-item.
 144          */
 145         void OnEditCategory( wxCommandEvent& event );
 146
 147         /**
 148          * Event-handler for manipulating the default category.
 149          */
 150         void OnSetDefaultCat( wxCommandEvent& event );
 151
 152         /**
 153          * Event-handler for the "Clear Completed" button.
 154          */
 155         void OnBtnClearDownloads(wxCommandEvent &evt);
 156
 157         /**
 158          * Event-handler for changing categories.
 159          */
 160         void OnCategoryChanged(wxBookCtrlEvent& evt);
 161
 162         /**
 163          * Event-handler for displaying the category-popup menu.
 164          */
 165         void OnNMRclickDLtab(wxMouseEvent& evt);
 166
 167         /**
 168          * Event-handler for the list-toggle button.
 169          */
 170         void OnToggleClientList( wxCommandEvent& event );
 171
 172         /**
 173          * Event-handler for changes in the sash divider position.
 174          */
 175         void OnSashPositionChanging(wxSplitterEvent& evt);
 176
 177
 178         //! Variable used to ensure that the category menu doesn't get displayed twice.
 179         wxMenu* m_menu;
 180
 181         //! Pointer to the category tabs.
 182         CMuleNotebook* m_dlTab;
 183
 184
 185         DECLARE_EVENT_TABLE()
 186 };
 187
 188 #endif
 189
 190 // File_checked_for_headers