DI-Guy C++ SDK Reference  13.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyPluginKeyboardEvent.h
Go to the documentation of this file.
1 
2 /*********************************************************************
3  ** Copyright (c) 1992-2014 VT MAK
4  ** All rights reserved.
5  *********************************************************************/
6 
7 
8 /*********************************************************************
9  **
10  *t diguyPluginKeyboardEvent
11  **
12  ** Objects of this type are passed into the plugin keyboard
13  ** functions key_press() and key_release().
14  */
15 
16 #ifndef __diguyPluginKeyboardEvent_H
17 #define __diguyPluginKeyboardEvent_H
18 
19 
20 #include <declspec_diguy.h>
21 
22 class diguyView;
23 
24 
25 /****************************************************************************/
26 class BDI_DECLSPEC_diguy diguyPluginKeyboardEvent
27 {
28 
29 public:
30 
31  /*l
32  *b Description:
33  **
34  ** This function returns the view in which the keyboard event
35  ** took place.
36  **
37  *b Returns:
38  **
39  ** object of type diguyView
40  **
41  *b Callable From:
42  **
43  *- - C++
44  */
45  diguyView* get_view();
46 
47  /*l
48  *b Description:
49  **
50  ** This function returns the key that was pressed of released.
51  **
52  *b Returns:
53  **
54  ** code of key
55  **
56  *b Callable From:
57  **
58  *- - C++
59  */
60  int get_key();
61 
62  /*l
63  *b Description:
64  **
65  ** This function returns the screen x coordinate at which the
66  ** keyboard event took place.
67  **
68  *b Returns:
69  **
70  ** screen x coordinate
71  **
72  *b Callable From:
73  **
74  *- - C++
75  */
76  int get_x();
77 
78  /*l
79  *b Description:
80  **
81  ** This function returns the screen y coordinate at which the
82  ** keyboard event took place.
83  **
84  *b Returns:
85  **
86  ** screen y coordinate
87  **
88  *b Callable From:
89  **
90  *- - C++
91  */
92  int get_y();
93 
98 #ifdef CPLUSPLUS_ONLY
99 
100  diguyPluginKeyboardEvent(diguyView* view,
101  int x,
102  int y,
103  int key);
104  ~diguyPluginKeyboardEvent();
105 
106 private:
107 
108  diguyView* m_view;
109  int m_x;
110  int m_y;
111  int m_key;
112 
113  friend class bdiScenarioPlugin;
114  friend class bdiScenarioEditor;
115 
116 #endif
117 
118 };
119 
120 
121 #endif /* __diguyPluginKeyboardEvent_H */
122 
123 
124 /*********************************************************************
125  ** Copyright (c) 1992-2014 VT MAK
126  ** All rights reserved.
127  *********************************************************************/
128