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