Callback delegates > CallbackWaveformAnalyzerGraphItemClick delegate

Remarks

Callback delegate for notifying when a graphic item on the waveform analyzer is clicked: this callback can be set through a call to the CallbackWaveformAnalyzerGraphItemClickSet method.

For details about graphic items management on the waveform analyzer refer to the How to add graphic items to the Waveform analyzer section.

For further details about callback delegates see the How to synchronize the container application with the API tutorial.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

Syntax

[Visual Basic]

Public Delegate Sub CallbackWaveformAnalyzerGraphItemClick (

nButton as enumMouseButtons,

nUniqueId as Int16,

nType as enumGraphicItemType,

nFlags as Int32,

xPos as Int32,

yPos as Int32

)

[C#]

public delegate void CallbackWaveformAnalyzerGraphItemClick (

enumMouseButtons nButton,

Int16 nUniqueId,

enumGraphicItemType nType,

Int32 nFlags,

Int32 xPos,

Int32 yPos

)

[C++]

public delegate void CallbackWaveformAnalyzerGraphItemClick (

enumMouseButtons nButton,

Int16 nUniqueId,

enumGraphicItemType nType,

Int32 nFlags,

Int32 xPos,

Int32 yPos

)

Parameter

Description

nButton

Clicked mouse button.

Supported values are the following:

Mnemonic constant	Value	Meaning
MOUSE_BTN_LEFT	0	Left mouse button
MOUSE_BTN_RIGHT	1	Right mouse button
MOUSE_BTN_MIDDLE	2	Middle mouse button

nUniqueID

Unique identification number assigned to the graphic item.

The unique identification number of a graphic item is generated using one of the following methods:

•	WaveformAnalyzer.GraphicItemHorizontalLineAdd for horizontal lines

•	WaveformAnalyzer.GraphicItemVerticalLineAdd for vertical lines

•	WaveformAnalyzer.GraphicItemWaveRangeAdd for wave ranges

nGraphicItemType

Type of graphic item.

Supported values are the following:

Mnemonic constant	Numeric value	Meaning
GRAPHIC_ITEM_VERTICAL_LINE	0	Vertical line
GRAPHIC_ITEM_HORIZONTAL_LINE	1	Horizontal line
GRAPHIC_ITEM_WAVE_RANGE	2	Wave range

nFlags

Can be a combination of the following values:

Value	Meaning
1	Set if left mouse button is down (defined as MK_LBUTTON inside the Windows SDK)
2	Set if right mouse button is down (defined as MK_RBUTTON inside the Windows SDK)
4	Set if keyboard's SHIFT key is down (defined as MK_SHIFT inside the Windows SDK)
8	Set if keyboard's CTRL key is down (defined as MK_CONTROL inside the Windows SDK)
16 (hex 10)	Set if middle mouse button is down (defined as MK_MBUTTON inside the Windows SDK)

xPos

Horizontal position, expressed in pixels respect to the waveform's client area, where the mouse generated the notification

yPos

Vertical position, expressed in pixels respect to the waveform's client area, where the mouse generated the notification