NoteKey Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class NoteKeyTab, Class DefNoteTrack, Class Animatable.

Description:

This class contains the data for a single note of a Note track in Track View. This includes the time, text and flags for the notes.

Data Members:

TimeValue time;

The time of the note.

MSTR note;

The text of the note.

DWORD flags;

The note flags. One or more of the following values:

NOTEKEY_SELECTED

The key is selected.

NOTEKEY_LOCKED

The key is locked.

NOTEKEY_FLAGGED

The key is flagged.

#include <notetrck.h>

Inheritance diagram for NoteKey:

List of all members.

Public Member Functions
	NoteKey (TimeValue t, const MSTR &n, DWORD f=0)
	NoteKey (NoteKey &n)
void	SetFlag (DWORD mask)
void	ClearFlag (DWORD mask)
BOOL	TestFlag (DWORD mask)
Public Attributes
TimeValue	time
MSTR	note
DWORD	flags

---

Constructor & Destructor Documentation

NoteKey	(	TimeValue	t,
		const MSTR &	n,
		DWORD	f = 0
	)		[inline]

Remarks:

Constructor. The data members are initialized to the values passed.

{time=t;note=n;flags=f;}

NoteKey

(

NoteKey &

n

)

[inline]

Remarks:

Constructor. The data members are initialized from the NoteKey passed.

{time=n.time;note=n.note;flags=n.flags;}

---

Member Function Documentation

void SetFlag

(

DWORD

mask

)

[inline]

Search for all occurrences

Remarks:

Sets the specified flags.

Parameters:

DWORD mask

The flags to set.

{ flags|=(mask); }

void ClearFlag

(

DWORD

mask

)

[inline]

Search for all occurrences

Remarks:

Clears (sets to zero) the specified flags.

Parameters:

DWORD mask

The flags to clear.

{ flags &= ~(mask); }

BOOL TestFlag

(

DWORD

mask

)

[inline]

Search for all occurrences

Remarks:

Tests the specified flags. Returns TRUE if set; otherwise FALSE.

Parameters:

DWORD mask

The flags to test.

{ return(flags&(mask)?1:0); }

---

Member Data Documentation

TimeValue time

Search for all occurrences

MSTR note

Search for all occurrences

DWORD flags

Search for all occurrences