_IHotKeyBoxEvents Interface Reference

The HotKeyBox class' events interface More...

List of all members.

Public Member Functions

void Click (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user clicked into the control's client area
void ContextMenu (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The context menu should be displayed
void DblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area
void DestroyedControlWindow (LONG hWnd)
 The control window was destroyed
void KeyDown (SHORT *keyCode, SHORT shift)
 A key was pressed while the control has the focus
void KeyPress (SHORT *keyAscii)
 An alphanumeric key was pressed and released while the control has the focus
void KeyUp (SHORT *keyCode, SHORT shift)
 A key was released while the control has the focus
void MClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user clicked into the control's client area
void MDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area
void MouseDown (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 A mouse button was pressed over the control's client area
void MouseEnter (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The mouse cursor was moved into the control's client area
void MouseHover (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The mouse cursor was moved into the control's client area a specified period of time before
void MouseLeave (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The mouse cursor was moved out of the control's client area
void MouseMove (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The mouse cursor was moved over the control's client area
void MouseUp (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 A mouse button was released over the control's client area
void OLEDragDrop (IOLEDataObject *data, OLEDropEffectConstants *effect, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The data was dropped onto the control during OLE drag'n'drop
void OLEDragEnter (IOLEDataObject *data, OLEDropEffectConstants *effect, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The data was dragged into the control during OLE drag'n'drop
void OLEDragLeave (IOLEDataObject *data, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The data was dragged out of the control during OLE drag'n'drop
void OLEDragMouseMove (IOLEDataObject *data, OLEDropEffectConstants *effect, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The data was dragged over the control during OLE drag'n'drop
void RClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user clicked into the control's client area
void RDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area
void RecreatedControlWindow (LONG hWnd)
 The control window was recreated
void ResizedControlWindow (void)
 The control window was resized


Detailed Description

The HotKeyBox class' events interface

Author:
Timo "TimoSoft" Kunze This interface defines all events the HotKeyBox class may raise.
See also:
IHotKeyBox

Member Function Documentation

void Click ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using the left mouse button.

Parameters:
[in] button The mouse buttons that were pressed during the click. This should always be vbLeftButton (defined by VB's MouseButtonConstants enumeration).
[in] shift The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
DblClick, MClick, RClick, IHotKeyBox::DisabledEvents

void ContextMenu ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The context menu should be displayed

Will be fired if the control's context menu should be displayed.

Parameters:
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the menu's proposed position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the menu's proposed position relative to the control's upper-left corner.
See also:
RClick

void DblClick ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using the left mouse button.

Parameters:
[in] button The mouse buttons that were pressed during the double-click. This should always be vbLeftButton (defined by VB's MouseButtonConstants enumeration).
[in] shift The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
Click, MDblClick, RDblClick, IHotKeyBox::DisabledEvents

void DestroyedControlWindow ( LONG  hWnd  ) 

The control window was destroyed

Will be fired after the control window was destroyed.

Parameters:
[in] hWnd The control's window handle.
See also:
RecreatedControlWindow, IHotKeyBox::hWnd

void KeyDown ( SHORT *  keyCode,
SHORT  shift 
)

A key was pressed while the control has the focus

Will be fired if the user presses a key while the control has the focus.

Parameters:
[in,out] keyCode The pressed key. Any of the values defined by VB's KeyCodeConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
Remarks:
This is the control's default event.
You may set keyCode to 0 to eat the message.
This event may be disabled.
See also:
KeyUp, KeyPress, IHotKeyBox::DisabledEvents

void KeyPress ( SHORT *  keyAscii  ) 

An alphanumeric key was pressed and released while the control has the focus

Will be fired if the user presses and releases an alphanumeric key while the control has the focus.

Parameters:
[in,out] keyAscii The pressed key's ASCII code.
Remarks:
You may set keyAscii to 0 to eat the message.
This event may be disabled.
See also:
KeyDown, KeyUp, IHotKeyBox::DisabledEvents

void KeyUp ( SHORT *  keyCode,
SHORT  shift 
)

A key was released while the control has the focus

Will be fired if the user releases a key while the control has the focus.

Parameters:
[in,out] keyCode The released key. Any of the values defined by VB's KeyCodeConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
Remarks:
You may set keyCode to 0 to eat the message.
This event may be disabled.
See also:
KeyDown, KeyPress, IHotKeyBox::DisabledEvents

void MClick ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using the middle mouse button.

Parameters:
[in] button The mouse buttons that were pressed during the click. This should always be vbMiddleButton (defined by VB's MouseButtonConstants enumeration).
[in] shift The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MDblClick, Click, RClick, IHotKeyBox::DisabledEvents

void MDblClick ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using the middle mouse button.

Parameters:
[in] button The mouse buttons that were pressed during the double-click. This should always be vbMiddleButton (defined by VB's MouseButtonConstants enumeration).
[in] shift The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MClick, DblClick, RDblClick, IHotKeyBox::DisabledEvents

void MouseDown ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

A mouse button was pressed over the control's client area

Will be fired if the user presses a mouse button while the mouse cursor is located over the control's client area.

Parameters:
[in] button The pressed mouse button. Any of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MouseUp, Click, MClick, RClick, IHotKeyBox::DisabledEvents

void MouseEnter ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The mouse cursor was moved into the control's client area

Will be fired if the user moved the mouse cursor into the control's client area.

Parameters:
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MouseLeave, MouseHover, MouseMove, IHotKeyBox::DisabledEvents

void MouseHover ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The mouse cursor was moved into the control's client area a specified period of time before

Will be fired if the mouse cursor has been located over the control's client area for the number of milliseconds specified by the ITextBox::HoverTime property.

Parameters:
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MouseEnter, MouseLeave, MouseMove, IHotKeyBox::HoverTime, IHotKeyBox::DisabledEvents

void MouseLeave ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The mouse cursor was moved out of the control's client area

Will be fired if the user moves the mouse cursor out of the control's client area.

Parameters:
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MouseEnter, MouseHover, MouseMove, IHotKeyBox::DisabledEvents

void MouseMove ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The mouse cursor was moved over the control's client area

Will be fired if the user moves the mouse cursor over the control's client area.

Parameters:
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MouseEnter, MouseLeave, MouseDown, MouseUp, IHotKeyBox::DisabledEvents

void MouseUp ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

A mouse button was released over the control's client area

Will be fired if the user releases a mouse button while the mouse cursor is located over the control's client area.

Parameters:
[in] button The released mouse button. Any of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
MouseDown, Click, MClick, RClick, IHotKeyBox::DisabledEvents

void OLEDragDrop ( IOLEDataObject data,
OLEDropEffectConstants effect,
SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The data was dropped onto the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user completes the operation while the mouse cursor is located over the control's client area.

Parameters:
[in] data The dropped data.
[in,out] effect On entry, a bit field of the drop effects (defined by the OLEDropEffectConstants enumeration) supported by the drag source. On return, this paramter must be set to the drop effect that the target finally executed.
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
Don't forget to release any references that you hold to the data object.
See also:
OLEDragEnter, OLEDragMouseMove, OLEDragLeave, MouseUp, IHotKeyBox::RegisterForOLEDragDrop, OLEDropEffectConstants

void OLEDragEnter ( IOLEDataObject data,
OLEDropEffectConstants effect,
SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The data was dragged into the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user moved the mouse cursor into the control's client area.

Parameters:
[in] data The dragged data.
[in,out] effect On entry, a bit field of the drop effects (defined by the OLEDropEffectConstants enumeration) supported by the drag source. On return, this paramter must be set to the drop effect that the target wants to be used on drop.
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
See also:
OLEDragMouseMove, OLEDragLeave, OLEDragDrop, MouseEnter, IHotKeyBox::RegisterForOLEDragDrop, OLEDropEffectConstants

void OLEDragLeave ( IOLEDataObject data,
SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The data was dragged out of the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user moves the mouse cursor out of the control's client area or if the user canceled the drag'n'drop operation.

Parameters:
[in] data The dragged data.
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
Remarks:
Don't forget to release any references that you hold to the data object.
See also:
OLEDragEnter, OLEDragMouseMove, OLEDragDrop, MouseLeave, IHotKeyBox::RegisterForOLEDragDrop

void OLEDragMouseMove ( IOLEDataObject data,
OLEDropEffectConstants effect,
SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The data was dragged over the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user moves the mouse cursor over the control's client area.

Parameters:
[in] data The dragged data.
[in,out] effect On entry, a bit field of the drop effects (defined by the OLEDropEffectConstants enumeration) supported by the drag source. On return, this paramter must be set to the drop effect that the target wants to be used on drop.
[in] button The pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in] shift The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
See also:
OLEDragEnter, OLEDragLeave, OLEDragDrop, MouseMove, IHotKeyBox::RegisterForOLEDragDrop, OLEDropEffectConstants

void RClick ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using the right mouse button.

Parameters:
[in] button The mouse buttons that were pressed during the click. This should always be vbRightButton (defined by VB's MouseButtonConstants enumeration).
[in] shift The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
ContextMenu, RDblClick, Click, MClick, IHotKeyBox::DisabledEvents

void RDblClick ( SHORT  button,
SHORT  shift,
OLE_XPOS_PIXELS  x,
OLE_YPOS_PIXELS  y 
)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using the right mouse button.

Parameters:
[in] button The mouse buttons that were pressed during the double-click. This should always be vbRightButton (defined by VB's MouseButtonConstants enumeration).
[in] shift The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in] x The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in] y The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
Remarks:
This event may be disabled.
See also:
RClick, DblClick, MDblClick, IHotKeyBox::DisabledEvents

void RecreatedControlWindow ( LONG  hWnd  ) 

The control window was recreated

Will be fired after the control window was destroyed and recreated.
Some properties can't be changed after the control window was created. If such a property is changed and the control window already exists, it is destroyed and recreated.

Parameters:
[in] hWnd The control's window handle.
See also:
DestroyedControlWindow, IHotKeyBox::hWnd

void ResizedControlWindow ( void   ) 

The control window was resized

Will be fired after the control window was resized.


Generated on Thu May 29 01:04:35 2008 for EditControls by  doxygen 1.5.6