src/MuleNotebook.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-2011 Angel Vidal ( kry@amule.org )
   5 // Copyright (c) 2004-2011 aMule Team ( admin@amule.org / http://www.amule.org )
   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 #include <wx/menu.h>
  27 #include <wx/intl.h>
  28
  29 #include "MuleNotebook.h"       // Interface declarations
  30
  31 #include <common/MenuIDs.h>
  32
  33 DEFINE_LOCAL_EVENT_TYPE(wxEVT_COMMAND_MULENOTEBOOK_PAGE_CLOSING)
  34 DEFINE_LOCAL_EVENT_TYPE(wxEVT_COMMAND_MULENOTEBOOK_ALL_PAGES_CLOSED)
  35
  36 BEGIN_EVENT_TABLE(CMuleNotebook, wxNotebook)
  37         EVT_RIGHT_DOWN(CMuleNotebook::OnRMButton)
  38
  39         EVT_MENU(MP_CLOSE_TAB,          CMuleNotebook::OnPopupClose)
  40         EVT_MENU(MP_CLOSE_ALL_TABS,     CMuleNotebook::OnPopupCloseAll)
  41         EVT_MENU(MP_CLOSE_OTHER_TABS,   CMuleNotebook::OnPopupCloseOthers)
  42
  43         // Madcat - tab closing engine
  44         EVT_LEFT_UP(CMuleNotebook::OnMouseButtonRelease)
  45         EVT_MIDDLE_UP(CMuleNotebook::OnMouseButtonRelease)
  46         EVT_MOTION(CMuleNotebook::OnMouseMotion)
  47 END_EVENT_TABLE()
  48
  49 CMuleNotebook::CMuleNotebook( wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style, const wxString& name )
  50         : wxNotebook(parent, id, pos, size, style, name)
  51 {
  52         m_popup_enable = true;
  53         m_popup_widget = NULL;
  54 }
  55
  56
  57 CMuleNotebook::~CMuleNotebook()
  58 {
  59         // Ensure that all notifications gets sent
  60         DeleteAllPages();
  61 }
  62
  63
  64 bool CMuleNotebook::DeletePage(int nPage)
  65 {
  66         wxCHECK_MSG((nPage >= 0) && (nPage < (int)GetPageCount()), false,
  67                 wxT("Trying to delete invalid page-index in CMuleNotebook::DeletePage"));
  68
  69         // Send out close event
  70         wxNotebookEvent evt( wxEVT_COMMAND_MULENOTEBOOK_PAGE_CLOSING, GetId(), nPage );
  71         evt.SetEventObject(this);
  72         ProcessEvent( evt );
  73
  74         // and finally remove the actual page
  75         bool result = wxNotebook::DeletePage( nPage );
  76
  77         // Ensure a valid selection
  78         if ( GetPageCount() && (int)GetSelection() >= (int)GetPageCount() ) {
  79                 SetSelection( GetPageCount() - 1 );
  80         }
  81
  82         // Send a page change event to work around wx problem when newly selected page
  83         // is identical with deleted page (wx sends a page change event during deletion,
  84         // but the control is still the one to be deleted at that moment).
  85         if (GetPageCount()) {
  86                 // Select the tab that took the place of the one we just deleted.
  87                 size_t page = nPage;
  88                 // Except if we deleted the last one - then select the one that is last now.
  89                 if (page == GetPageCount()) {
  90                         page--;
  91                 }
  92                 wxNotebookEvent event( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, GetId(), page );
  93                 event.SetEventObject(this);
  94                 ProcessEvent( event );
  95         } else {
  96         // Send an event when no pages are left open
  97                 wxNotebookEvent event( wxEVT_COMMAND_MULENOTEBOOK_ALL_PAGES_CLOSED, GetId() );
  98                 event.SetEventObject(this);
  99                 ProcessEvent( event );
 100         }
 101
 102         return result;
 103 }
 104
 105
 106 bool CMuleNotebook::DeleteAllPages()
 107 {
 108         Freeze();
 109
 110         bool result = true;
 111         while ( GetPageCount() ) {
 112                 result &= DeletePage( 0 );
 113         }
 114
 115         Thaw();
 116
 117         return result;
 118 }
 119
 120
 121 void CMuleNotebook::EnablePopup( bool enable )
 122 {
 123         m_popup_enable = enable;
 124 }
 125
 126
 127 void CMuleNotebook::SetPopupHandler( wxWindow* widget )
 128 {
 129         m_popup_widget = widget;
 130 }
 131
 132
 133 //#warning wxMac does not support selection by right-clicking on tabs!
 134 void CMuleNotebook::OnRMButton(wxMouseEvent& event)
 135 {
 136         // Cases where we shouldn't be showing a popup-menu.
 137         if ( !GetPageCount() || !m_popup_enable ) {
 138                 event.Skip();
 139                 return;
 140         }
 141
 142
 143 // For some reason, gtk1 does a rather poor job when using the HitTest
 144         wxPoint eventPoint = event.GetPosition();
 145
 146         int tab = HitTest(eventPoint);
 147         if (tab != wxNOT_FOUND) {
 148                 SetSelection(tab);
 149         } else {
 150                 event.Skip();
 151                 return;
 152         }
 153
 154         // Should we send the event to a specific widget?
 155         if ( m_popup_widget ) {
 156                 wxMouseEvent evt = event;
 157
 158                 // Map the coordinates onto the parent
 159                 wxPoint point = evt.GetPosition();
 160                 point = ClientToScreen( point );
 161                 point = m_popup_widget->ScreenToClient( point );
 162
 163                 evt.m_x = point.x;
 164                 evt.m_y = point.y;
 165
 166                 m_popup_widget->GetEventHandler()->AddPendingEvent( evt );
 167         } else {
 168                 wxMenu menu(_("Close"));
 169                 menu.Append(MP_CLOSE_TAB, wxString(_("Close tab")));
 170                 menu.Append(MP_CLOSE_ALL_TABS, wxString(_("Close all tabs")));
 171                 menu.Append(MP_CLOSE_OTHER_TABS, wxString(_("Close other tabs")));
 172
 173                 PopupMenu( &menu, event.GetPosition() );
 174         }
 175 }
 176
 177
 178 void CMuleNotebook::OnPopupClose(wxCommandEvent& WXUNUSED(evt))
 179 {
 180         DeletePage( GetSelection() );
 181 }
 182
 183
 184 void CMuleNotebook::OnPopupCloseAll(wxCommandEvent& WXUNUSED(evt))
 185 {
 186         DeleteAllPages();
 187 }
 188
 189
 190 void CMuleNotebook::OnPopupCloseOthers(wxCommandEvent& WXUNUSED(evt))
 191 {
 192         wxNotebookPage* current = GetPage( GetSelection() );
 193
 194         for ( int i = GetPageCount() - 1; i >= 0; i-- ) {
 195                 if ( current != GetPage( i ) )
 196                         DeletePage( i );
 197         }
 198 }
 199
 200
 201 void CMuleNotebook::OnMouseButtonRelease(wxMouseEvent &event)
 202 {
 203
 204         if (GetImageList() == NULL) {
 205                 // This Mulenotebook has no images on tabs, so nothing to do.
 206                 event.Skip();
 207                 return;
 208         }
 209
 210         long xpos, ypos;
 211         event.GetPosition(&xpos, &ypos);
 212
 213         long flags = 0;
 214         int tab = HitTest(wxPoint(xpos,ypos),&flags);
 215
 216         if ((tab != -1) &&  (((flags == wxNB_HITTEST_ONICON) && event.LeftUp()) ||
 217                         ((flags == wxNB_HITTEST_ONLABEL) && event.MiddleUp()))) {
 218                 // User did click on a 'x' or middle click on the label
 219                 DeletePage(tab);
 220         } else {
 221                 // Is not a 'x'. Send this event up.
 222                 event.Skip();
 223         }
 224
 225 }
 226
 227 void CMuleNotebook::OnMouseMotion(wxMouseEvent &event)
 228 {
 229
 230         if (GetImageList() == NULL) {
 231                 // This Mulenotebook has no images on tabs, so nothing to do.
 232                 event.Skip();
 233                 return;
 234         }
 235
 236         long flags = 0;
 237         int tab = HitTest(wxPoint(event.m_x,event.m_y),&flags);
 238
 239         // Clear the highlight for all tabs.
 240         for (int i=0;i<(int)GetPageCount();++i) {
 241                 SetPageImage(i, 0);
 242         }
 243
 244         if ((tab != -1) &&  (flags == wxNB_HITTEST_ONICON)) {
 245                 // Mouse is over a 'x'
 246                 SetPageImage(tab, 1);
 247         } else {
 248                 // Is not a 'x'. Send this event up.
 249                 event.Skip();
 250         }
 251
 252 }
 253
 254 // File_checked_for_headers