compute scrollbar spacing the same way GtkScrolledWindow does it

[wxWidgets.git] / samples / event / event.cpp

diff --git a/samples/event/event.cpp b/samples/event/event.cpp
index 3cc8c01e55097537105e507504521f497999c9c3..072241989a2600befec260e94c84a5ad9d2253e4 100644 (file)
--- a/samples/event/event.cpp
+++ b/samples/event/event.cpp
@@ -30,10 +30,13 @@
     #include "wx/wx.h"
 #endif
 
     #include "wx/wx.h"
 #endif
 

-#ifndef __WXMSW__
+#ifndef wxHAS_IMAGES_IN_RESOURCES

     #include "../sample.xpm"
 #endif
 
     #include "../sample.xpm"
 #endif
 

+#include <wx/statline.h>
+#include <wx/log.h>
+

 // ----------------------------------------------------------------------------
 // event constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // event constants
 // ----------------------------------------------------------------------------


@@ -65,8 +68,56 @@ public:
     // initialization (doing it here and not in the ctor allows to have an error
     // return: if OnInit() returns false, the application terminates)
     virtual bool OnInit();
     // initialization (doing it here and not in the ctor allows to have an error
     // return: if OnInit() returns false, the application terminates)
     virtual bool OnInit();

+
+    // these are regular event handlers used to highlight the events handling
+    // order
+    void OnClickDynamicHandlerApp(wxCommandEvent& event);
+    void OnClickStaticHandlerApp(wxCommandEvent& event);
+
+    // we override wxConsoleApp::FilterEvent used to highlight the events
+    // handling order
+    virtual int FilterEvent(wxEvent& event);
+
+private:
+    DECLARE_EVENT_TABLE()

 };
 
 };
 

+// Define a custom button used to highlight the events handling order
+class MyEvtTestButton : public wxButton
+{
+public:
+    static long BUTTON_ID;
+
+    MyEvtTestButton(wxWindow *parent, const wxString& label)
+        : wxButton(parent, BUTTON_ID, label)
+    {
+        // Add a dynamic handler for this button event to button itself
+        Connect(wxEVT_COMMAND_BUTTON_CLICKED,
+                wxCommandEventHandler(MyEvtTestButton::OnClickDynamicHandler));
+    }
+
+private:
+    void OnClickDynamicHandler(wxCommandEvent& event)
+    {
+        wxLogMessage("Step 3 in \"How Events are Processed\":\n"
+                     "Button::ownDynamicHandler");
+
+        event.Skip();
+    }
+
+    void OnClickStaticHandler(wxCommandEvent& event)
+    {
+        wxLogMessage("Step 4 in \"How Events are Processed\":\n"
+                     "Button::ownStaticHandler");
+
+        event.Skip();
+    }
+
+    DECLARE_EVENT_TABLE()
+};
+
+long MyEvtTestButton::BUTTON_ID = wxNewId();
+

 // Define a new frame type: this is going to be our main frame
 class MyFrame : public wxFrame
 {
 // Define a new frame type: this is going to be our main frame
 class MyFrame : public wxFrame
 {


@@ -91,6 +142,11 @@ public:
 
     void OnUpdateUIPop(wxUpdateUIEvent& event);
 
 
     void OnUpdateUIPop(wxUpdateUIEvent& event);
 

+    // regular event handlers used to highlight the events handling order
+    void OnClickDynamicHandlerFrame(wxCommandEvent& event);
+    void OnClickDynamicHandlerButton(wxCommandEvent& event);
+    void OnClickStaticHandlerFrame(wxCommandEvent& event);
+

 private:
     // symbolic names for the status bar fields
     enum
 private:
     // symbolic names for the status bar fields
     enum


@@ -122,6 +178,10 @@ private:
     // the button to whose event we connect dynamically
     wxButton *m_btnDynamic;
 
     // the button to whose event we connect dynamically
     wxButton *m_btnDynamic;
 

+    // the button used to highlight the event handlers execution order
+    MyEvtTestButton *m_testBtn;
+
+

     // any class wishing to process wxWidgets events must use this macro
     DECLARE_EVENT_TABLE()
 };
     // any class wishing to process wxWidgets events must use this macro
     DECLARE_EVENT_TABLE()
 };


@@ -134,7 +194,7 @@ public:
 
     void OnTest(wxCommandEvent& event)
     {
 
     void OnTest(wxCommandEvent& event)
     {

-        wxLogMessage(_T("This is the pushed test event handler #%u"), m_level);
+        wxLogMessage(wxT("This is the pushed test event handler #%u"), m_level);

 
         // if we don't skip the event, the other event handlers won't get it:
         // try commenting out this line and see what changes
 
         // if we don't skip the event, the other event handlers won't get it:
         // try commenting out this line and see what changes


@@ -170,8 +230,19 @@ enum
 // event tables and other macros for wxWidgets
 // ----------------------------------------------------------------------------
 
 // event tables and other macros for wxWidgets
 // ----------------------------------------------------------------------------
 

-// the event tables connect the wxWidgets events with the functions (event
-// handlers) which process them. It can be also done at run-time, but for the
+// The event tables connect the wxWidgets events with the functions (event
+// handlers) which process them.
+BEGIN_EVENT_TABLE(MyApp, wxApp)
+    // Add a static handler for button Click event in the app
+    EVT_BUTTON(MyEvtTestButton::BUTTON_ID, MyApp::OnClickStaticHandlerApp)
+END_EVENT_TABLE()
+
+BEGIN_EVENT_TABLE(MyEvtTestButton, wxButton)
+    // Add a static handler to this button itself for its own event
+    EVT_BUTTON(BUTTON_ID, MyEvtTestButton::OnClickStaticHandler)
+END_EVENT_TABLE()
+
+// This can be also done at run-time, but for the

 // simple menu events like this the static method is much simpler.
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(Event_Quit,  MyFrame::OnQuit)
 // simple menu events like this the static method is much simpler.
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(Event_Quit,  MyFrame::OnQuit)


@@ -194,6 +265,9 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     // the line below would also work if OnProcessCustom() were defined as
     // taking a wxEvent (as required by EVT_CUSTOM) and not wxCommandEvent
     //EVT_CUSTOM(wxEVT_MY_CUSTOM_COMMAND, wxID_ANY, MyFrame::OnProcessCustom)
     // the line below would also work if OnProcessCustom() were defined as
     // taking a wxEvent (as required by EVT_CUSTOM) and not wxCommandEvent
     //EVT_CUSTOM(wxEVT_MY_CUSTOM_COMMAND, wxID_ANY, MyFrame::OnProcessCustom)

+
+    // Add a static handler in the parent frame for button event
+    EVT_BUTTON(MyEvtTestButton::BUTTON_ID, MyFrame::OnClickStaticHandlerFrame)

 END_EVENT_TABLE()
 
 BEGIN_EVENT_TABLE(MyEvtHandler, wxEvtHandler)
 END_EVENT_TABLE()
 
 BEGIN_EVENT_TABLE(MyEvtHandler, wxEvtHandler)


@@ -222,19 +296,58 @@ bool MyApp::OnInit()
         return false;
 
     // create the main application window
         return false;
 
     // create the main application window

-    MyFrame *frame = new MyFrame(_T("Event wxWidgets Sample"),
+    MyFrame *frame = new MyFrame(wxT("Event wxWidgets Sample"),

                                  wxPoint(50, 50), wxSize(600, 340));
 
     // and show it (the frames, unlike simple controls, are not shown when
     // created initially)
     frame->Show(true);
 
                                  wxPoint(50, 50), wxSize(600, 340));
 
     // and show it (the frames, unlike simple controls, are not shown when
     // created initially)
     frame->Show(true);
 

+    // Add a dynamic handler at the application level for the test button
+    Connect(MyEvtTestButton::BUTTON_ID, wxEVT_COMMAND_BUTTON_CLICKED,
+            wxCommandEventHandler(MyApp::OnClickDynamicHandlerApp));
+

     // success: wxApp::OnRun() will be called which will enter the main message
     // loop and the application will run. If we returned false here, the
     // application would exit immediately.
     return true;
 }
 
     // success: wxApp::OnRun() will be called which will enter the main message
     // loop and the application will run. If we returned false here, the
     // application would exit immediately.
     return true;
 }
 

+// This is always the first to handle an event !
+int MyApp::FilterEvent(wxEvent& event)
+{
+    if ( event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED &&
+            event.GetId() == MyEvtTestButton::BUTTON_ID )
+    {
+        wxLogMessage("Step 0 in \"How Events are Processed\":\n"
+                     "App::FilterEvent");
+    }
+
+    return wxApp::FilterEvent(event);
+}
+
+void MyApp::OnClickDynamicHandlerApp(wxCommandEvent& event)
+{
+    wxLogMessage("Step 7, 3 in \"How Events are Processed\":\n"
+                 "App::DynamicHandler_InAppTable");
+
+    event.Skip();
+}
+
+void MyApp::OnClickStaticHandlerApp(wxCommandEvent& event)
+{
+    wxLogMessage("Step 7, 4 in \"How Events are Processed\":\n"
+                 "App::StaticHandler_InAppTable");
+
+    wxLogMessage("Button click processed, there should be no more messages "
+                 "about handling events from the button.\n\n"
+                 "The log below shows the order in which the handlers "
+                 "were executed.");
+    wxLog::FlushActive();
+
+    event.Skip();
+}
+

 // ----------------------------------------------------------------------------
 // main frame
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // main frame
 // ----------------------------------------------------------------------------


@@ -252,46 +365,47 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
     // create a menu bar
     wxMenu *menuFile = new wxMenu;
 
     // create a menu bar
     wxMenu *menuFile = new wxMenu;
 

-    menuFile->Append(Event_About, _T("&About...\tCtrl-A"), _T("Show about dialog"));
+    menuFile->Append(Event_About, wxT("&About\tCtrl-A"), wxT("Show about dialog"));

     menuFile->AppendSeparator();
     menuFile->AppendSeparator();

-    menuFile->Append(Event_Quit, _T("E&xit\tAlt-X"), _T("Quit this program"));
+    menuFile->Append(Event_Quit, wxT("E&xit\tAlt-X"), wxT("Quit this program"));

 
     wxMenu *menuEvent = new wxMenu;
 #ifdef wxHAS_EVENT_BIND
     menuEvent->AppendCheckItem(Event_Bind, "&Bind\tCtrl-B",
                                "Bind or unbind a dynamic event handler");
 #endif // wxHAS_EVENT_BIND
 
     wxMenu *menuEvent = new wxMenu;
 #ifdef wxHAS_EVENT_BIND
     menuEvent->AppendCheckItem(Event_Bind, "&Bind\tCtrl-B",
                                "Bind or unbind a dynamic event handler");
 #endif // wxHAS_EVENT_BIND

-    menuEvent->AppendCheckItem(Event_Connect, _T("&Connect\tCtrl-C"),
-                     _T("Connect or disconnect the dynamic event handler"));
-    menuEvent->Append(Event_Dynamic, _T("&Dynamic event\tCtrl-D"),
-                      _T("Dynamic event sample - only works after Connect"));
+    menuEvent->AppendCheckItem(Event_Connect, wxT("&Connect\tCtrl-C"),
+                     wxT("Connect or disconnect the dynamic event handler"));
+    menuEvent->Append(Event_Dynamic, wxT("&Dynamic event\tCtrl-D"),
+                      wxT("Dynamic event sample - only works after Connect"));

     menuEvent->AppendSeparator();
     menuEvent->AppendSeparator();

-    menuEvent->Append(Event_Push, _T("&Push event handler\tCtrl-P"),
-                      _T("Push event handler for test event"));
-    menuEvent->Append(Event_Pop, _T("P&op event handler\tCtrl-O"),
-                      _T("Pop event handler for test event"));
-    menuEvent->Append(Event_Test, _T("Test event\tCtrl-T"),
-                      _T("Test event processed by pushed event handler"));
+    menuEvent->Append(Event_Push, wxT("&Push event handler\tCtrl-P"),
+                      wxT("Push event handler for test event"));
+    menuEvent->Append(Event_Pop, wxT("P&op event handler\tCtrl-O"),
+                      wxT("Pop event handler for test event"));
+    menuEvent->Append(Event_Test, wxT("Test event\tCtrl-T"),
+                      wxT("Test event processed by pushed event handler"));

     menuEvent->AppendSeparator();
     menuEvent->AppendSeparator();

-    menuEvent->Append(Event_Custom, _T("Fire c&ustom event\tCtrl-U"),
-                      _T("Generate a custom event"));
+    menuEvent->Append(Event_Custom, wxT("Fire c&ustom event\tCtrl-U"),
+                      wxT("Generate a custom event"));

 
     // now append the freshly created menu to the menu bar...
     wxMenuBar *menuBar = new wxMenuBar();
 
     // now append the freshly created menu to the menu bar...
     wxMenuBar *menuBar = new wxMenuBar();

-    menuBar->Append(menuFile, _T("&File"));
-    menuBar->Append(menuEvent, _T("&Event"));
+    menuBar->Append(menuFile, wxT("&File"));
+    menuBar->Append(menuEvent, wxT("&Event"));

 
     // ... and attach this menu bar to the frame
     SetMenuBar(menuBar);
 
 #if wxUSE_STATUSBAR
     CreateStatusBar(3);
 
     // ... and attach this menu bar to the frame
     SetMenuBar(menuBar);
 
 #if wxUSE_STATUSBAR
     CreateStatusBar(3);

-    SetStatusText(_T("Welcome to wxWidgets event sample"));
-    SetStatusText(_T("Dynamic: off"), Status_Dynamic);
-    SetStatusText(_T("Push count: 0"), Status_Push);
+    SetStatusText(wxT("Welcome to wxWidgets event sample"));
+    SetStatusText(wxT("Dynamic: off"), Status_Dynamic);
+    SetStatusText(wxT("Push count: 0"), Status_Push);

 #endif // wxUSE_STATUSBAR
 
     wxPanel * const panel = new wxPanel(this);
 #endif // wxUSE_STATUSBAR
 
     wxPanel * const panel = new wxPanel(this);

+    wxSizer * const mainSizer = new wxBoxSizer(wxVERTICAL);

     wxSizer * const sizer = new wxBoxSizer(wxHORIZONTAL);
     const wxSizerFlags centreY(wxSizerFlags().Centre().Border());
     sizer->Add(new wxStaticText(panel, wxID_ANY,
     wxSizer * const sizer = new wxBoxSizer(wxHORIZONTAL);
     const wxSizerFlags centreY(wxSizerFlags().Centre().Border());
     sizer->Add(new wxStaticText(panel, wxID_ANY,


@@ -299,7 +413,29 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
         centreY);
     m_btnDynamic = new wxButton(panel, Event_Dynamic, "&Dynamic button");
     sizer->Add(m_btnDynamic, centreY);
         centreY);
     m_btnDynamic = new wxButton(panel, Event_Dynamic, "&Dynamic button");
     sizer->Add(m_btnDynamic, centreY);

-    panel->SetSizer(sizer);
+
+    mainSizer->Add(sizer, 1, wxEXPAND);
+    mainSizer->Add(new wxStaticLine(panel), 0, wxEXPAND);
+    mainSizer->Add(new wxStaticLine(panel), 0, wxEXPAND);
+
+    m_testBtn = new MyEvtTestButton(panel, "Test Event Handlers Execution Order");
+
+    // After being created, an instance of MyEvtTestButton already has its own
+    // event handlers (see class definition);
+
+    // Add a dynamic handler for this button event in the parent frame
+    Connect(m_testBtn->GetId(), wxEVT_COMMAND_BUTTON_CLICKED,
+            wxCommandEventHandler(MyFrame::OnClickDynamicHandlerFrame));
+
+    // Bind a method of this frame (notice "this" argument!) to the button
+    // itself
+    m_testBtn->Connect(wxEVT_COMMAND_BUTTON_CLICKED,
+                       wxCommandEventHandler(MyFrame::OnClickDynamicHandlerButton),
+                       NULL,
+                       this);
+
+    mainSizer->Add(m_testBtn);
+    panel->SetSizer(mainSizer);

 }
 
 MyFrame::~MyFrame()
 }
 
 MyFrame::~MyFrame()


@@ -330,10 +466,34 @@ void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
                  wxOK | wxICON_INFORMATION, this);
 }
 
                  wxOK | wxICON_INFORMATION, this);
 }
 

+void MyFrame::OnClickStaticHandlerFrame(wxCommandEvent& event)
+{
+    wxLogMessage("Step 6, 4 in \"How Events are Processed\":\n"
+                 "parentWin::StaticHandler_InFrameTable");
+
+    event.Skip();
+}
+

 // ----------------------------------------------------------------------------
 // dynamic event handling stuff
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // dynamic event handling stuff
 // ----------------------------------------------------------------------------
 

+void MyFrame::OnClickDynamicHandlerFrame(wxCommandEvent& event)
+{
+    wxLogMessage("Step 6, 3 in \"How Events are Processed\":\n"
+                 "parentWin::DynamicHandler_InFrameTable");
+
+    event.Skip();
+}
+
+void MyFrame::OnClickDynamicHandlerButton(wxCommandEvent& event)
+{
+    wxLogMessage("Step 3 in \"How Events are Processed\":\n"
+                 "parentWin::DynamicHandler_InButtonTable");
+
+    event.Skip();
+}
+

 void MyFrame::OnDynamic(wxCommandEvent& event)
 {
     wxString origin;
 void MyFrame::OnDynamic(wxCommandEvent& event)
 {
     wxString origin;


@@ -412,25 +572,25 @@ void MyFrame::OnPushEventHandler(wxCommandEvent& WXUNUSED(event))
     PushEventHandler(new MyEvtHandler(++m_nPush));
 
 #if wxUSE_STATUSBAR
     PushEventHandler(new MyEvtHandler(++m_nPush));
 
 #if wxUSE_STATUSBAR

-    SetStatusText(wxString::Format(_T("Push count: %u"), m_nPush), Status_Push);
+    SetStatusText(wxString::Format(wxT("Push count: %u"), m_nPush), Status_Push);

 #endif // wxUSE_STATUSBAR
 }
 
 void MyFrame::OnPopEventHandler(wxCommandEvent& WXUNUSED(event))
 {
 #endif // wxUSE_STATUSBAR
 }
 
 void MyFrame::OnPopEventHandler(wxCommandEvent& WXUNUSED(event))
 {

-    wxCHECK_RET( m_nPush, _T("this command should be disabled!") );
+    wxCHECK_RET( m_nPush, wxT("this command should be disabled!") );

 
     PopEventHandler(true /* delete handler */);
     m_nPush--;
 
 #if wxUSE_STATUSBAR
 
     PopEventHandler(true /* delete handler */);
     m_nPush--;
 
 #if wxUSE_STATUSBAR

-    SetStatusText(wxString::Format(_T("Push count: %u"), m_nPush), Status_Push);
+    SetStatusText(wxString::Format(wxT("Push count: %u"), m_nPush), Status_Push);

 #endif // wxUSE_STATUSBAR
 }
 
 void MyFrame::OnTest(wxCommandEvent& WXUNUSED(event))
 {
 #endif // wxUSE_STATUSBAR
 }
 
 void MyFrame::OnTest(wxCommandEvent& WXUNUSED(event))
 {

-    wxLogMessage(_T("This is the test event handler in the main frame"));
+    wxLogMessage(wxT("This is the test event handler in the main frame"));

 }
 
 void MyFrame::OnUpdateUIPop(wxUpdateUIEvent& event)
 }
 
 void MyFrame::OnUpdateUIPop(wxUpdateUIEvent& event)


@@ -451,6 +611,6 @@ void MyFrame::OnFireCustom(wxCommandEvent& WXUNUSED(event))
 
 void MyFrame::OnProcessCustom(wxCommandEvent& WXUNUSED(event))
 {
 
 void MyFrame::OnProcessCustom(wxCommandEvent& WXUNUSED(event))
 {

-    wxLogMessage(_T("Got a custom event!"));
+    wxLogMessage(wxT("Got a custom event!"));

 }
 
 }