src/SearchListCtrl.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-2008 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 SEARCHLISTCTRL_H
  27 #define SEARCHLISTCTRL_H
  28
  29
  30 #include "wx/colour.h"          // Needed for wxColour
  31 #include <wx/regex.h>           // Needed for wxRegExp
  32
  33 #include "MuleListCtrl.h"       // Needed for CMuleListCtrl
  34
  35
  36 class CSearchList;
  37 class CSearchFile;
  38
  39
  40 /**
  41  * This class is used to display search results.
  42  *
  43  * Results on added to the list will be colored according to
  44  * the number of sources and other parameters (see UpdateColor).
  45  *
  46  * To display results, first use the ShowResults function, which will display
  47  * all current results with the specified id and afterwards you can use the
  48  * AddResult function to add new results or the UpdateResult function to update
  49  * already present results. Please note that it is not possible to add results
  50  * with the AddResult function before calling ShowResults.
  51  */
  52 class CSearchListCtrl : public CMuleListCtrl
  53 {
  54 public:
  55         /**
  56          * Constructor.
  57          *
  58          * @see CMuleListCtrl::CMuleListCtrl for documentation of parameters.
  59          */
  60          CSearchListCtrl(
  61                     wxWindow *parent,
  62                 wxWindowID winid = -1,
  63                 const wxPoint &pos = wxDefaultPosition,
  64                 const wxSize &size = wxDefaultSize,
  65                 long style = wxLC_ICON,
  66                 const wxValidator& validator = wxDefaultValidator,
  67                 const wxString &name = wxT("mulelistctrl") );
  68
  69         /**
  70          * Destructor.
  71          */
  72         virtual ~CSearchListCtrl();
  73
  74         /**
  75          * Adds ths specified file to the list.
  76          *
  77          * @param The new result to be shown.
  78          *
  79          * Please note that no duplicates checking is done, so the pointer should
  80          * point to a new file in order to avoid problems. Also note that the result
  81          * will be inserted sorted according to current sort-type, so there is no
  82          * need to resort the list after adding new items.
  83          */
  84         void    AddResult(CSearchFile* toshow);
  85
  86         /**
  87          * Removes the specified file from the list.
  88          */
  89         void    RemoveResult(CSearchFile* toshow);
  90
  91         /**
  92          * Updates the specified source.
  93          *
  94          * @param The search result to be updated.
  95          */
  96         void    UpdateResult(CSearchFile* toupdate);
  97
  98         /**
  99          * Clears the list and inserts all results with the specified Id instead.
 100          *
 101          * @param nResult The ID of the results or Zero to simply reset the list.
 102          */
 103         void    ShowResults( long ResultsId );
 104
 105         /**
 106          * Updates the colors of item at the specified index.
 107          *
 108          * @param index The zero-based index of the item.
 109          *
 110          * This function sets the color of the item based on the following:
 111          *  - Downloading files are marked in red.
 112          *  - Known (shared/completed) files are marked in green.
 113          *  - New files are marked in blue depending on the number of sources.
 114          *  - Canceled files are marked in magenta.
 115          */
 116         void UpdateItemColor(long index);
 117
 118         /**
 119          * Returns the current Search Id.
 120          *
 121          * @return The Search Id of the displayed results (set through ShowResults()).
 122          */
 123         wxUIntPtr       GetSearchId();
 124
 125         /**
 126          * Sets the filter which decides which results should be shown.
 127          *
 128          * @param regExp A regular expression targeting the filenames.
 129          * @param invert If true, invert the results of the filter-test.
 130          * @param filterKnown Should files that are queued or known be filtered out.
 131          *
 132          * An invalid regExp will result in all results being displayed.
 133          */
 134         void    SetFilter(const wxString& regExp, bool invert, bool filterKnown);
 135
 136         /**
 137          * Toggles the use of filtering on and off.
 138          */
 139         void    EnableFiltering(bool enabled);
 140
 141         /**
 142          * Returns the number of items hidden due to filtering.
 143          */
 144         size_t  GetHiddenItemCount() const;
 145
 146         /**
 147          * Attempts to download all selected items, updating color-scheme as needed.
 148          *
 149          * @param category The target category, or -1 to use the drop-down selection.
 150          */
 151         void    DownloadSelected(int category = -1);
 152
 153         static wxString DetermineStatusPrintable(CSearchFile *toshow);
 154
 155 protected:
 156         /// Return old column order.
 157         wxString GetOldColumnOrder() const;
 158
 159 protected:
 160         typedef std::list<CSearchFile*> ResultList;
 161
 162         //! List used to store results that are hidden due to matching the filter.
 163         ResultList      m_filteredOut;
 164
 165         //! The current filter reg-exp.
 166         wxRegEx         m_filter;
 167
 168         //! The text from which the filter is compiled.
 169         wxString        m_filterText;
 170
 171         //! Controls if shared/queued results should be shown.
 172         bool            m_filterKnown;
 173
 174         //! Controls if the result of filter-hits should be inverted
 175         bool            m_invert;
 176
 177         //! Specifies if filtering should be used
 178         bool            m_filterEnabled;
 179
 180         /**
 181          * Returns true if the filename is filtered.
 182          */
 183         bool    IsFiltered(const CSearchFile* file);
 184
 185         /**
 186          * Sorter function used by wxListCtrl::SortItems function.
 187          *
 188          * @see CMuleListCtrl::SetSortFunc
 189          * @see wxListCtrl::SortItems
 190          */
 191         static int wxCALLBACK SortProc(wxUIntPtr item1, wxUIntPtr item2, long sortData);
 192
 193         /** @see CMuleListCtrl::AltSortAllowed */
 194         virtual bool AltSortAllowed(unsigned column) const;
 195
 196         /** @see CMuleListCtrl::GetTTSText */
 197         virtual wxString GetTTSText(unsigned item) const;
 198
 199         /**
 200          * Helper function which syncs two lists.
 201          *
 202          * @param src The source list.
 203          * @param dst The list to be synced with the source list.
 204          *
 205          * This function syncronises the following settings of two lists:
 206          *  - Sort column
 207          *  - Sort direction
 208          *  - Column widths
 209          *
 210          * If either sort column or direction is changed, then the dst list will
 211          * be resorted. This function is used to ensure that all results list act
 212          * as one, while still allowing individual selection.
 213          */
 214         static void SyncLists( CSearchListCtrl* src, CSearchListCtrl* dst );
 215
 216         /**
 217          * Helper function which syncs all other lists against the specified one.
 218          *
 219          * @param src The list which all other lists should be synced against.
 220          *
 221          * This function just calls SyncLists() on all lists in s_lists, using
 222          * the src argument as the src argument of the SyncLists function.
 223          */
 224         static void SyncOtherLists( CSearchListCtrl* src );
 225
 226         //! This list contains pointers to all current instances of CSearchListCtrl.
 227         static std::list<CSearchListCtrl*> s_lists;
 228
 229         //! The ID of the search-results which the list is displaying or zero if unset.
 230         wxUIntPtr m_nResultsID;
 231
 232         //! Custom drawing, needed to display children of search-results.
 233         void OnDrawItem(int item, wxDC* dc, const wxRect& rect, const wxRect& rectHL, bool highlighted);
 234
 235         /**
 236          * Removes or adds child-entries for the given file.
 237          */
 238         void ShowChildren(CSearchFile* file, bool show);
 239
 240         /**
 241          * Event handler for right mouse clicks.
 242          */
 243         void OnRightClick( wxListEvent& event );
 244
 245         /**
 246          * Event handler for double-clicks or enter.
 247          */
 248         void OnItemActivated( wxListEvent& event );
 249
 250         /**
 251          * Event handler for left-clicks on the column headers.
 252          *
 253          * This eventhandler takes care of sync'ing all the other lists with this one.
 254          */
 255         void OnColumnLClick( wxListEvent& event );
 256
 257         /**
 258          * Event handler for resizing of the columns.
 259          *
 260          * This eventhandler takes care of sync'ing all the other lists with this one.
 261          */
 262         void OnColumnResize( wxListEvent& event );
 263
 264         /**
 265          * Event handler for get-url menu items.
 266          */
 267         void OnPopupGetUrl( wxCommandEvent& event );
 268
 269         /**
 270          * Event handler for Razorback 2 stats menu items.
 271          */
 272         void OnRazorStatsCheck( wxCommandEvent& event );
 273
 274         /**
 275          * Event handler for related search.
 276          */
 277         void OnRelatedSearch( wxCommandEvent& event );
 278
 279         /**
 280          * Event handler for "mark as known".
 281          */
 282         void OnMarkAsKnown( wxCommandEvent& event );
 283
 284         /**
 285          * Event handler for download-file(s) menu item.
 286          */
 287         void OnPopupDownload( wxCommandEvent& event );
 288
 289         DECLARE_EVENT_TABLE()
 290 };
 291
 292 #endif // SEARCHLISTCTRL_H
 293 // File_checked_for_headers