Sylloge
A C# helper library
Classes | Public Types | Public Member Functions | Properties | Events
Sylloge.Device.HotKeys Class Reference

A class that allows easy capture of hot key presse (like CTRL+A) More...

List of all members.

Classes

class  KeyCombo

Public Types

enum  KeyModifiers { None = 0, Alt = 1, Ctrl = 8, Shift = 64 }
enum  KeyState { KeyUp, KeyDown }

Public Member Functions

delegate void DelegateKeyComboError (string message)
delegate void DelegateKeyComboPress (KeyCombo keyCombo)
delegate void DelegateKeyPressed (KeyCombo keyCombo)
 HotKeys ()
 Create a new instance of the Hot Key Handler Class.
void Dispose ()
void Add (KeyModifiers modifier, System.Windows.Forms.Keys key, string tag)
 Add a key combonation to watch for.

Properties

bool Enabled [get, set]

Events

DelegateKeyComboError KeyComboError
 Occurs on a key combo error.
DelegateKeyComboPress KeyComboPress
 Occurs when one of the Hot Keys in the list is pressed.
DelegateKeyPressed KeyPressed
 Occurs when any key is pressed.

Detailed Description

A class that allows easy capture of hot key presse (like CTRL+A)

Definition at line 25 of file HotKeys.cs.


Member Enumeration Documentation

Enumerator:
None 
Alt 
Ctrl 
Shift 

Definition at line 29 of file HotKeys.cs.

Enumerator:
KeyUp 
KeyDown 

Definition at line 43 of file HotKeys.cs.


Constructor & Destructor Documentation

Sylloge.Device.HotKeys.HotKeys ( )

Create a new instance of the Hot Key Handler Class.

Definition at line 127 of file HotKeys.cs.


Member Function Documentation

void Sylloge.Device.HotKeys.Add ( KeyModifiers  modifier,
System.Windows.Forms.Keys  key,
string  tag 
)

Add a key combonation to watch for.

Parameters:
modifierThe key modifier to use (can be CTRL, ALT, SHIFT, a combination of the three, or NONE)
keyThe key to add to the watch list
tagAn easily identifiable key tag

Definition at line 154 of file HotKeys.cs.

delegate void Sylloge.Device.HotKeys.DelegateKeyComboError ( string  message)
delegate void Sylloge.Device.HotKeys.DelegateKeyComboPress ( KeyCombo  keyCombo)
delegate void Sylloge.Device.HotKeys.DelegateKeyPressed ( KeyCombo  keyCombo)
void Sylloge.Device.HotKeys.Dispose ( )

Definition at line 142 of file HotKeys.cs.


Property Documentation

bool Sylloge.Device.HotKeys.Enabled [get, set]

Definition at line 140 of file HotKeys.cs.


Event Documentation

DelegateKeyComboError Sylloge.Device.HotKeys.KeyComboError

Occurs on a key combo error.

Definition at line 87 of file HotKeys.cs.

DelegateKeyComboPress Sylloge.Device.HotKeys.KeyComboPress

Occurs when one of the Hot Keys in the list is pressed.

Definition at line 91 of file HotKeys.cs.

DelegateKeyPressed Sylloge.Device.HotKeys.KeyPressed

Occurs when any key is pressed.

Definition at line 95 of file HotKeys.cs.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events