DI-Guy SDK Documentation  13.1
diguyPluginKeyboardEvent Class Reference

#include <diguyPluginKeyboardEvent.h>

Public Member Functions

diguyViewget_view ()
 This function returns the view in which the keyboard event took place. More...
 
int get_key ()
 This function returns the key that was pressed of released. More...
 
int get_x ()
 This function returns the screen x coordinate at which the keyboard event took place. More...
 
int get_y ()
 This function returns the screen y coordinate at which the keyboard event took place. More...
 

Private Functions

The functions and variables past this point are for internal use only.

No external access to them is expected or necessary.

diguyViewm_view
 
int m_x
 
int m_y
 
int m_key
 
class bdiScenarioPlugin
 
class bdiScenarioEditor
 
 diguyPluginKeyboardEvent (diguyView *view, int x, int y, int key)
 
 ~diguyPluginKeyboardEvent ()
 

Constructor & Destructor Documentation

diguyPluginKeyboardEvent::diguyPluginKeyboardEvent ( diguyView view,
int  x,
int  y,
int  key 
)
diguyPluginKeyboardEvent::~diguyPluginKeyboardEvent ( )

Member Function Documentation

diguyView* diguyPluginKeyboardEvent::get_view ( )

This function returns the view in which the keyboard event took place.

Returns:

object of type diguyView

Callable From:

  • C++
int diguyPluginKeyboardEvent::get_key ( )

This function returns the key that was pressed of released.

Returns:

code of key

Callable From:

  • C++
int diguyPluginKeyboardEvent::get_x ( )

This function returns the screen x coordinate at which the keyboard event took place.

Returns:

screen x coordinate

Callable From:

  • C++
int diguyPluginKeyboardEvent::get_y ( )

This function returns the screen y coordinate at which the keyboard event took place.

Returns:

screen y coordinate

Callable From:

  • C++

Friends And Related Function Documentation

friend class bdiScenarioPlugin
friend
friend class bdiScenarioEditor
friend

Member Data Documentation

diguyView* diguyPluginKeyboardEvent::m_view
private
int diguyPluginKeyboardEvent::m_x
private
int diguyPluginKeyboardEvent::m_y
private
int diguyPluginKeyboardEvent::m_key
private

The documentation for this class was generated from the following file: