0029018: Documentation - Provide user guide for Qt browser
[occt.git] / tools / DFBrowser / DFBrowser_Shortcut.hxx
1 // Created on: 2017-06-16
2 // Created by: Natalia ERMOLAEVA
3 // Copyright (c) 2017 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement. 
15
16 #ifndef DFBrowser_Shortcut_H
17 #define DFBrowser_Shortcut_H
18
19 #include <Standard.hxx>
20 #include <Standard_Macro.hxx>
21
22 #ifdef _MSC_VER
23 #pragma warning(disable : 4127) // conditional expression is constant
24 #endif
25 #include <QObject>
26
27 class DFBrowser_Module;
28 class QEvent;
29
30 //! \class DFBrowser_Shortcut
31 //! Listens application KeyRelease event. Processes key event:
32 //! - <Key_F5>: updates tree view model
33 class DFBrowser_Shortcut : public QObject
34 {
35 public:
36
37   //! Constructor
38   Standard_EXPORT DFBrowser_Shortcut (QObject* theParent);
39
40   //! Destructor
41   virtual ~DFBrowser_Shortcut() {}
42
43   //! Sets the current module
44   //! \param theModule a module
45   void SetModule (DFBrowser_Module* theModule) { myModule = theModule; }
46
47   //! Processes key release event to update view model, otherwise do usual QObject functionality
48   Standard_EXPORT virtual bool eventFilter (QObject *theObject, QEvent* theEvent) Standard_OVERRIDE;
49
50 private:
51   DFBrowser_Module* myModule; //!< the current module
52 };
53
54
55 #endif