1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright : (C) 2008 by Eran Ifrah
// file name : ikeyboard.h
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// 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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef __IKEYBOARD_H__
#define __IKEYBOARD_H__
#include <wx/string.h>
#include <map>
#include <wx/window.h>
/**
* @class MenuItemData
* @author Eran
* @date 09/15/08
* @file ikeyboard.h
* @brief
*/
class MenuItemData
{
public:
wxString id;
wxString parent;
wxString action;
wxString accel;
};
typedef std::map< int, MenuItemData > MenuItemDataMap;
/**
* @class IKeyboard
* @author Eran
* @date 09/15/08
* @file ikeyboard.h
* @brief an interface to the keyboard layer of CodeLite
*/
class IKeyboard
{
public:
IKeyboard() {}
virtual ~IKeyboard() {}
/**
* @brief popup the 'keyboard shortcut' dialog
* @param parent parent for the dialog
* @param menuItemData the dialog initialization data
* @return the dialog return code from the ShowModal() call
*/
virtual int PopupNewKeyboardShortcutDlg(wxWindow *parent, MenuItemData& menuItemData) = 0;
/**
* @brief return map of all accelerators sets for CodeLite. The key for the map is XRCID(MenuItemData::id)
* @param accelMap [output]
*/
virtual void GetAccelerators(MenuItemDataMap &accelMap) = 0;
/**
* @brief
* @param accelMap
* @param accelerator
* @return
*/
virtual bool IsDuplicate(const MenuItemDataMap &accelMap, const wxString &accelerator) = 0;
/**
* @brief add new accelerator. an Update() call should be invoked for the changes take place
* @param accelMap The loaded accelerator map, from previous call to IKeyboard::GetAccelerators()
* @param cmdId Command ID
* @param parent Menu parent, e.g. "Plugins"
* @param action Menu Item entry: "Build Workspace"
* @param accel Keyboard accelerator "Ctrl-Shift-1"
* @return true on success, false otherwise
*/
virtual bool AddAccelerator(MenuItemDataMap &accelMap, const MenuItemData& menuItemData) = 0;
/**
* @brief set new accelerator map
* @param accelMap accelerator map
*/
virtual void Update(const MenuItemDataMap &accelMap) = 0;
};
#endif // __IKEYBOARD_H__
|