Remarks
Callback delegate invoked every time a mouse event happens on the TracksBoard: this callback can be set through a call to the CallbackTracksboardMouseNotifSet method.
The usage of this delegate is alternative to the TracksBoardMouseNotification event.
For further details about callback delegates see the How to synchronize the container application through callback delegates tutorial.
For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.
For further details about methods of the TracksBoard refer to the TracksBoard class section.
Syntax
[Visual Basic]
Public Delegate Sub CallbackTracksboardMouseNotif (
nAction as enumMouseActions,
nFlags as Int32,
xPos as Int32,
yPos as Int32,
nPressPosInPix as Int32,
nPressPosInMs as Int32
)
|
|
[C#]
public delegate void CallbackTracksboardMouseNotif (
enumMouseActions nAction,
Int32 nFlags,
Int32 xPos,
Int32 yPos,
Int32 nPressPosInPix,
Int32 nPressPosInMs
)
|
|
[C++]
public delegate void CallbackTracksboardMouseNotif (
enumMouseActions nAction,
Int32 nFlags,
Int32 xPos,
Int32 yPos,
Int32 nPressPosInPix,
Int32 nPressPosInMs
)
|
|
Parameter
|
Description
|
|
|
nAction
|
Mouse action type.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
MOUSE_ACTION_LEFT_DOWN
|
0
|
Left mouse button down
|
MOUSE_ACTION_LEFT_UP
|
1
|
Left mouse button up
|
MOUSE_ACTION_LEFT_CLICK
|
2
|
Left mouse button click
|
MOUSE_ACTION_LEFT_DBLCLICK
|
3
|
Left mouse button double click
|
MOUSE_ACTION_RIGHT_DOWN
|
4
|
Right mouse button down
|
MOUSE_ACTION_RIGHT_UP
|
5
|
Right mouse button up
|
MOUSE_ACTION_RIGHT_CLICK
|
6
|
Right mouse button click
|
MOUSE_ACTION_RIGHT_DBLCLICK
|
7
|
Right mouse button double click
|
MOUSE_ACTION_MOVE
|
8
|
Mouse move. This notification is not generated when the waveform analyzer is empty.
|
MOUSE_ACTION_MIDDLE_DOWN
|
9
|
Middle mouse button down
|
MOUSE_ACTION_MIDDLE_UP
|
10
|
Middle mouse button up
|
MOUSE_ACTION_MIDDLE_CLICK
|
11
|
Middle mouse button click
|
MOUSE_ACTION_MIDDLE_DBLCLICK
|
12
|
Middle mouse button double click
|
MOUSE_ACTION_WHEEL_SCROLL_BACK
|
13
|
Mouse wheel scroll back
|
MOUSE_ACTION_WHEEL_SCROLL_FORWARD
|
14
|
Mouse wheel scroll forward
|
|
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 client area of the whole user interface of the TracksBoard, where the mouse generated the notification
|
yPos
|
Vertical position, expressed in pixels respect to the client area of the whole user interface of the TracksBoard, where the mouse generated the notification
|
nPressPosInPix
|
Number representing the position expressed in pixels where the mouse button was pressed. If the mouse action should have been performed outside of the waveform's area, this parameter would be set to -1.
It's important to note that this parameter doesn't represent the horizontal position on the waveform's visible area (for this you can refer to the xPos parameter) but to the horizontal position in pixels calculated respect to the bitmap representation of the total waveform's width in pixels at the current horizontal zoom factor.
|
nPressPosInMs
|
Number representing the position expressed in milliseconds where the mouse button was pressed. If the mouse action should have been performed outside of the waveform's area, this parameter would be set to -1.
|
|
