tool_dispatcher.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TOOL_DISPATCHER_H
#define TOOL_DISPATCHER_H
 
#include <vector>
#include <wx/event.h>
#include <wx/longlong.h>
#include <tool/tool_event.h>   // Needed for MD_ constants
 
class TOOL_MANAGER;
class PCB_BASE_FRAME;
class ACTIONS;
class ACTION_MENU;
 
namespace KIGFX
{
class VIEW;
}

class TOOL_DISPATCHER : public wxEvtHandler
{
public:
    TOOL_DISPATCHER( TOOL_MANAGER* aToolMgr );
 
    virtual ~TOOL_DISPATCHER();

    virtual void ResetState();

    virtual void DispatchWxEvent( wxEvent& aEvent );

    std::optional<TOOL_EVENT> GetToolEvent( wxKeyEvent* aKeyEvent, bool* aSpecialKeyFlag );

    static const int AutoRepeatWindowMs = 250;

    static bool ShouldDropAutoRepeat( int aKeyCode, wxLongLong aNowMs, bool aKeyIsDown,
                                      int& aLastKey, wxLongLong& aLastTimeMs );
 
private:
    bool handleMouseButton( wxEvent& aEvent, int aIndex, bool aMotion );

    void flushPendingClicks();

    bool isStaleAutoRepeat( const wxKeyEvent& aKeyEvent );

    KIGFX::VIEW* getView();

    static int decodeModifiers( const wxKeyboardState* aState );
 
private:
    static const int DragTimeThreshold = 300;

    static const int DragDistanceThreshold = 8;
 
    int      m_sysDragMinX;          
    int      m_sysDragMinY;          
 
    VECTOR2D m_lastMousePos;         
    VECTOR2D m_lastMousePosScreen;   

    struct BUTTON_STATE;
    std::vector<BUTTON_STATE*> m_buttons;

    int       m_lastKeyCode;

    wxLongLong m_lastKeyTime;

    TOOL_MANAGER* m_toolMgr;
};
 
#endif  // TOOL_DISPATCHER_H