Changeset 194

Timestamp:

05/01/2009 08:05:17 PM (3 years ago)

Author:

guyru

Message:

Re-factor the accidental roll prevention.

Location:

trunk/src

Files:

• MainFrame.cpp (modified) (5 diffs)
• MainFrame.h (modified) (3 diffs)

trunk/src/MainFrame.cpp

@@ -70 +70 @@
 
 using namespace main_frame;
-const wxEventType wxEVT_ENABLE_ROLL = wxNewEventType();
 
 MainFrame::MainFrame(const wxString& title, const wxSize& size = wxDefaultSize, long style = wxDEFAULT_FRAME_STYLE)
@@ -129 +128 @@
         m_yahtzeebonus = false;
         m_numofplaysleft = 13;
-        m_skiproll = false; // the roll button hasn't been pressed yet, no need for skipping
 }
 
@@ -352 +350 @@
         //END connecting the menu items' events
 
-        Connect(ID_ROLL, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (MainFrame::OnRollButton));
-        Connect(ID_ROLL, wxEVT_ENABLE_ROLL, wxCommandEventHandler (MainFrame::OnRollButton));
+        Connect(ID_ROLL, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (MainFrame::DoubleRollLock));
 
         //BEGIN connecting the scoreboard buttons to the events
@@ -557 +554 @@
  * \param event 
  */
-void MainFrame::OnRollButton (wxCommandEvent& event)
+void MainFrame::OnRollButton ()
 {
         short int dice[5];      //holds the dices score
         
-        if (event.GetEventType() == wxEVT_IDLE) {
-                m_skiproll = false;
-                Disconnect(wxEVT_IDLE,  wxCommandEventHandler(MainFrame::OnRollButton));
-                return;
-        }
-        
-        //skip rolling the dice if the user accidently rolled the dice before they finished spinning.
-        if (m_skiproll) return;
-        m_skiproll = true;
-
         if (m_numofplaysleft == 13)
                 m_stats->game_started();
@@ -633 +620 @@
         (GetMenuBar()->FindItem(wxID_UNDO))->Enable(false);
         m_yahtzeebonus = false; //if we scored yahtzee bonus before we don't care anymore.
-        
-        Connect(wxEVT_IDLE, wxCommandEventHandler(MainFrame::OnRollButton));
+}
+
+void MainFrame::DoubleRollLock(wxCommandEvent& event)
+{
+        /* The function works by connecting to idle event, and raising a
+         * flag when it process a valid click on the Roll button. When the
+         * another click happens and the flag is up, it means it is
+         * accidental. When the idle events is triggered it means that we
+         * no longer roll the dice, so we lower the flag.
+         */
+        static bool skip_roll = false;
+        if (event.GetEventType() == wxEVT_IDLE) {
+                skip_roll = false;
+                Disconnect(wxEVT_IDLE,  wxCommandEventHandler(MainFrame::DoubleRollLock));
+                return;
+        }
+        
+        if (skip_roll)
+                return;
+        skip_roll = true;
+        
+        Connect(wxEVT_IDLE, wxCommandEventHandler(MainFrame::DoubleRollLock));
+        OnRollButton();
 }
 

trunk/src/MainFrame.h

@@ -57 +57 @@
         void OnHelpMenuLink (wxCommandEvent& event);
 
-        void OnRollButton (wxCommandEvent& event);
+        /**
+         * Prevent accidental roll of the dice by double clicking the button.
+         * \param event The event that was send to the ::OnRollButton()
+         */
+        void DoubleRollLock(wxCommandEvent& event);
+
         void OnUpperButtons (wxCommandEvent& event);
         void On3ofakindButton (wxCommandEvent& event);
@@ -94 +99 @@
         void AddControlsAndLayout();
 
+        void OnRollButton ();
+
         wxStaticBoxSizer *uppersection, *lowersection;
         wxBoxSizer *sectionsSizer;
@@ -107 +114 @@
         short int m_lastmove; //stores the ID of the last button pressed.
         short int m_rollsundo; //holds the number of remaining rolls for use with the undo option
-
-        bool m_skiproll; ///used to prevent the user from accidently rolling the dice twice
 
         class MainFrameEvtHandler *m_evt_handler;