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.
  79          * @param titleChanged Set to true if the actual title has changed.
  80          *
  81          * The second paramerter will make the UpdateCategory function signal
  82          * to the searchdlg page that the lists of categories has been changed,
  83          * and force it to refresh its list of categories.
  84          *
  85          * This however should only be done when the title has actually changed,
  86          * since it will cause the user-selection to be reset.
  87          */
  88         void UpdateCategory( int index, bool titleChanged = false );
  89
  90         /**
  91          * Remove category
  92          */
  93         void RemoveCategory(int index);
  94         void RemoveCategoryPage(int index);
  95
  96         /**
  97          * This functions updates the displayed client-numbers*
  98          *
  99          * @param number The number of clients on the upload queue.
 100          *
 101          * This function updates both the number of clients on the queue,
 102          * as well as the number of banned clients.
 103          */
 104         void    ShowQueueCount(uint32 number);
 105
 106         /**
 107          * This function switches between showing the upload-queue and the list of
 108          * client who are currently recieving files.
 109          */
 110         void    SwitchUploadList(wxCommandEvent& evt);
 111
 112         /**
 113          * Helper-function which updates the displayed titles of all existing categories.
 114          */
 115         void    UpdateCatTabTitles();
 116
 117
 118         /**
 119          * Call this function before displaying the dialog.
 120          *
 121          * This functions does a few tasks to ensure that the dialog is looking the right way.
 122          */
 123         void    Prepare();
 124
 125         //! Pointer to the download-queue.
 126         CDownloadListCtrl*      downloadlistctrl;
 127         //! Pointer to the list of clients.
 128         CSourceListCtrl*        clientlistctrl;
 129
 130         //! Contains the current (or last if the clientlist is hidden) position of the splitter.
 131         int m_splitter;
 132
 133 private:
 134         /**
 135          * Event-handler for the set status by category menu-item.
 136          */
 137         void OnSetCatStatus( wxCommandEvent& event );
 138
 139         /**
 140          * Event-handler for the set priority by category menu-item.
 141          */
 142         void OnSetCatPriority( wxCommandEvent& event );
 143
 144         /**
 145          * Event-handler for the "Add Category" menu-item.
 146          */
 147         void OnAddCategory( wxCommandEvent& event );
 148
 149         /**
 150          * Event-handler for the "Delete Category" menu-item.
 151          */
 152         void OnDelCategory( wxCommandEvent& event );
 153
 154         /**
 155          * Event-handler for the "Edit Category" menu-item.
 156          */
 157         void OnEditCategory( wxCommandEvent& event );
 158
 159         /**
 160          * Event-handler for manipulating the default category.
 161          */
 162         void OnSetDefaultCat( wxCommandEvent& event );
 163
 164         /**
 165          * Event-handler for the "Clear Completed" button.
 166          */
 167         void OnBtnClearDownloads(wxCommandEvent &evt);
 168
 169         /**
 170          * Event-handler for changing categories.
 171          */
 172         void OnCategoryChanged(wxBookCtrlEvent& evt);
 173
 174         /**
 175          * Event-handler for displaying the category-popup menu.
 176          */
 177         void OnNMRclickDLtab(wxMouseEvent& evt);
 178
 179         /**
 180          * Event-handler for the list-toggle button.
 181          */
 182         void OnToggleClientList( wxCommandEvent& event );
 183
 184         /**
 185          * Event-handler for changes in the sash divider position.
 186          */
 187         void OnSashPositionChanging(wxSplitterEvent& evt);
 188
 189
 190         //! Variable used to ensure that the category menu doesn't get displayed twice.
 191         wxMenu* m_menu;
 192
 193         //! Pointer to the category tabs.
 194         CMuleNotebook* m_dlTab;
 195
 196
 197         DECLARE_EVENT_TABLE()
 198 };
 199
 200 #endif
 201
 202 // File_checked_for_headers