samples/keyboard/keyboard.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        keyboard.cpp
   3 // Purpose:     Keyboard wxWidgets sample
   4 // Author:      Vadim Zeitlin
   5 // Modified by: Marcin Wojdyr
   6 // Created:     07.04.02
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2002 Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17 #ifndef WX_PRECOMP
  18     #include "wx/wx.h"
  19 #endif
  20
  21 #ifndef wxHAS_IMAGES_IN_RESOURCES
  22     #include "../sample.xpm"
  23 #endif
  24
  25 // Define a new frame type: this is going to be our main frame
  26 class MyFrame : public wxFrame
  27 {
  28 public:
  29     MyFrame(const wxString& title);
  30
  31 private:
  32     // event handlers
  33     void OnQuit(wxCommandEvent& WXUNUSED(event)) { Close(true); }
  34     void OnAbout(wxCommandEvent& event);
  35
  36     void OnTestAccelA(wxCommandEvent& WXUNUSED(event))
  37         { m_logText->AppendText("Test accelerator \"A\" used.\n"); }
  38     void OnTestAccelCtrlA(wxCommandEvent& WXUNUSED(event))
  39         { m_logText->AppendText("Test accelerator \"Ctrl-A\" used.\n"); }
  40     void OnTestAccelEsc(wxCommandEvent& WXUNUSED(event))
  41         { m_logText->AppendText("Test accelerator \"Esc\" used.\n"); }
  42
  43     void OnClear(wxCommandEvent& WXUNUSED(event)) { m_logText->Clear(); }
  44     void OnSkipDown(wxCommandEvent& event) { m_skipDown = event.IsChecked(); }
  45     void OnSkipHook(wxCommandEvent& event) { m_skipHook = event.IsChecked(); }
  46
  47     void OnKeyDown(wxKeyEvent& event)
  48     {
  49         LogEvent("KeyDown", event);
  50         if ( m_skipDown )
  51             event.Skip();
  52     }
  53     void OnKeyUp(wxKeyEvent& event) { LogEvent("KeyUp", event); }
  54     void OnChar(wxKeyEvent& event) { LogEvent("Char", event); }
  55     void OnCharHook(wxKeyEvent& event)
  56     {
  57         // The logged messages can be confusing if the input window doesn't
  58         // have focus so warn about this.
  59         if ( !m_inputWin->HasFocus() )
  60         {
  61             m_logText->SetDefaultStyle(*wxRED);
  62             m_logText->AppendText("WARNING: focus is not on input window, "
  63                                   "non-hook events won't be logged.\n");
  64             m_logText->SetDefaultStyle(wxTextAttr());
  65         }
  66
  67         LogEvent("Hook", event);
  68         if ( m_skipHook )
  69             event.Skip();
  70     }
  71
  72     void OnPaintInputWin(wxPaintEvent& event);
  73
  74     void LogEvent(const wxString& name, wxKeyEvent& event);
  75
  76     wxTextCtrl *m_logText;
  77     wxWindow *m_inputWin;
  78     bool m_skipHook,
  79          m_skipDown;
  80 };
  81
  82
  83 // Define a new application type, each program should derive a class from wxApp
  84 class MyApp : public wxApp
  85 {
  86 public:
  87     // 'Main program' equivalent: the program execution "starts" here
  88     virtual bool OnInit()
  89     {
  90         // create the main application window
  91         new MyFrame("Keyboard wxWidgets App");
  92
  93         // If we returned false here, the application would exit immediately.
  94         return true;
  95     }
  96 };
  97
  98 // Create a new application object: this macro will allow wxWidgets to create
  99 // the application object during program execution (it's better than using a
 100 // static object for many reasons) and also declares the accessor function
 101 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 102 // not wxApp)
 103 IMPLEMENT_APP(MyApp)
 104
 105
 106 // ============================================================================
 107 // implementation
 108 // ============================================================================
 109
 110 // frame constructor
 111 MyFrame::MyFrame(const wxString& title)
 112        : wxFrame(NULL, wxID_ANY, title),
 113          m_inputWin(NULL),
 114          m_skipHook(true),
 115          m_skipDown(true)
 116 {
 117     SetIcon(wxICON(sample));
 118
 119     // IDs for menu items
 120     enum
 121     {
 122         QuitID = wxID_EXIT,
 123         ClearID = wxID_CLEAR,
 124         SkipHook = 100,
 125         SkipDown,
 126         TestAccelA,
 127         TestAccelCtrlA,
 128         TestAccelEsc
 129     };
 130
 131     // create a menu bar
 132     wxMenu *menuFile = new wxMenu;
 133
 134     menuFile->Append(ClearID, "&Clear log\tCtrl-L");
 135     menuFile->AppendSeparator();
 136
 137     menuFile->Append(TestAccelA, "Test accelerator &1\tA");
 138     menuFile->Append(TestAccelCtrlA, "Test accelerator &2\tCtrl-A");
 139     menuFile->Append(TestAccelEsc, "Test accelerator &3\tEsc");
 140     menuFile->AppendSeparator();
 141
 142     menuFile->AppendCheckItem(SkipHook, "Skip CHAR_HOOK event",
 143         "Not skipping this event disables both KEY_DOWN and CHAR events"
 144     );
 145     menuFile->Check(SkipHook, true);
 146     menuFile->AppendCheckItem(SkipDown, "Skip KEY_DOWN event",
 147         "Not skipping this event disables CHAR event generation"
 148     );
 149     menuFile->Check(SkipDown, true);
 150     menuFile->AppendSeparator();
 151
 152     menuFile->Append(QuitID, "E&xit\tAlt-X", "Quit this program");
 153
 154     // the "About" item should be in the help menu
 155     wxMenu *menuHelp = new wxMenu;
 156     menuHelp->Append(wxID_ABOUT, "&About\tF1", "Show about dialog");
 157
 158     // now append the freshly created menu to the menu bar...
 159     wxMenuBar *menuBar = new wxMenuBar();
 160     menuBar->Append(menuFile, "&File");
 161     menuBar->Append(menuHelp, "&Help");
 162
 163     // ... and attach this menu bar to the frame
 164     SetMenuBar(menuBar);
 165
 166     m_inputWin = new wxWindow(this, wxID_ANY, wxDefaultPosition, wxSize(-1, 50),
 167                               wxRAISED_BORDER);
 168     m_inputWin->SetBackgroundColour(*wxBLUE);
 169
 170     wxTextCtrl *headerText = new wxTextCtrl(this, wxID_ANY, "",
 171                                             wxDefaultPosition, wxDefaultSize,
 172                                             wxTE_READONLY);
 173     headerText->SetValue(
 174                " event          key     KeyCode mod   UnicodeKey  "
 175                "  RawKeyCode RawKeyFlags  Position");
 176
 177
 178     m_logText = new wxTextCtrl(this, wxID_ANY, "",
 179                                wxDefaultPosition, wxDefaultSize,
 180                                wxTE_MULTILINE|wxTE_READONLY|wxTE_RICH|wxHSCROLL);
 181
 182     // set monospace font to have output in nice columns
 183     wxFont font(10, wxFONTFAMILY_TELETYPE,
 184                 wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
 185     headerText->SetFont(font);
 186     m_logText->SetFont(font);
 187
 188     // layout
 189     wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
 190     sizer->Add(m_inputWin, wxSizerFlags().Expand());
 191     sizer->Add(headerText, wxSizerFlags().Expand());
 192     sizer->Add(m_logText, wxSizerFlags(1).Expand());
 193     SetSizerAndFit(sizer);
 194
 195     // set size and position on screen
 196     SetSize(700, 340);
 197     CentreOnScreen();
 198
 199     // connect menu event handlers
 200
 201     Connect(QuitID, wxEVT_COMMAND_MENU_SELECTED,
 202             wxCommandEventHandler(MyFrame::OnQuit));
 203
 204     Connect(wxID_ABOUT, wxEVT_COMMAND_MENU_SELECTED,
 205             wxCommandEventHandler(MyFrame::OnAbout));
 206
 207     Connect(ClearID, wxEVT_COMMAND_MENU_SELECTED,
 208             wxCommandEventHandler(MyFrame::OnClear));
 209
 210     Connect(SkipHook, wxEVT_COMMAND_MENU_SELECTED,
 211             wxCommandEventHandler(MyFrame::OnSkipHook));
 212     Connect(SkipDown, wxEVT_COMMAND_MENU_SELECTED,
 213             wxCommandEventHandler(MyFrame::OnSkipDown));
 214
 215     Connect(TestAccelA, wxEVT_COMMAND_MENU_SELECTED,
 216             wxCommandEventHandler(MyFrame::OnTestAccelA));
 217
 218     Connect(TestAccelCtrlA, wxEVT_COMMAND_MENU_SELECTED,
 219             wxCommandEventHandler(MyFrame::OnTestAccelCtrlA));
 220
 221     Connect(TestAccelEsc, wxEVT_COMMAND_MENU_SELECTED,
 222             wxCommandEventHandler(MyFrame::OnTestAccelEsc));
 223
 224     // connect event handlers for the blue input window
 225     m_inputWin->Connect(wxEVT_KEY_DOWN, wxKeyEventHandler(MyFrame::OnKeyDown),
 226                         NULL, this);
 227     m_inputWin->Connect(wxEVT_KEY_UP, wxKeyEventHandler(MyFrame::OnKeyUp),
 228                         NULL, this);
 229     m_inputWin->Connect(wxEVT_CHAR, wxKeyEventHandler(MyFrame::OnChar),
 230                         NULL, this);
 231     m_inputWin->Connect(wxEVT_PAINT,
 232                         wxPaintEventHandler(MyFrame::OnPaintInputWin),
 233                         NULL, this);
 234
 235     // notice that we don't connect OnCharHook() to the input window, unlike
 236     // the usual key events this one is propagated upwards
 237     Connect(wxEVT_CHAR_HOOK, wxKeyEventHandler(MyFrame::OnCharHook));
 238
 239     // status bar is useful for showing the menu items help strings
 240     CreateStatusBar();
 241
 242     // and show itself (the frames, unlike simple controls, are not shown when
 243     // created initially)
 244     Show(true);
 245 }
 246
 247 // event handlers
 248
 249 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 250 {
 251     wxMessageBox("Demonstrates keyboard event processing in wxWidgets\n"
 252                  "(c) 2002 Vadim Zeitlin\n"
 253                  "(c) 2008 Marcin Wojdyr",
 254                  "About wxWidgets Keyboard Sample",
 255                  wxOK | wxICON_INFORMATION, this);
 256 }
 257
 258 void MyFrame::OnPaintInputWin(wxPaintEvent& WXUNUSED(event))
 259 {
 260     wxPaintDC dc(m_inputWin);
 261     dc.SetTextForeground(*wxWHITE);
 262     wxFont font(*wxSWISS_FONT);
 263     font.SetWeight(wxFONTWEIGHT_BOLD);
 264     font.SetPointSize(font.GetPointSize() + 2);
 265     dc.SetFont(font);
 266
 267     dc.DrawLabel("Press keys here",
 268                  m_inputWin->GetClientRect(), wxALIGN_CENTER);
 269 }
 270
 271
 272 // helper function that returns textual description of wx virtual keycode
 273 const char* GetVirtualKeyCodeName(int keycode)
 274 {
 275     switch ( keycode )
 276     {
 277 #define WXK_(x) \
 278         case WXK_##x: return #x;
 279
 280         WXK_(BACK)
 281         WXK_(TAB)
 282         WXK_(RETURN)
 283         WXK_(ESCAPE)
 284         WXK_(SPACE)
 285         WXK_(DELETE)
 286         WXK_(START)
 287         WXK_(LBUTTON)
 288         WXK_(RBUTTON)
 289         WXK_(CANCEL)
 290         WXK_(MBUTTON)
 291         WXK_(CLEAR)
 292         WXK_(SHIFT)
 293         WXK_(ALT)
 294         WXK_(CONTROL)
 295         WXK_(MENU)
 296         WXK_(PAUSE)
 297         WXK_(CAPITAL)
 298         WXK_(END)
 299         WXK_(HOME)
 300         WXK_(LEFT)
 301         WXK_(UP)
 302         WXK_(RIGHT)
 303         WXK_(DOWN)
 304         WXK_(SELECT)
 305         WXK_(PRINT)
 306         WXK_(EXECUTE)
 307         WXK_(SNAPSHOT)
 308         WXK_(INSERT)
 309         WXK_(HELP)
 310         WXK_(NUMPAD0)
 311         WXK_(NUMPAD1)
 312         WXK_(NUMPAD2)
 313         WXK_(NUMPAD3)
 314         WXK_(NUMPAD4)
 315         WXK_(NUMPAD5)
 316         WXK_(NUMPAD6)
 317         WXK_(NUMPAD7)
 318         WXK_(NUMPAD8)
 319         WXK_(NUMPAD9)
 320         WXK_(MULTIPLY)
 321         WXK_(ADD)
 322         WXK_(SEPARATOR)
 323         WXK_(SUBTRACT)
 324         WXK_(DECIMAL)
 325         WXK_(DIVIDE)
 326         WXK_(F1)
 327         WXK_(F2)
 328         WXK_(F3)
 329         WXK_(F4)
 330         WXK_(F5)
 331         WXK_(F6)
 332         WXK_(F7)
 333         WXK_(F8)
 334         WXK_(F9)
 335         WXK_(F10)
 336         WXK_(F11)
 337         WXK_(F12)
 338         WXK_(F13)
 339         WXK_(F14)
 340         WXK_(F15)
 341         WXK_(F16)
 342         WXK_(F17)
 343         WXK_(F18)
 344         WXK_(F19)
 345         WXK_(F20)
 346         WXK_(F21)
 347         WXK_(F22)
 348         WXK_(F23)
 349         WXK_(F24)
 350         WXK_(NUMLOCK)
 351         WXK_(SCROLL)
 352         WXK_(PAGEUP)
 353         WXK_(PAGEDOWN)
 354         WXK_(NUMPAD_SPACE)
 355         WXK_(NUMPAD_TAB)
 356         WXK_(NUMPAD_ENTER)
 357         WXK_(NUMPAD_F1)
 358         WXK_(NUMPAD_F2)
 359         WXK_(NUMPAD_F3)
 360         WXK_(NUMPAD_F4)
 361         WXK_(NUMPAD_HOME)
 362         WXK_(NUMPAD_LEFT)
 363         WXK_(NUMPAD_UP)
 364         WXK_(NUMPAD_RIGHT)
 365         WXK_(NUMPAD_DOWN)
 366         WXK_(NUMPAD_PAGEUP)
 367         WXK_(NUMPAD_PAGEDOWN)
 368         WXK_(NUMPAD_END)
 369         WXK_(NUMPAD_BEGIN)
 370         WXK_(NUMPAD_INSERT)
 371         WXK_(NUMPAD_DELETE)
 372         WXK_(NUMPAD_EQUAL)
 373         WXK_(NUMPAD_MULTIPLY)
 374         WXK_(NUMPAD_ADD)
 375         WXK_(NUMPAD_SEPARATOR)
 376         WXK_(NUMPAD_SUBTRACT)
 377         WXK_(NUMPAD_DECIMAL)
 378         WXK_(NUMPAD_DIVIDE)
 379
 380         WXK_(WINDOWS_LEFT)
 381         WXK_(WINDOWS_RIGHT)
 382 #ifdef __WXOSX__
 383         WXK_(RAW_CONTROL)
 384 #endif
 385 #undef WXK_
 386
 387     default:
 388         return NULL;
 389     }
 390 }
 391
 392 // helper function that returns textual description of key in the event
 393 wxString GetKeyName(const wxKeyEvent &event)
 394 {
 395     int keycode = event.GetKeyCode();
 396     const char* virt = GetVirtualKeyCodeName(keycode);
 397     if ( virt )
 398         return virt;
 399     if ( keycode > 0 && keycode < 32 )
 400         return wxString::Format("Ctrl-%c", (unsigned char)('A' + keycode - 1));
 401     if ( keycode >= 32 && keycode < 128 )
 402         return wxString::Format("'%c'", (unsigned char)keycode);
 403
 404 #if wxUSE_UNICODE
 405     int uc = event.GetUnicodeKey();
 406     if ( uc != WXK_NONE )
 407         return wxString::Format("'%c'", uc);
 408 #endif
 409
 410     return "unknown";
 411 }
 412
 413
 414 void MyFrame::LogEvent(const wxString& name, wxKeyEvent& event)
 415 {
 416     wxString msg;
 417     // event  key_name  KeyCode  modifiers  Unicode  raw_code raw_flags pos
 418     msg.Printf("%7s %15s %5d   %c%c%c%c"
 419 #if wxUSE_UNICODE
 420                    "%5d (U+%04x)"
 421 #else
 422                    "    none   "
 423 #endif
 424 #ifdef wxHAS_RAW_KEY_CODES
 425                    "  %7lu    0x%08lx"
 426 #else
 427                    "  not-set    not-set"
 428 #endif
 429                    "  (%5d,%5d)"
 430                    "\n",
 431                name,
 432                GetKeyName(event),
 433                event.GetKeyCode(),
 434                event.ControlDown() ? 'C' : '-',
 435                event.AltDown()     ? 'A' : '-',
 436                event.ShiftDown()   ? 'S' : '-',
 437                event.MetaDown()    ? 'M' : '-'
 438 #if wxUSE_UNICODE
 439                , event.GetUnicodeKey()
 440                , event.GetUnicodeKey()
 441 #endif
 442 #ifdef wxHAS_RAW_KEY_CODES
 443                , (unsigned long) event.GetRawKeyCode()
 444                , (unsigned long) event.GetRawKeyFlags()
 445 #endif
 446                , event.GetX()
 447                , event.GetY()
 448                );
 449
 450     m_logText->AppendText(msg);
 451 }
 452
 453