git.saurik.com Git - wxWidgets.git/blob

1 /////////////////////////////////////////////////////////////////////////////

2 // Name: src/common/event.cpp

3 // Purpose: Event classes

4 // Author: Julian Smart

5 // Modified by:

6 // Created: 01/02/97

7 // Copyright: (c) Julian Smart

8 // Licence: wxWindows licence

9 /////////////////////////////////////////////////////////////////////////////

11 // ============================================================================

12 // declarations

13 // ============================================================================

15 // ----------------------------------------------------------------------------

16 // headers

17 // ----------------------------------------------------------------------------

19 // For compilers that support precompilation, includes "wx.h".

20 #include "wx/wxprec.h"

22 #ifdef __BORLANDC__

23 #pragma hdrstop

24 #endif

26 #include "wx/event.h"

27 #include "wx/eventfilter.h"

28 #include "wx/evtloop.h"

30 #ifndef WX_PRECOMP

31 #include "wx/list.h"

32 #include "wx/log.h"

33 #include "wx/app.h"

34 #include "wx/utils.h"

35 #include "wx/stopwatch.h"

36 #include "wx/module.h"

38 #if wxUSE_GUI

39 #include "wx/window.h"

40 #include "wx/control.h"

41 #include "wx/dc.h"

42 #include "wx/spinbutt.h"

43 #include "wx/textctrl.h"

44 #include "wx/validate.h"

45 #endif // wxUSE_GUI

46 #endif

48 #include "wx/thread.h"

50 #if wxUSE_BASE

51 #include "wx/scopedptr.h"

53 wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)

54 wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)

55 #endif // wxUSE_BASE

57 // ----------------------------------------------------------------------------

58 // wxWin macros

59 // ----------------------------------------------------------------------------

61 #if wxUSE_BASE

62 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)

63 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)

64 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)

65 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxEvent)

66 #endif // wxUSE_BASE

68 #if wxUSE_GUI

69 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)

70 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)

71 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)

72 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)

73 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)

74 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)

75 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)

76 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)

77 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)

78 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)

79 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)

80 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)

81 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)

82 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)

83 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)

84 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)

85 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)

86 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)

87 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)

88 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)

89 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)

90 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)

91 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)

92 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)

93 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)

94 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)

95 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)

96 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)

97 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)

98 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)

99 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)

100 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)

101 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)

102 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)

103 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)

104 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)

105 #endif // wxUSE_GUI

106

107 #if wxUSE_BASE

108

 const wxEventTable *wxEvtHandler::GetEventTable() const

     { return &wxEvtHandler::sm_eventTable; }

111

112 const wxEventTable wxEvtHandler::sm_eventTable =

     { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };

114

 wxEventHashTable &wxEvtHandler::GetEventHashTable() const

     { return wxEvtHandler::sm_eventHashTable; }

117

 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);

119

120 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =

121 { wxDECLARE_EVENT_TABLE_TERMINATOR() };

122

123

124 // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors

125 // leaked, so we need to manually clean up all event tables before checking for

126 // the memory leaks when using it, however this breaks re-initializing the

127 // library (i.e. repeated calls to wxInitialize/wxUninitialize) because the

128 // event tables won't be rebuilt the next time, so disable this by default

129 #if wxUSE_MEMORY_TRACING

130

131 class wxEventTableEntryModule: public wxModule

132 {

133 public:

134 wxEventTableEntryModule() { }

     virtual bool OnInit() { return true; }

     virtual void OnExit() { wxEventHashTable::ClearAll(); }

137

138 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)

139 };

140

141 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)

142

143 #endif // wxUSE_MEMORY_TRACING

144

145 // ----------------------------------------------------------------------------

146 // global variables

147 // ----------------------------------------------------------------------------

148

149 // common event types are defined here, other event types are defined by the

150 // components which use them

151

152 const wxEventType wxEVT_FIRST = 10000;

 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;

154 const wxEventType wxEVT_NULL = wxNewEventType();

155

156 wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent );

157

158 // Thread and asynchronous call events

159 wxDEFINE_EVENT( wxEVT_THREAD, wxThreadEvent );

160 wxDEFINE_EVENT( wxEVT_ASYNC_METHOD_CALL, wxAsyncMethodCallEvent );

161

162 #endif // wxUSE_BASE

163

164 #if wxUSE_GUI

165

166 wxDEFINE_EVENT( wxEVT_BUTTON, wxCommandEvent );

167 wxDEFINE_EVENT( wxEVT_CHECKBOX, wxCommandEvent );

168 wxDEFINE_EVENT( wxEVT_CHOICE, wxCommandEvent );

169 wxDEFINE_EVENT( wxEVT_LISTBOX, wxCommandEvent );

170 wxDEFINE_EVENT( wxEVT_LISTBOX_DCLICK, wxCommandEvent );

171 wxDEFINE_EVENT( wxEVT_CHECKLISTBOX, wxCommandEvent );

172 wxDEFINE_EVENT( wxEVT_MENU, wxCommandEvent );

173 wxDEFINE_EVENT( wxEVT_SLIDER, wxCommandEvent );

174 wxDEFINE_EVENT( wxEVT_RADIOBOX, wxCommandEvent );

175 wxDEFINE_EVENT( wxEVT_RADIOBUTTON, wxCommandEvent );

176 wxDEFINE_EVENT( wxEVT_SCROLLBAR, wxCommandEvent );

177 wxDEFINE_EVENT( wxEVT_VLBOX, wxCommandEvent );

178 wxDEFINE_EVENT( wxEVT_COMBOBOX, wxCommandEvent );

179 wxDEFINE_EVENT( wxEVT_TOOL_RCLICKED, wxCommandEvent );

180 wxDEFINE_EVENT( wxEVT_TOOL_ENTER, wxCommandEvent );

181 wxDEFINE_EVENT( wxEVT_SPINCTRL, wxCommandEvent );

182 wxDEFINE_EVENT( wxEVT_SPINCTRLDOUBLE, wxCommandEvent );

183 wxDEFINE_EVENT( wxEVT_TOOL_DROPDOWN, wxCommandEvent );

184 wxDEFINE_EVENT( wxEVT_COMBOBOX_DROPDOWN, wxCommandEvent);

185 wxDEFINE_EVENT( wxEVT_COMBOBOX_CLOSEUP, wxCommandEvent);

186

187 // Mouse event types

188 wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent );

189 wxDEFINE_EVENT( wxEVT_LEFT_UP, wxMouseEvent );

190 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN, wxMouseEvent );

191 wxDEFINE_EVENT( wxEVT_MIDDLE_UP, wxMouseEvent );

192 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN, wxMouseEvent );

193 wxDEFINE_EVENT( wxEVT_RIGHT_UP, wxMouseEvent );

194 wxDEFINE_EVENT( wxEVT_MOTION, wxMouseEvent );

195 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW, wxMouseEvent );

196 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW, wxMouseEvent );

197 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK, wxMouseEvent );

198 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK, wxMouseEvent );

199 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK, wxMouseEvent );

200 wxDEFINE_EVENT( wxEVT_SET_FOCUS, wxFocusEvent );

201 wxDEFINE_EVENT( wxEVT_KILL_FOCUS, wxFocusEvent );

202 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS, wxChildFocusEvent );

203 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL, wxMouseEvent );

204 wxDEFINE_EVENT( wxEVT_AUX1_DOWN, wxMouseEvent );

205 wxDEFINE_EVENT( wxEVT_AUX1_UP, wxMouseEvent );

206 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK, wxMouseEvent );

207 wxDEFINE_EVENT( wxEVT_AUX2_DOWN, wxMouseEvent );

208 wxDEFINE_EVENT( wxEVT_AUX2_UP, wxMouseEvent );

209 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent );

210

211 // Character input event type

212 wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent );

213 wxDEFINE_EVENT( wxEVT_AFTER_CHAR, wxKeyEvent );

214 wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent );

215 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent );

216 wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent );

217 wxDEFINE_EVENT( wxEVT_KEY_UP, wxKeyEvent );

218 #if wxUSE_HOTKEY

219 wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent );

220 #endif

221

222 // Set cursor event

223 wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent );

224

225 // wxScrollbar and wxSlider event identifiers

226 wxDEFINE_EVENT( wxEVT_SCROLL_TOP, wxScrollEvent );

227 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM, wxScrollEvent );

228 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP, wxScrollEvent );

229 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN, wxScrollEvent );

230 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP, wxScrollEvent );

231 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN, wxScrollEvent );

232 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK, wxScrollEvent );

233 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent );

234 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED, wxScrollEvent );

235

236 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of

237 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But

238 // with the type-safe events in place, these event types are associated with

239 // wxScrollEvent. To allow handling of spin events, new event types have been

240 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility

241 // the spin event types are being initialized with the scroll event types.

242

243 #if wxUSE_SPINBTN

244

 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP,   wxSpinEvent, wxEVT_SCROLL_LINEUP );

 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN, wxSpinEvent, wxEVT_SCROLL_LINEDOWN );

 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN,      wxSpinEvent, wxEVT_SCROLL_THUMBTRACK );

248

249 #endif // wxUSE_SPINBTN

250

251 // Scroll events from wxWindow

252 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP, wxScrollWinEvent );

253 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent );

254 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent );

255 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent );

256 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent );

257 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent );

258 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent );

259 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent );

260

261 // System events

262 wxDEFINE_EVENT( wxEVT_SIZE, wxSizeEvent );

263 wxDEFINE_EVENT( wxEVT_SIZING, wxSizeEvent );

264 wxDEFINE_EVENT( wxEVT_MOVE, wxMoveEvent );

265 wxDEFINE_EVENT( wxEVT_MOVING, wxMoveEvent );

266 wxDEFINE_EVENT( wxEVT_MOVE_START, wxMoveEvent );

267 wxDEFINE_EVENT( wxEVT_MOVE_END, wxMoveEvent );

268 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW, wxCloseEvent );

269 wxDEFINE_EVENT( wxEVT_END_SESSION, wxCloseEvent );

270 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION, wxCloseEvent );

271 wxDEFINE_EVENT( wxEVT_HIBERNATE, wxActivateEvent );

272 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP, wxActivateEvent );

273 wxDEFINE_EVENT( wxEVT_ACTIVATE, wxActivateEvent );

274 wxDEFINE_EVENT( wxEVT_CREATE, wxWindowCreateEvent );

275 wxDEFINE_EVENT( wxEVT_DESTROY, wxWindowDestroyEvent );

276 wxDEFINE_EVENT( wxEVT_SHOW, wxShowEvent );

277 wxDEFINE_EVENT( wxEVT_ICONIZE, wxIconizeEvent );

278 wxDEFINE_EVENT( wxEVT_MAXIMIZE, wxMaximizeEvent );

279 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent );

280 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent );

281 wxDEFINE_EVENT( wxEVT_PAINT, wxPaintEvent );

282 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND, wxEraseEvent );

283 wxDEFINE_EVENT( wxEVT_NC_PAINT, wxNcPaintEvent );

284 wxDEFINE_EVENT( wxEVT_MENU_OPEN, wxMenuEvent );

285 wxDEFINE_EVENT( wxEVT_MENU_CLOSE, wxMenuEvent );

286 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT, wxMenuEvent );

287 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU, wxContextMenuEvent );

288 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent );

289 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent );

290 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent );

291 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent );

292 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent );

293 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP, wxJoystickEvent );

294 wxDEFINE_EVENT( wxEVT_JOY_MOVE, wxJoystickEvent );

295 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE, wxJoystickEvent );

296 wxDEFINE_EVENT( wxEVT_DROP_FILES, wxDropFilesEvent );

297 wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent );

298 wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent );

299

300 // Clipboard events

301 wxDEFINE_EVENT( wxEVT_TEXT_COPY, wxClipboardTextEvent );

302 wxDEFINE_EVENT( wxEVT_TEXT_CUT, wxClipboardTextEvent );

303 wxDEFINE_EVENT( wxEVT_TEXT_PASTE, wxClipboardTextEvent );

304

305 // Generic command events

306 // Note: a click is a higher-level event than button down/up

307 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent );

308 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent );

309 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent );

310 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent );

311 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS, wxCommandEvent );

312 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent );

313 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent );

314

315 // Help events

316 wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent );

317 wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent );

318

319 #endif // wxUSE_GUI

320

321 #if wxUSE_BASE

322

323 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;

324

325 // ============================================================================

326 // implementation

327 // ============================================================================

328

329 // ----------------------------------------------------------------------------

330 // event initialization

331 // ----------------------------------------------------------------------------

332

333 int wxNewEventType()

334 {

335 // MT-FIXME

336 static int s_lastUsedEventType = wxEVT_FIRST;

337

338 return s_lastUsedEventType++;

339 }

340 // ----------------------------------------------------------------------------

341 // wxEventFunctor

342 // ----------------------------------------------------------------------------

343

344 wxEventFunctor::~wxEventFunctor()

345 {

346 }

347

348 // ----------------------------------------------------------------------------

349 // wxEvent

350 // ----------------------------------------------------------------------------

351

352 /*

353 * General wxWidgets events, covering all interesting things that might happen

354 * (button clicking, resizing, setting text in widgets, etc.).

355 *

356 * For each completely new event type, derive a new event class.

357 *

358 */

359

 wxEvent::wxEvent(int theId, wxEventType commandType)

361 {

362 m_eventType = commandType;

363 m_eventObject = NULL;

364 m_timeStamp = 0;

365 m_id = theId;

366 m_skipped = false;

367 m_callbackUserData = NULL;

368 m_handlerToProcessOnlyIn = NULL;

369 m_isCommandEvent = false;

370 m_propagationLevel = wxEVENT_PROPAGATE_NONE;

371 m_propagatedFrom = NULL;

372 m_wasProcessed = false;

373 m_willBeProcessedAgain = false;

374 }

375

 wxEvent::wxEvent(const wxEvent& src)

377 : wxObject(src)

     , m_eventObject(src.m_eventObject)

     , m_eventType(src.m_eventType)

     , m_timeStamp(src.m_timeStamp)

     , m_id(src.m_id)

     , m_callbackUserData(src.m_callbackUserData)

383 , m_handlerToProcessOnlyIn(NULL)

     , m_propagationLevel(src.m_propagationLevel)

385 , m_propagatedFrom(NULL)

     , m_skipped(src.m_skipped)

     , m_isCommandEvent(src.m_isCommandEvent)

     , m_wasProcessed(false)

     , m_willBeProcessedAgain(false)

390 {

391 }

392

 wxEvent& wxEvent::operator=(const wxEvent& src)

394 {

     wxObject::operator=(src);

396

397 m_eventObject = src.m_eventObject;

398 m_eventType = src.m_eventType;

399 m_timeStamp = src.m_timeStamp;

400 m_id = src.m_id;

401 m_callbackUserData = src.m_callbackUserData;

402 m_handlerToProcessOnlyIn = NULL;

403 m_propagationLevel = src.m_propagationLevel;

404 m_propagatedFrom = NULL;

405 m_skipped = src.m_skipped;

406 m_isCommandEvent = src.m_isCommandEvent;

407

408 // don't change m_wasProcessed

409

410 // While the original again could be passed to another handler, this one

411 // isn't going to be processed anywhere else by default.

412 m_willBeProcessedAgain = false;

413

414 return *this;

415 }

416

417 #endif // wxUSE_BASE

418

419 #if wxUSE_GUI

420

421 // ----------------------------------------------------------------------------

422 // wxCommandEvent

423 // ----------------------------------------------------------------------------

424

 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)

               : wxEvent(theId, commandType)

427 {

428 m_clientData = NULL;

429 m_clientObject = NULL;

430 m_isCommandEvent = true;

431

432 // the command events are propagated upwards by default

433 m_propagationLevel = wxEVENT_PROPAGATE_MAX;

434 }

435

 wxString wxCommandEvent::GetString() const

437 {

     if (m_eventType != wxEVT_TEXT || !m_eventObject)

439 {

440 return m_cmdString;

441 }

442 else

443 {

444 #if wxUSE_TEXTCTRL

         wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);

446 if ( txt )

447 return txt->GetValue();

448 else

449 #endif // wxUSE_TEXTCTRL

450 return m_cmdString;

451 }

452 }

453

454 // ----------------------------------------------------------------------------

455 // wxUpdateUIEvent

456 // ----------------------------------------------------------------------------

457

458 #if wxUSE_LONGLONG

 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;

460 #endif

461

 long wxUpdateUIEvent::sm_updateInterval = 0;

463

464 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;

465

466 // Can we update?

 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)

468 {

469 // Don't update if we've switched global updating off

470 // and this window doesn't support updates.

471 if (win &&

472 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&

        ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))

474 return false;

475

476 // Don't update children of the hidden windows: this is useless as any

477 // change to their state won't be seen by the user anyhow. Notice that this

478 // argument doesn't apply to the hidden windows (with visible parent)

479 // themselves as they could be shown by their EVT_UPDATE_UI handler.

     if ( win->GetParent() && !win->GetParent()->IsShownOnScreen() )

481 return false;

482

     if (sm_updateInterval == -1)

484 return false;

485

     if (sm_updateInterval == 0)

487 return true;

488

489 #if wxUSE_STOPWATCH && wxUSE_LONGLONG

490 wxLongLong now = wxGetLocalTimeMillis();

     if (now > (sm_lastUpdate + sm_updateInterval))

492 {

493 return true;

494 }

495

496 return false;

497 #else

498 // If we don't have wxStopWatch or wxLongLong, we

499 // should err on the safe side and update now anyway.

500 return true;

501 #endif

502 }

503

504 // Reset the update time to provide a delay until the next

505 // time we should update

 void wxUpdateUIEvent::ResetUpdateTime()

507 {

508 #if wxUSE_STOPWATCH && wxUSE_LONGLONG

     if (sm_updateInterval > 0)

510 {

511 wxLongLong now = wxGetLocalTimeMillis();

         if (now > (sm_lastUpdate + sm_updateInterval))

513 {

514 sm_lastUpdate = now;

515 }

516 }

517 #endif

518 }

519

520 // ----------------------------------------------------------------------------

521 // wxScrollEvent

522 // ----------------------------------------------------------------------------

523

 wxScrollEvent::wxScrollEvent(wxEventType commandType,

525 int id,

526 int pos,

527 int orient)

     : wxCommandEvent(commandType, id)

529 {

530 m_extraLong = orient;

531 m_commandInt = pos;

532 }

533

534 // ----------------------------------------------------------------------------

535 // wxScrollWinEvent

536 // ----------------------------------------------------------------------------

537

 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,

539 int pos,

540 int orient)

541 {

542 m_eventType = commandType;

543 m_extraLong = orient;

544 m_commandInt = pos;

545 }

546

547 // ----------------------------------------------------------------------------

548 // wxMouseEvent

549 // ----------------------------------------------------------------------------

550

 wxMouseEvent::wxMouseEvent(wxEventType commandType)

552 {

553 m_eventType = commandType;

554

555 m_x = 0;

556 m_y = 0;

557

558 m_leftDown = false;

559 m_middleDown = false;

560 m_rightDown = false;

561 m_aux1Down = false;

562 m_aux2Down = false;

563

564 m_clickCount = -1;

565

566 m_wheelAxis = wxMOUSE_WHEEL_VERTICAL;

567 m_wheelRotation = 0;

568 m_wheelDelta = 0;

569 m_linesPerAction = 0;

570 m_columnsPerAction = 0;

571 }

572

 void wxMouseEvent::Assign(const wxMouseEvent& event)

574 {

     wxEvent::operator=(event);

576

577 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly

578 // defined operator=() so need to do it this way:

     *static_cast<wxMouseState *>(this) = event;

580

581 m_x = event.m_x;

582 m_y = event.m_y;

583

584 m_leftDown = event.m_leftDown;

585 m_middleDown = event.m_middleDown;

586 m_rightDown = event.m_rightDown;

587 m_aux1Down = event.m_aux1Down;

588 m_aux2Down = event.m_aux2Down;

589

590 m_wheelRotation = event.m_wheelRotation;

591 m_wheelDelta = event.m_wheelDelta;

592 m_linesPerAction = event.m_linesPerAction;

593 m_columnsPerAction = event.m_columnsPerAction;

594 m_wheelAxis = event.m_wheelAxis;

595 }

596

597 // return true if was a button dclick event

 bool wxMouseEvent::ButtonDClick(int but) const

599 {

600 switch (but)

601 {

602 default:

             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));

604 // fall through

605

606 case wxMOUSE_BTN_ANY:

             return (LeftDClick() || MiddleDClick() || RightDClick() ||

608 Aux1DClick() || Aux2DClick());

609

610 case wxMOUSE_BTN_LEFT:

611 return LeftDClick();

612

613 case wxMOUSE_BTN_MIDDLE:

614 return MiddleDClick();

615

616 case wxMOUSE_BTN_RIGHT:

617 return RightDClick();

618

619 case wxMOUSE_BTN_AUX1:

620 return Aux1DClick();

621

622 case wxMOUSE_BTN_AUX2:

623 return Aux2DClick();

624 }

625 }

626

627 // return true if was a button down event

 bool wxMouseEvent::ButtonDown(int but) const

629 {

630 switch (but)

631 {

632 default:

             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));

634 // fall through

635

636 case wxMOUSE_BTN_ANY:

             return (LeftDown() || MiddleDown() || RightDown() ||

638 Aux1Down() || Aux2Down());

639

640 case wxMOUSE_BTN_LEFT:

641 return LeftDown();

642

643 case wxMOUSE_BTN_MIDDLE:

644 return MiddleDown();

645

646 case wxMOUSE_BTN_RIGHT:

647 return RightDown();

648

649 case wxMOUSE_BTN_AUX1:

650 return Aux1Down();

651

652 case wxMOUSE_BTN_AUX2:

653 return Aux2Down();

654 }

655 }

656

657 // return true if was a button up event

 bool wxMouseEvent::ButtonUp(int but) const

659 {

660 switch (but)

661 {

662 default:

             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));

664 // fall through

665

666 case wxMOUSE_BTN_ANY:

             return (LeftUp() || MiddleUp() || RightUp() ||

668 Aux1Up() || Aux2Up());

669

670 case wxMOUSE_BTN_LEFT:

671 return LeftUp();

672

673 case wxMOUSE_BTN_MIDDLE:

674 return MiddleUp();

675

676 case wxMOUSE_BTN_RIGHT:

677 return RightUp();

678

679 case wxMOUSE_BTN_AUX1:

680 return Aux1Up();

681

682 case wxMOUSE_BTN_AUX2:

683 return Aux2Up();

684 }

685 }

686

687 // return true if the given button is currently changing state

 bool wxMouseEvent::Button(int but) const

689 {

690 switch (but)

691 {

692 default:

             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));

694 // fall through

695

696 case wxMOUSE_BTN_ANY:

697 return ButtonUp(wxMOUSE_BTN_ANY) ||

698 ButtonDown(wxMOUSE_BTN_ANY) ||

699 ButtonDClick(wxMOUSE_BTN_ANY);

700

701 case wxMOUSE_BTN_LEFT:

             return LeftDown() || LeftUp() || LeftDClick();

703

704 case wxMOUSE_BTN_MIDDLE:

             return MiddleDown() || MiddleUp() || MiddleDClick();

706

707 case wxMOUSE_BTN_RIGHT:

             return RightDown() || RightUp() || RightDClick();

709

710 case wxMOUSE_BTN_AUX1:

            return Aux1Down() || Aux1Up() || Aux1DClick();

712

713 case wxMOUSE_BTN_AUX2:

            return Aux2Down() || Aux2Up() || Aux2DClick();

715 }

716 }

717

 int wxMouseEvent::GetButton() const

719 {

     for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )

721 {

         if ( Button(i) )

723 {

724 return i;

725 }

726 }

727

728 return wxMOUSE_BTN_NONE;

729 }

730

731 // Find the logical position of the event given the DC

 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const

733 {

     wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));

735 return pt;

736 }

737

738 // ----------------------------------------------------------------------------

739 // wxKeyEvent

740 // ----------------------------------------------------------------------------

741

 wxKeyEvent::wxKeyEvent(wxEventType type)

743 {

744 m_eventType = type;

745 m_keyCode = WXK_NONE;

746 #if wxUSE_UNICODE

747 m_uniChar = WXK_NONE;

748 #endif

749

750 m_x =

751 m_y = wxDefaultCoord;

752 m_hasPosition = false;

753

754 InitPropagation();

755 }

756

 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)

758 : wxEvent(evt),

759 wxKeyboardState(evt)

760 {

761 DoAssignMembers(evt);

762

763 InitPropagation();

764 }

765

 wxKeyEvent::wxKeyEvent(wxEventType eventType, const wxKeyEvent& evt)

767 : wxEvent(evt),

768 wxKeyboardState(evt)

769 {

770 DoAssignMembers(evt);

771

772 m_eventType = eventType;

773

774 InitPropagation();

775 }

776

 void wxKeyEvent::InitPositionIfNecessary() const

778 {

779 if ( m_hasPosition )

780 return;

781

782 // We're const because we're called from const Get[XY]() methods but we

783 // need to update the "cached" values.

     wxKeyEvent& self = const_cast<wxKeyEvent&>(*this);

785 self.m_hasPosition = true;

786

787 // The only position we can possibly associate with the keyboard event on

788 // the platforms where it doesn't carry it already is the mouse position.

     wxGetMousePosition(&self.m_x, &self.m_y);

790

791 // If this event is associated with a window, the position should be in its

792 // client coordinates, but otherwise leave it in screen coordinates as what

793 // else can we use?

     wxWindow* const win = wxDynamicCast(GetEventObject(), wxWindow);

795 if ( win )

         win->ScreenToClient(&self.m_x, &self.m_y);

797 }

798

 wxCoord wxKeyEvent::GetX() const

800 {

801 InitPositionIfNecessary();

802

803 return m_x;

804 }

805

 wxCoord wxKeyEvent::GetY() const

807 {

808 InitPositionIfNecessary();

809

810 return m_y;

811 }

812

 bool wxKeyEvent::IsKeyInCategory(int category) const

814 {

815 switch ( GetKeyCode() )

816 {

817 case WXK_LEFT:

818 case WXK_RIGHT:

819 case WXK_UP:

820 case WXK_DOWN:

821 case WXK_NUMPAD_LEFT:

822 case WXK_NUMPAD_RIGHT:

823 case WXK_NUMPAD_UP:

824 case WXK_NUMPAD_DOWN:

             return (category & WXK_CATEGORY_ARROW) != 0;

826

827 case WXK_PAGEDOWN:

828 case WXK_END:

829 case WXK_NUMPAD_PAGEUP:

830 case WXK_NUMPAD_PAGEDOWN:

             return (category & WXK_CATEGORY_PAGING) != 0;

832

833 case WXK_HOME:

834 case WXK_PAGEUP:

835 case WXK_NUMPAD_HOME:

836 case WXK_NUMPAD_END:

             return (category & WXK_CATEGORY_JUMP) != 0;

838

839 case WXK_TAB:

840 case WXK_NUMPAD_TAB:

             return (category & WXK_CATEGORY_TAB) != 0;

842

843 case WXK_BACK:

844 case WXK_DELETE:

845 case WXK_NUMPAD_DELETE:

             return (category & WXK_CATEGORY_CUT) != 0;

847

848 default:

849 return false;

850 }

851 }

852

853 // ----------------------------------------------------------------------------

854 // wxWindowCreateEvent

855 // ----------------------------------------------------------------------------

856

 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)

858 {

859 SetEventType(wxEVT_CREATE);

860 SetEventObject(win);

861 }

862

863 // ----------------------------------------------------------------------------

864 // wxWindowDestroyEvent

865 // ----------------------------------------------------------------------------

866

 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)

868 {

869 SetEventType(wxEVT_DESTROY);

870 SetEventObject(win);

871 }

872

873 // ----------------------------------------------------------------------------

874 // wxChildFocusEvent

875 // ----------------------------------------------------------------------------

876

 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)

878 : wxCommandEvent(wxEVT_CHILD_FOCUS)

879 {

880 SetEventObject(win);

881 }

882

883 // ----------------------------------------------------------------------------

884 // wxHelpEvent

885 // ----------------------------------------------------------------------------

886

887 /* static */

 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)

889 {

890 if ( origin == Origin_Unknown )

891 {

892 // assume that the event comes from the help button if it's not from

893 // keyboard and that pressing F1 always results in the help event

         origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;

895 }

896

897 return origin;

898 }

899

900 #endif // wxUSE_GUI

901

902

903 #if wxUSE_BASE

904

905 // ----------------------------------------------------------------------------

906 // wxEventHashTable

907 // ----------------------------------------------------------------------------

908

 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...

910

 wxEventHashTable* wxEventHashTable::sm_first = NULL;

912

 wxEventHashTable::wxEventHashTable(const wxEventTable &table)

914 : m_table(table),

915 m_rebuildHash(true)

916 {

917 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);

918

919 m_next = sm_first;

920 if (m_next)

921 m_next->m_previous = this;

922 sm_first = this;

923 }

924

925 wxEventHashTable::~wxEventHashTable()

926 {

927 if (m_next)

928 m_next->m_previous = m_previous;

929 if (m_previous)

930 m_previous->m_next = m_next;

     if (sm_first == this)

932 sm_first = m_next;

933

934 Clear();

935 }

936

 void wxEventHashTable::Clear()

938 {

     for ( size_t i = 0; i < m_size; i++ )

940 {

941 EventTypeTablePointer eTTnode = m_eventTypeTable[i];

942 delete eTTnode;

943 }

944

945 wxDELETEA(m_eventTypeTable);

946

947 m_size = 0;

948 }

949

950 #if wxUSE_MEMORY_TRACING

951

952 // Clear all tables

 void wxEventHashTable::ClearAll()

954 {

955 wxEventHashTable* table = sm_first;

956 while (table)

957 {

958 table->Clear();

959 table = table->m_next;

960 }

961 }

962

963 #endif // wxUSE_MEMORY_TRACING

964

 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)

966 {

967 if (m_rebuildHash)

968 {

969 InitHashTable();

970 m_rebuildHash = false;

971 }

972

973 if (!m_eventTypeTable)

974 return false;

975

976 // Find all entries for the given event type.

977 wxEventType eventType = event.GetEventType();

     const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];

     if (eTTnode && eTTnode->eventType == eventType)

980 {

981 // Now start the search for an event handler

982 // that can handle an event with the given ID.

983 const wxEventTableEntryPointerArray&

984 eventEntryTable = eTTnode->eventEntryTable;

985

         const size_t count = eventEntryTable.GetCount();

         for (size_t n = 0; n < count; n++)

988 {

             const wxEventTableEntry& entry = *eventEntryTable[n];

             if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )

991 return true;

992 }

993 }

994

995 return false;

996 }

997

 void wxEventHashTable::InitHashTable()

999 {

1000 // Loop over the event tables and all its base tables.

1001 const wxEventTable *table = &m_table;

1002 while (table)

1003 {

1004 // Retrieve all valid event handler entries

         const wxEventTableEntry *entry = table->entries;

         while (entry->m_fn != 0)

1007 {

1008 // Add the event entry in the Hash.

1009 AddEntry(*entry);

1010

1011 entry++;

1012 }

1013

1014 table = table->baseTable;

1015 }

1016

1017 // Let's free some memory.

1018 size_t i;

     for(i = 0; i < m_size; i++)

1020 {

1021 EventTypeTablePointer eTTnode = m_eventTypeTable[i];

1022 if (eTTnode)

1023 {

1024 eTTnode->eventEntryTable.Shrink();

1025 }

1026 }

1027 }

1028

 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)

1030 {

1031 // This might happen 'accidentally' as the app is exiting

1032 if (!m_eventTypeTable)

1033 return;

1034

     EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];

1036 EventTypeTablePointer eTTnode = *peTTnode;

1037

1038 if (eTTnode)

1039 {

         if (eTTnode->eventType != entry.m_eventType)

1041 {

1042 // Resize the table!

1043 GrowEventTypeTable();

1044 // Try again to add it.

1045 AddEntry(entry);

1046 return;

1047 }

1048 }

1049 else

1050 {

1051 eTTnode = new EventTypeTable;

1052 eTTnode->eventType = entry.m_eventType;

1053 *peTTnode = eTTnode;

1054 }

1055

1056 // Fill all hash entries between entry.m_id and entry.m_lastId...

     eTTnode->eventEntryTable.Add(&entry);

1058 }

1059

 void wxEventHashTable::AllocEventTypeTable(size_t size)

1061 {

1062 m_eventTypeTable = new EventTypeTablePointer[size];

     memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);

1064 m_size = size;

1065 }

1066

 void wxEventHashTable::GrowEventTypeTable()

1068 {

1069 size_t oldSize = m_size;

1070 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;

1071

1072 // TODO: Search the most optimal grow sequence

     AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);

1074

     for ( size_t i = 0; i < oldSize; /* */ )

1076 {

1077 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];

1078 if (eTToldNode)

1079 {

             EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];

1081 EventTypeTablePointer eTTnode = *peTTnode;

1082

1083 // Check for collision, we don't want any.

1084 if (eTTnode)

1085 {

1086 GrowEventTypeTable();

1087 continue; // Don't increment the counter,

1088 // as we still need to add this element.

1089 }

1090 else

1091 {

1092 // Get the old value and put it in the new table.

1093 *peTTnode = oldEventTypeTable[i];

1094 }

1095 }

1096

1097 i++;

1098 }

1099

1100 delete[] oldEventTypeTable;

1101 }

1102

1103 // ----------------------------------------------------------------------------

1104 // wxEvtHandler

1105 // ----------------------------------------------------------------------------

1106

1107 wxEvtHandler::wxEvtHandler()

1108 {

1109 m_nextHandler = NULL;

1110 m_previousHandler = NULL;

1111 m_enabled = true;

1112 m_dynamicEvents = NULL;

1113 m_pendingEvents = NULL;

1114

1115 // no client data (yet)

1116 m_clientData = NULL;

1117 m_clientDataType = wxClientData_None;

1118 }

1119

1120 wxEvtHandler::~wxEvtHandler()

1121 {

1122 Unlink();

1123

1124 if (m_dynamicEvents)

1125 {

         for ( wxList::iterator it = m_dynamicEvents->begin(),

1127 end = m_dynamicEvents->end();

1128 it != end;

1129 ++it )

1130 {

1131 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;

1132

1133 // Remove ourselves from sink destructor notifications

1134 // (this has usually been done, in wxTrackable destructor)

             wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();

1136 if ( eventSink )

1137 {

1138 wxEventConnectionRef * const

1139 evtConnRef = FindRefInTrackerList(eventSink);

1140 if ( evtConnRef )

1141 {

1142 eventSink->RemoveNode(evtConnRef);

1143 delete evtConnRef;

1144 }

1145 }

1146

1147 delete entry->m_callbackUserData;

1148 delete entry;

1149 }

1150 delete m_dynamicEvents;

1151 }

1152

1153 // Remove us from the list of the pending events if necessary.

1154 if (wxTheApp)

         wxTheApp->RemovePendingEventHandler(this);

1156

1157 DeletePendingEvents();

1158

1159 // we only delete object data, not untyped

1160 if ( m_clientDataType == wxClientData_Object )

1161 delete m_clientObject;

1162 }

1163

 void wxEvtHandler::Unlink()

1165 {

1166 // this event handler must take itself out of the chain of handlers:

1167

1168 if (m_previousHandler)

1169 m_previousHandler->SetNextHandler(m_nextHandler);

1170

1171 if (m_nextHandler)

1172 m_nextHandler->SetPreviousHandler(m_previousHandler);

1173

1174 m_nextHandler = NULL;

1175 m_previousHandler = NULL;

1176 }

1177

 bool wxEvtHandler::IsUnlinked() const

1179 {

1180 return m_previousHandler == NULL &&

1181 m_nextHandler == NULL;

1182 }

1183

 wxEventFilter* wxEvtHandler::ms_filterList = NULL;

1185

 /* static */ void wxEvtHandler::AddFilter(wxEventFilter* filter)

1187 {

     wxCHECK_RET( filter, "NULL filter" );

1189

1190 filter->m_next = ms_filterList;

1191 ms_filterList = filter;

1192 }

1193

 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter* filter)

1195 {

1196 wxEventFilter* prev = NULL;

     for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )

1198 {

1199 if ( f == filter )

1200 {

1201 // Set the previous list element or the list head to the next

1202 // element.

1203 if ( prev )

1204 prev->m_next = f->m_next;

1205 else

1206 ms_filterList = f->m_next;

1207

1208 // Also reset the next pointer in the filter itself just to avoid

1209 // having possibly dangling pointers, even though it's not strictly

1210 // necessary.

1211 f->m_next = NULL;

1212

1213 // Skip the assert below.

1214 return;

1215 }

1216

1217 prev = f;

1218 }

1219

1220 wxFAIL_MSG( "Filter not found" );

1221 }

1222

1223 #if wxUSE_THREADS

1224

 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)

1226 {

1227 // check that we are really in a child thread

     wxASSERT_MSG( !wxThread::IsMain(),

1229 wxT("use ProcessEvent() in main thread") );

1230

1231 AddPendingEvent(event);

1232

1233 return true;

1234 }

1235

1236 #endif // wxUSE_THREADS

1237

 void wxEvtHandler::QueueEvent(wxEvent *event)

1239 {

     wxCHECK_RET( event, "NULL event can't be posted" );

1241

1242 if (!wxTheApp)

1243 {

1244 // we need an event loop which manages the list of event handlers with

1245 // pending events... cannot proceed without it!

1246 wxLogDebug("No application object! Cannot queue this event!");

1247

1248 // anyway delete the given event to avoid memory leaks

1249 delete event;

1250

1251 return;

1252 }

1253

1254 // 1) Add this event to our list of pending events

1255 wxENTER_CRIT_SECT( m_pendingEventsLock );

1256

1257 if ( !m_pendingEvents )

1258 m_pendingEvents = new wxList;

1259

1260 m_pendingEvents->Append(event);

1261

1262 // 2) Add this event handler to list of event handlers that

1263 // have pending events.

1264

     wxTheApp->AppendPendingEventHandler(this);

1266

1267 // only release m_pendingEventsLock now because otherwise there is a race

1268 // condition as described in the ticket #9093: we could process the event

1269 // just added to m_pendingEvents in our ProcessPendingEvents() below before

1270 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus

1271 // breaking the invariant that a handler should be in the list iff it has

1272 // any pending events to process

1273 wxLEAVE_CRIT_SECT( m_pendingEventsLock );

1274

1275 // 3) Inform the system that new pending events are somewhere,

1276 // and that these should be processed in idle time.

1277 wxWakeUpIdle();

1278 }

1279

 void wxEvtHandler::DeletePendingEvents()

1281 {

1282 if (m_pendingEvents)

         m_pendingEvents->DeleteContents(true);

1284 wxDELETE(m_pendingEvents);

1285 }

1286

 void wxEvtHandler::ProcessPendingEvents()

1288 {

1289 if (!wxTheApp)

1290 {

1291 // we need an event loop which manages the list of event handlers with

1292 // pending events... cannot proceed without it!

1293 wxLogDebug("No application object! Cannot process pending events!");

1294 return;

1295 }

1296

1297 // we need to process only a single pending event in this call because

1298 // each call to ProcessEvent() could result in the destruction of this

1299 // same event handler (see the comment at the end of this function)

1300

1301 wxENTER_CRIT_SECT( m_pendingEventsLock );

1302

1303 // this method is only called by wxApp if this handler does have

1304 // pending events

     wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),

1306 "should have pending events if called" );

1307

     wxList::compatibility_iterator node = m_pendingEvents->GetFirst();

     wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());

1310

1311 // find the first event which can be processed now:

     wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();

     if (evtLoop && evtLoop->IsYielding())

1314 {

         while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))

1316 {

1317 node = node->GetNext();

             pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;

1319 }

1320

1321 if (!node)

1322 {

1323 // all our events are NOT processable now... signal this:

             wxTheApp->DelayPendingEventHandler(this);

1325

1326 // see the comment at the beginning of evtloop.h header for the

1327 // logic behind YieldFor() and behind DelayPendingEventHandler()

1328

1329 wxLEAVE_CRIT_SECT( m_pendingEventsLock );

1330

1331 return;

1332 }

1333 }

1334

1335 wxEventPtr event(pEvent);

1336

1337 // it's important we remove event from list before processing it, else a

1338 // nested event loop, for example from a modal dialog, might process the

1339 // same event again.

1340 m_pendingEvents->Erase(node);

1341

     if ( m_pendingEvents->IsEmpty() )

1343 {

1344 // if there are no more pending events left, we don't need to

1345 // stay in this list

         wxTheApp->RemovePendingEventHandler(this);

1347 }

1348

1349 wxLEAVE_CRIT_SECT( m_pendingEventsLock );

1350

1351 ProcessEvent(*event);

1352

1353 // careful: this object could have been deleted by the event handler

1354 // executed by the above ProcessEvent() call, so we can't access any fields

1355 // of this object any more

1356 }

1357

1358 /* static */

 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,

1360 wxEvtHandler *handler,

1361 wxEvent& event)

1362 {

1363 int tableId1 = entry.m_id,

1364 tableId2 = entry.m_lastId;

1365

1366 // match only if the event type is the same and the id is either -1 in

1367 // the event table (meaning "any") or the event id matches the id

1368 // specified in the event table either exactly or by falling into

1369 // range between first and last

1370 if ((tableId1 == wxID_ANY) ||

         (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||

1372 (tableId2 != wxID_ANY &&

          (event.GetId() >= tableId1 && event.GetId() <= tableId2)))

1374 {

         event.Skip(false);

1376 event.m_callbackUserData = entry.m_callbackUserData;

1377

1378 #if wxUSE_EXCEPTIONS

1379 if ( wxTheApp )

1380 {

1381 // call the handler via wxApp method which allows the user to catch

1382 // any exceptions which may be thrown by any handler in the program

1383 // in one place

             wxTheApp->CallEventHandler(handler, *entry.m_fn, event);

1385 }

1386 else

1387 #endif // wxUSE_EXCEPTIONS

1388 {

             (*entry.m_fn)(handler, event);

1390 }

1391

         if (!event.GetSkipped())

1393 return true;

1394 }

1395

1396 return false;

1397 }

1398

 bool wxEvtHandler::DoTryApp(wxEvent& event)

1400 {

     if ( wxTheApp && (this != wxTheApp) )

1402 {

1403 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always

1404 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be

1405 // processed appropriately via SearchEventTable.

         if ( event.GetEventType() != wxEVT_IDLE )

1407 {

             if ( wxTheApp->ProcessEvent(event) )

1409 return true;

1410 }

1411 }

1412

1413 return false;

1414 }

1415

 bool wxEvtHandler::TryBefore(wxEvent& event)

1417 {

1418 #if WXWIN_COMPATIBILITY_2_8

1419 // call the old virtual function to keep the code overriding it working

1420 return TryValidator(event);

1421 #else

1422 wxUnusedVar(event);

1423 return false;

1424 #endif

1425 }

1426

 bool wxEvtHandler::TryAfter(wxEvent& event)

1428 {

1429 // We only want to pass the window to the application object once even if

1430 // there are several chained handlers. Ensure that this is what happens by

1431 // only calling DoTryApp() if there is no next handler (which would do it).

1432 //

1433 // Notice that, unlike simply calling TryAfter() on the last handler in the

1434 // chain only from ProcessEvent(), this also works with wxWindow object in

1435 // the middle of the chain: its overridden TryAfter() will still be called

1436 // and propagate the event upwards the window hierarchy even if it's not

1437 // the last one in the chain (which, admittedly, shouldn't happen often).

1438 if ( GetNextHandler() )

         return GetNextHandler()->TryAfter(event);

1440

1441 // If this event is going to be processed in another handler next, don't

1442 // pass it to wxTheApp now, it will be done from TryAfter() of this other

1443 // handler.

     if ( event.WillBeProcessedAgain() )

1445 return false;

1446

1447 #if WXWIN_COMPATIBILITY_2_8

1448 // as above, call the old virtual function for compatibility

1449 return TryParent(event);

1450 #else

1451 return DoTryApp(event);

1452 #endif

1453 }

1454

 bool wxEvtHandler::ProcessEvent(wxEvent& event)

1456 {

1457 // The very first thing we do is to allow any registered filters to hook

1458 // into event processing in order to globally pre-process all events.

1459 //

1460 // Note that we should only do it if we're the first event handler called

1461 // to avoid calling FilterEvent() multiple times as the event goes through

1462 // the event handler chain and possibly upwards the window hierarchy.

     if ( !event.WasProcessed() )

1464 {

         for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )

1466 {

             int rc = f->FilterEvent(event);

             if ( rc != wxEventFilter::Event_Skip )

1469 {

                 wxASSERT_MSG( rc == wxEventFilter::Event_Ignore ||

1471 rc == wxEventFilter::Event_Processed,

1472 "unexpected FilterEvent() return value" );

1473

                 return rc != wxEventFilter::Event_Ignore;

1475 }

1476 //else: proceed normally

1477 }

1478 }

1479

1480 // Short circuit the event processing logic if we're requested to process

1481 // this event in this handler only, see DoTryChain() for more details.

     if ( event.ShouldProcessOnlyIn(this) )

1483 return TryBeforeAndHere(event);

1484

1485

1486 // Try to process the event in this handler itself.

     if ( ProcessEventLocally(event) )

1488 {

1489 // It is possible that DoTryChain() called from ProcessEventLocally()

1490 // returned true but the event was not really processed: this happens

1491 // if a custom handler ignores the request to process the event in this

1492 // handler only and in this case we should skip the post processing

1493 // done in TryAfter() but still return the correct value ourselves to

1494 // indicate whether we did or did not find a handler for this event.

         return !event.GetSkipped();

1496 }

1497

1498 // If we still didn't find a handler, propagate the event upwards the

1499 // window chain and/or to the application object.

     if ( TryAfter(event) )

1501 return true;

1502

1503

1504 // No handler found anywhere, bail out.

1505 return false;

1506 }

1507

 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)

1509 {

1510 // Try the hooks which should be called before our own handlers and this

1511 // handler itself first. Notice that we should not call ProcessEvent() on

1512 // this one as we're already called from it, which explains why we do it

1513 // here and not in DoTryChain()

     return TryBeforeAndHere(event) || DoTryChain(event);

1515 }

1516

 bool wxEvtHandler::DoTryChain(wxEvent& event)

1518 {

     for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )

1520 {

1521 // We need to process this event at the level of this handler only

1522 // right now, the pre-/post-processing was either already done by

1523 // ProcessEvent() from which we were called or will be done by it when

1524 // we return.

1525 //

1526 // However we must call ProcessEvent() and not TryHereOnly() because the

1527 // existing code (including some in wxWidgets itself) expects the

1528 // overridden ProcessEvent() in its custom event handlers pushed on a

1529 // window to be called.

1530 //

1531 // So we must call ProcessEvent() but it must not do what it usually

1532 // does. To resolve this paradox we set up a special flag inside the

1533 // object itself to let ProcessEvent() know that it shouldn't do any

1534 // pre/post-processing for this event if it gets it. Note that this

1535 // only applies to this handler, if the event is passed to another one

1536 // by explicitly calling its ProcessEvent(), pre/post-processing should

1537 // be done as usual.

1538 //

1539 // Final complication is that if the implementation of ProcessEvent()

1540 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that

1541 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our

1542 // request to process event in this handler only, we have to compensate

1543 // for it by not processing the event further because this was already

1544 // done by that rogue event handler.

1545 wxEventProcessInHandlerOnly processInHandlerOnly(event, h);

         if ( h->ProcessEvent(event) )

1547 {

1548 // Make sure "skipped" flag is not set as the event was really

1549 // processed in this case. Normally it shouldn't be set anyhow but

1550 // make sure just in case the user code does something strange.

             event.Skip(false);

1552

1553 return true;

1554 }

1555

         if ( !event.ShouldProcessOnlyIn(h) )

1557 {

1558 // Still return true to indicate that no further processing should

1559 // be undertaken but ensure that "skipped" flag is set so that the

1560 // caller knows that the event was not really processed.

1561 event.Skip();

1562

1563 return true;

1564 }

1565 }

1566

1567 return false;

1568 }

1569

 bool wxEvtHandler::TryHereOnly(wxEvent& event)

1571 {

1572 // If the event handler is disabled it doesn't process any events

1573 if ( !GetEvtHandlerEnabled() )

1574 return false;

1575

1576 // Handle per-instance dynamic event tables first

     if ( m_dynamicEvents && SearchDynamicEventTable(event) )

1578 return true;

1579

1580 // Then static per-class event tables

     if ( GetEventHashTable().HandleEvent(event, this) )

1582 return true;

1583

1584 #ifdef wxHAS_CALL_AFTER

1585 // There is an implicit entry for async method calls processing in every

1586 // event handler:

     if ( event.GetEventType() == wxEVT_ASYNC_METHOD_CALL &&

             event.GetEventObject() == this )

1589 {

         static_cast<wxAsyncMethodCallEvent&>(event).Execute();

1591 return true;

1592 }

1593 #endif // wxHAS_CALL_AFTER

1594

1595 // We don't have a handler for this event.

1596 return false;

1597 }

1598

 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)

1600 {

1601 #if wxUSE_EXCEPTIONS

1602 try

1603 {

1604 #endif

1605 return ProcessEvent(event);

1606 #if wxUSE_EXCEPTIONS

1607 }

1608 catch ( ... )

1609 {

1610 // notice that we do it in 2 steps to avoid warnings about possibly

1611 // uninitialized loop variable from some versions of g++ which are not

1612 // smart enough to figure out that GetActive() doesn't throw and so

1613 // that loop will always be initialized

1614 wxEventLoopBase *loop = NULL;

1615 try

1616 {

             loop = wxEventLoopBase::GetActive();

1618

             if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )

1620 {

1621 if ( loop )

1622 loop->Exit();

1623 }

1624 //else: continue running current event loop

1625

1626 return false;

1627 }

1628 catch ( ... )

1629 {

1630 // OnExceptionInMainLoop() threw, possibly rethrowing the same

1631 // exception again: very good, but we still need Exit() to

1632 // be called

1633 if ( loop )

1634 loop->Exit();

1635 throw;

1636 }

1637 }

1638 #endif // wxUSE_EXCEPTIONS

1639 }

1640

 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)

1642 {

     const wxEventType eventType = event.GetEventType();

     for ( int i = 0; table.entries[i].m_fn != 0; i++ )

1645 {

         const wxEventTableEntry& entry = table.entries[i];

         if ( eventType == entry.m_eventType )

1648 {

             if ( ProcessEventIfMatchesId(entry, this, event) )

1650 return true;

1651 }

1652 }

1653

1654 return false;

1655 }

1656

 void wxEvtHandler::DoBind(int id,

1658 int lastId,

1659 wxEventType eventType,

1660 wxEventFunctor *func,

1661 wxObject *userData)

1662 {

1663 wxDynamicEventTableEntry *entry =

         new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);

1665

1666 if (!m_dynamicEvents)

1667 m_dynamicEvents = new wxList;

1668

1669 // Insert at the front of the list so most recent additions are found first

     m_dynamicEvents->Insert( (wxObject*) entry );

1671

1672 // Make sure we get to know when a sink is destroyed

     wxEvtHandler *eventSink = func->GetEvtHandler();

     if ( eventSink && eventSink != this )

1675 {

         wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);

1677 if ( evtConnRef )

1678 evtConnRef->IncRef( );

1679 else

             new wxEventConnectionRef(this, eventSink);

1681 }

1682 }

1683

1684 bool

 wxEvtHandler::DoUnbind(int id,

1686 int lastId,

1687 wxEventType eventType,

1688 const wxEventFunctor& func,

1689 wxObject *userData)

1690 {

1691 if (!m_dynamicEvents)

1692 return false;

1693

     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();

1695 while (node)

1696 {

         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();

1698

         if ((entry->m_id == id) &&

             ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&

             ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&

             entry->m_fn->IsMatching(func) &&

             ((entry->m_callbackUserData == userData) || !userData))

1704 {

1705 // Remove connection from tracker node (wxEventConnectionRef)

             wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();

             if ( eventSink && eventSink != this )

1708 {

                 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);

1710 if ( evtConnRef )

1711 evtConnRef->DecRef();

1712 }

1713

1714 delete entry->m_callbackUserData;

1715 m_dynamicEvents->Erase( node );

1716 delete entry;

1717 return true;

1718 }

1719 node = node->GetNext();

1720 }

1721 return false;

1722 }

1723

 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )

1725 {

     wxCHECK_MSG( m_dynamicEvents, false,

1727 wxT("caller should check that we have dynamic events") );

1728

     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();

1730 while (node)

1731 {

         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();

1733

1734 // get next node before (maybe) calling the event handler as it could

1735 // call Disconnect() invalidating the current node

1736 node = node->GetNext();

1737

         if ( event.GetEventType() == entry->m_eventType )

1739 {

             wxEvtHandler *handler = entry->m_fn->GetEvtHandler();

1741 if ( !handler )

1742 handler = this;

             if ( ProcessEventIfMatchesId(*entry, handler, event) )

1744 return true;

1745 }

1746 }

1747

1748 return false;

1749 }

1750

 void wxEvtHandler::DoSetClientObject( wxClientData *data )

1752 {

1753 wxASSERT_MSG( m_clientDataType != wxClientData_Void,

1754 wxT("can't have both object and void client data") );

1755

1756 if ( m_clientObject )

1757 delete m_clientObject;

1758

1759 m_clientObject = data;

1760 m_clientDataType = wxClientData_Object;

1761 }

1762

 wxClientData *wxEvtHandler::DoGetClientObject() const

1764 {

1765 // it's not an error to call GetClientObject() on a window which doesn't

1766 // have client data at all - NULL will be returned

1767 wxASSERT_MSG( m_clientDataType != wxClientData_Void,

1768 wxT("this window doesn't have object client data") );

1769

1770 return m_clientObject;

1771 }

1772

 void wxEvtHandler::DoSetClientData( void *data )

1774 {

1775 wxASSERT_MSG( m_clientDataType != wxClientData_Object,

1776 wxT("can't have both object and void client data") );

1777

1778 m_clientData = data;

1779 m_clientDataType = wxClientData_Void;

1780 }

1781

 void *wxEvtHandler::DoGetClientData() const

1783 {

1784 // it's not an error to call GetClientData() on a window which doesn't have

1785 // client data at all - NULL will be returned

1786 wxASSERT_MSG( m_clientDataType != wxClientData_Object,

1787 wxT("this window doesn't have void client data") );

1788

1789 return m_clientData;

1790 }

1791

1792 // A helper to find an wxEventConnectionRef object

1793 wxEventConnectionRef *

 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)

1795 {

     for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )

1797 {

1798 // we only want wxEventConnectionRef nodes here

         wxEventConnectionRef *evtConnRef = node->ToEventConnection();

         if ( evtConnRef && evtConnRef->m_src == this )

1801 {

             wxASSERT( evtConnRef->m_sink==eventSink );

1803 return evtConnRef;

1804 }

1805 }

1806

1807 return NULL;

1808 }

1809

 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )

1811 {

1812 wxASSERT(m_dynamicEvents);

1813

1814 // remove all connections with this sink

     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;

1816 while (node)

1817 {

         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();

1819 node_nxt = node->GetNext();

1820

         if ( entry->m_fn->GetEvtHandler() == sink )

1822 {

1823 delete entry->m_callbackUserData;

1824 m_dynamicEvents->Erase( node );

1825 delete entry;

1826 }

1827 node = node_nxt;

1828 }

1829 }

1830

1831 #endif // wxUSE_BASE

1832

1833 #if wxUSE_GUI

1834

1835 // Find a window with the focus, that is also a descendant of the given window.

1836 // This is used to determine the window to initially send commands to.

 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)

1838 {

1839 // Process events starting with the window with the focus, if any.

     wxWindow* focusWin = wxWindow::FindFocus();

1841 wxWindow* win = focusWin;

1842

1843 // Check if this is a descendant of this frame.

1844 // If not, win will be set to NULL.

1845 while (win)

1846 {

1847 if (win == ancestor)

1848 break;

1849 else

1850 win = win->GetParent();

1851 }

1852 if (win == NULL)

1853 focusWin = NULL;

1854

1855 return focusWin;

1856 }

1857

1858 // ----------------------------------------------------------------------------

1859 // wxEventBlocker

1860 // ----------------------------------------------------------------------------

1861

 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)

1863 {

     wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));

1865

1866 m_window = win;

1867

1868 Block(type);

     m_window->PushEventHandler(this);

1870 }

1871

1872 wxEventBlocker::~wxEventBlocker()

1873 {

     wxEvtHandler *popped = m_window->PopEventHandler(false);

     wxCHECK_RET(popped == this,

1876 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));

1877 }

1878

 bool wxEventBlocker::ProcessEvent(wxEvent& event)

1880 {

1881 // should this event be blocked?

     for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )

1883 {

1884 wxEventType t = (wxEventType)m_eventsToBlock[i];

         if ( t == wxEVT_ANY || t == event.GetEventType() )

1886 return true; // yes, it should: mark this event as processed

1887 }

1888

1889 return false;

1890 }

1891

1892 #endif // wxUSE_GUI

1893