src/SharedFilesCtrl.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 SHAREDFILESCTRL_H
  27 #define SHAREDFILESCTRL_H
  28
  29 #include "MuleListCtrl.h"       // Needed for CMuleListCtrl
  30
  31
  32 class CSharedFileList;
  33 class CKnownFile;
  34 class wxMenu;
  35
  36
  37 /**
  38  * This class represents the widget used to list shared files.
  39  */
  40 class CSharedFilesCtrl : public CMuleListCtrl
  41 {
  42 public:
  43         /**
  44          * Constructor.
  45          *
  46          * @see CMuleListCtrl::CMuleListCtrl
  47          */
  48         CSharedFilesCtrl(wxWindow* parent, int id, const wxPoint& pos, wxSize size, int flags);
  49
  50         /**
  51          * Destructor.
  52          */
  53         ~CSharedFilesCtrl();
  54
  55
  56 #ifndef CLIENT_GUI
  57         /** Reloads the list of shared files. */
  58         void    ShowFileList();
  59 #endif
  60
  61         /**
  62          * Adds the specified file to the list, updating filecount and more.
  63          *
  64          * @param file The new file to be shown.
  65          *
  66          * Note that the item is inserted in sorted order.
  67          */
  68         void    ShowFile(CKnownFile* file);
  69
  70         /**
  71          * Removes a file from the list.
  72          *
  73          * @param toremove The file to be removed.
  74          */
  75         void    RemoveFile(CKnownFile* toremove);
  76
  77         /**
  78          * Updates a file on the list.
  79          *
  80          * @param toupdate The file to be updated.
  81          */
  82         void    UpdateItem(CKnownFile* toupdate);
  83
  84         /**
  85          * Updates the number of shared files displayed above the list.
  86          */
  87         void    ShowFilesCount();
  88
  89 private:
  90         /**
  91          * Adds the specified file to the list.
  92          *
  93          * If 'batch' is true, the item will be inserted last,
  94          * and the files-count will not be updated, nor is
  95          * the list checked for dupes.
  96          */
  97         void    DoShowFile(CKnownFile* file, bool batch);
  98
  99         /**
 100          * Draws the graph of file-part availability.
 101          *
 102          * @param file The file to make a graph over.
 103          * @param dc The wcDC to draw on.
 104          * @param rect The drawing area.
 105          *
 106          * This function draws a barspan showing the availability of the parts of
 107          * a file, for both Part-files and Known-files. Availability for Part-files
 108          * is determined using the currently known sources, while availability for
 109          * Known-files is determined using the sources requesting that file.
 110          */
 111         void    DrawAvailabilityBar( CKnownFile* file, wxDC* dc, const wxRect& rect ) const;
 112
 113         /**
 114          * Overloaded function needed to do custom drawing of the items.
 115          */
 116         virtual void OnDrawItem(int item, wxDC* dc, const wxRect& rect, const wxRect& rectHL, bool highlighted);
 117
 118
 119         /**
 120          * @see CMuleListCtrl::GetTTSText
 121          */
 122         virtual wxString GetTTSText(unsigned item) const;
 123
 124
 125         /**
 126          * Sorter-function.
 127          *
 128          * @see wxListCtrl::SortItems
 129          */
 130         static int wxCALLBACK SortProc(wxUIntPtr item1, wxUIntPtr item2, long sortData);
 131
 132         /**
 133          * Function that specifies which columns have alternate sorting.
 134          *
 135          * @see CMuleListCtrl::AltSortAllowed
 136          */
 137         virtual bool AltSortAllowed(unsigned column) const;
 138
 139
 140         /**
 141          * Event-handler for right-clicks on the list-items.
 142          */
 143         void    OnRightClick(wxListEvent& event);
 144
 145         /**
 146          * Event-handler for right-clicks on the list-items.
 147          */
 148         void    OnGetFeedback(wxCommandEvent& event);
 149
 150         /**
 151          * Event-handler for the Set Priority menu items.
 152          */
 153         void    OnSetPriority( wxCommandEvent& event );
 154
 155         /**
 156          * Event-handler for the Auto-Priority menu item.
 157          */
 158         void    OnSetPriorityAuto( wxCommandEvent& event );
 159
 160         /**
 161          * Event-handler for the Create ED2K/Magnet URI items.
 162          */
 163         void    OnCreateURI( wxCommandEvent& event );
 164
 165         /**
 166          * Event handler for get-razorback stats menu item
 167          */
 168         void OnGetRazorStats( wxCommandEvent& evt );
 169
 170         /**
 171          * Event-handler for the Edit Comment menu item.
 172          */
 173         void    OnEditComment( wxCommandEvent& event );
 174
 175         /**
 176          * Event-handler for the Rename menu item.
 177          */
 178         void    OnRename( wxCommandEvent& event );
 179
 180         /**
 181          * Checks for renaming via F2.
 182          */
 183         void    OnKeyPressed( wxKeyEvent& event );
 184
 185         /**
 186          * Adds links in a collection to transfers
 187          */
 188         void    OnAddCollection( wxCommandEvent& WXUNUSED(evt) );
 189
 190         //! Pointer used to ensure that the menu isn't displayed twice.
 191         wxMenu* m_menu;
 192
 193
 194         DECLARE_EVENT_TABLE()
 195 };
 196
 197 #endif
 198 // File_checked_for_headers