_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
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	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	OwnerDraw (OwnerDrawActionConstants requiredAction, OwnerDrawControlStateConstants controlState, LONG hDC, RECTANGLE *drawingRectangle)
	The control must be drawn
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 Frame class' events interface

This interface defines all events the Frame class may raise.

See also:: IFrame

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 is the control's default event.
This event may be disabled.

See also:: DblClick, MClick, RClick, IFrame::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, IFrame::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, IFrame::hWnd

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, IFrame::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, IFrame::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, IFrame::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, IFrame::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 IFrame::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, IFrame::HoverTime, IFrame::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, IFrame::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, IFrame::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, IFrame::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, IFrame::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, IFrame::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, IFrame::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, IFrame::RegisterForOLEDragDrop, OLEDropEffectConstants

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

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]`	requiredAction	Specifies the required drawing action. Any combination of the values defined by the `OwnerDrawActionConstants` enumeration is valid.
`[in]`	controlState	Specifies the control's current state (focused, selected etc.). Any combination of the values defined by the `OwnerDrawControlStateConstants` enumeration are valid.
`[in]`	hDC	The handle of the device context in which all drawing should take place.
`[in]`	drawingRectangle	The bounding rectangle of the area that must be drawn.

See also:: IFrame::Style, RECTANGLE, OwnerDrawActionConstants, OwnerDrawControlStateConstants

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, IFrame::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, IFrame::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, IFrame::hWnd

void ResizedControlWindow ( void )

The control window was resized

Will be fired after the control window was resized.

_IFrameEvents Interface Reference

Public Member Functions

Detailed Description

Member Function Documentation