TimoSoft ButtonControls  1.10.4.207
_IFrameEvents Interface Reference

The Frame class' events interface More...

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 More...
 
void ContextMenu (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The context menu should be displayed More...
 
void DblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area More...
 
void DestroyedControlWindow (LONG hWnd)
 The control window was destroyed More...
 
void MClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user clicked into the control's client area More...
 
void MDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
void OwnerDraw (OwnerDrawActionConstants requiredAction, OwnerDrawControlStateConstants controlState, LONG hDC, RECTANGLE *drawingRectangle)
 The control must be drawn More...
 
void RClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user clicked into the control's client area More...
 
void RDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area More...
 
void RecreatedControlWindow (LONG hWnd)
 The control window was recreated More...
 
void ResizedControlWindow (void)
 The control window was resized More...
 
void XClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user clicked into the control's client area More...
 
void XDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
 The user double-clicked into the control's client area More...
 

Detailed Description

The Frame class' events interface

This interface defines all events the Frame class may raise.

See also
IFrame

Member Function Documentation

◆ Click()

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]buttonThe mouse buttons that were pressed during the click. This should always be vbLeftButton (defined by VB's MouseButtonConstants enumeration).
[in]shiftThe 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]xThe x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]yThe y-coordinate (in twips) of the click's position relative to the control's upper-left corner.
Remarks
This is the control's default event.
This event may be disabled.
See also
DblClick, MClick, RClick, XClick, IFrame::DisabledEvents

◆ ContextMenu()

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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the menu's proposed position relative to the control's upper-left corner.
[in]yThe y-coordinate (in twips) of the menu's proposed position relative to the control's upper-left corner.
See also
RClick

◆ DblClick()

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]buttonThe mouse buttons that were pressed during the double-click. This should always be vbLeftButton (defined by VB's MouseButtonConstants enumeration).
[in]shiftThe 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]xThe x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]yThe 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, XDblClick, IFrame::DisabledEvents

◆ DestroyedControlWindow()

void DestroyedControlWindow ( LONG  hWnd)

The control window was destroyed

Will be fired after the control window was destroyed.

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

◆ MClick()

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]buttonThe mouse buttons that were pressed during the click. This should always be vbMiddleButton (defined by VB's MouseButtonConstants enumeration).
[in]shiftThe 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]xThe x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]yThe 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, XClick, IFrame::DisabledEvents

◆ MDblClick()

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]buttonThe mouse buttons that were pressed during the double-click. This should always be vbMiddleButton (defined by VB's MouseButtonConstants enumeration).
[in]shiftThe 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]xThe x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]yThe 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, XDblClick, IFrame::DisabledEvents

◆ MouseDown()

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]buttonThe pressed mouse button. Any of the values defined by VB's MouseButtonConstants enumeration or the ExtendedMouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, XClick, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ MouseEnter()

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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration or the ExtendedMouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ MouseHover()

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

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 IFrame::HoverTime property.

Parameters
[in]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration or the ExtendedMouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, IFrame::HoverTime, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ MouseLeave()

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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration or the ExtendedMouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ MouseMove()

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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration or the ExtendedMouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ MouseUp()

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]buttonThe released mouse button. Any of the values defined by VB's MouseButtonConstants enumeration or the ExtendedMouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, XClick, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ OLEDragDrop()

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]dataThe dropped data.
[in,out]effectOn 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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, IFrame::RegisterForOLEDragDrop, IFrame::FinishOLEDragDrop, OLEDropEffectConstants

◆ OLEDragEnter()

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]dataThe dragged data.
[in,out]effectOn 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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
See also
OLEDragMouseMove, OLEDragLeave, OLEDragDrop, MouseEnter, IFrame::RegisterForOLEDragDrop, OLEDropEffectConstants

◆ OLEDragLeave()

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]dataThe dragged data.
[in]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe 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, IFrame::RegisterForOLEDragDrop

◆ OLEDragMouseMove()

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]dataThe dragged data.
[in,out]effectOn 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]buttonThe pressed mouse buttons. Any combination of the values defined by VB's MouseButtonConstants enumeration is valid.
[in]shiftThe pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's ShiftConstants enumeration is valid.
[in]xThe x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]yThe y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
See also
OLEDragEnter, OLEDragLeave, OLEDragDrop, MouseMove, IFrame::RegisterForOLEDragDrop, OLEDropEffectConstants

◆ OwnerDraw()

void OwnerDraw ( OwnerDrawActionConstants  requiredAction,
OwnerDrawControlStateConstants  controlState,
LONG  hDC,
RECTANGLE drawingRectangle 
)
property

The control must be drawn

Will be fired if the Style property is set to sOwnerDrawn and the control needs to be drawn.

Parameters
[in]requiredActionSpecifies the required drawing action. Any combination of the values defined by the OwnerDrawActionConstants enumeration is valid.
[in]controlStateSpecifies the control's current state (focused, selected etc.). Any combination of the values defined by the OwnerDrawControlStateConstants enumeration are valid.
[in]hDCThe handle of the device context in which all drawing should take place.
[in]drawingRectangleThe bounding rectangle of the area that must be drawn.
See also
IFrame::Style, RECTANGLE, OwnerDrawActionConstants, OwnerDrawControlStateConstants

◆ RClick()

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]buttonThe mouse buttons that were pressed during the click. This should always be vbRightButton (defined by VB's MouseButtonConstants enumeration).
[in]shiftThe 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]xThe x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]yThe 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, XClick, IFrame::DisabledEvents

◆ RDblClick()

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]buttonThe mouse buttons that were pressed during the double-click. This should always be vbRightButton (defined by VB's MouseButtonConstants enumeration).
[in]shiftThe 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]xThe x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]yThe 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, XDblClick, IFrame::DisabledEvents

◆ RecreatedControlWindow()

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]hWndThe control's window handle.
See also
DestroyedControlWindow, IFrame::hWnd

◆ ResizedControlWindow()

void ResizedControlWindow ( void  )

The control window was resized

Will be fired after the control window was resized.

◆ XClick()

void XClick ( 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 one of the extended mouse buttons.

Parameters
[in]buttonThe mouse buttons that were pressed during the click. This should always be a constant defined by the ExtendedMouseButtonConstants enumeration.
[in]shiftThe 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]xThe x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]yThe 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
XDblClick, Click, MClick, RClick, ExtendedMouseButtonConstants, IFrame::DisabledEvents

◆ XDblClick()

void XDblClick ( 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 one of the extended mouse buttons.

Parameters
[in]buttonThe mouse buttons that were pressed during the double-click. This should be a constant defined by the ExtendedMouseButtonConstants enumeration.
[in]shiftThe 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]xThe x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]yThe 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
XClick, DblClick, MDblClick, RDblClick, ExtendedMouseButtonConstants, IFrame::DisabledEvents