db8c4c5e5a
... and break its compile dependency on CommandManager.h by letting it install callbacks. This also removes Objective-C mixed code from CommmandManager. This also eliminates four inclusions of Project.h! Capture handler state is also global, not per project, though the CommandManager's callbacks still do depend on the active project.
62 lines
2.3 KiB
C++
62 lines
2.3 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
KeyboardCapture.h
|
|
|
|
Paul Licameli split this from Project.h
|
|
|
|
**********************************************************************/
|
|
|
|
#ifndef __AUDACITY_KEYBOARD_CAPTURE__
|
|
#define __AUDACITY_KEYBOARD_CAPTURE__
|
|
|
|
#include "Audacity.h"
|
|
|
|
#include <functional>
|
|
#include <wx/event.h>
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Custom events
|
|
////////////////////////////////////////////////////////////
|
|
|
|
/// \brief Type of event that may be sent to a window while it is
|
|
/// installed as the handler with KeyboardCapture::Capture; if it does not skip
|
|
/// the event, it will receive further events of type wxEVT_KEY_DOWN,
|
|
/// and then wxEVT_CHAR (if key-down was not skipped; those further events
|
|
/// don't actually come from wxWidgets, but are simulated by Audacity, as
|
|
/// translations of the EVT_CHAR_HOOK event); or, wxEVT_KEY_UP (really from
|
|
/// wxWidgets).
|
|
DECLARE_EXPORTED_EVENT_TYPE(AUDACITY_DLL_API, EVT_CAPTURE_KEY, -1);
|
|
|
|
namespace KeyboardCapture
|
|
{
|
|
bool IsHandler(const wxWindow *handler);
|
|
wxWindow *GetHandler();
|
|
void Capture(wxWindow *handler);
|
|
void Release(wxWindow *handler);
|
|
|
|
using FilterFunction = std::function< bool( wxKeyEvent& ) >;
|
|
|
|
/// \brief Install a pre-filter, returning the previously installed one
|
|
/// Pre-filter is called before passing the event to the captured window; if it
|
|
/// returns false, then skip the event entirely
|
|
FilterFunction SetPreFilter( const FilterFunction &function );
|
|
|
|
/// \brief Install a post-filter, returning the previously installed one
|
|
/// Post-filter is called if the captured window skips either the
|
|
/// EVT_CAPTURE_KEY or the following wxKEY_DOWN event (but not if
|
|
/// it skips only the wxEVT_CHAR or wxEVT_KEY_UP event); it is passed a
|
|
/// wxKEY_DOWN or a wxKEY_UP event; if it returns false, then the event is
|
|
/// skipped
|
|
FilterFunction SetPostFilter( const FilterFunction &function );
|
|
|
|
/// \brief a function useful to implement a focus event handler
|
|
/// The window releases the keyboard if the event is for killing focus,
|
|
/// otherwise the window captures the keyboard; then refresh the window
|
|
/// and skip the event
|
|
void OnFocus( wxWindow &window, wxFocusEvent &event );
|
|
}
|
|
|
|
#endif
|