Class NoteKey
See Also: Class NoteKeyTab, Class DefNoteTrack, Class Animatable.
class NoteKey
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:
public:
TimeValue time;
The time of the note.
TSTR 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.
Methods:
public:
Prototype:
NoteKey(TimeValue t,const TSTR &n,DWORD f=0);
Remarks:
Constructor. The data members are initialized to the values passed.
Prototype:
NoteKey(NoteKey& n);
Remarks:
Constructor. The data members are initialized from the NoteKey passed.
Prototype:
void SetFlag(DWORD mask);
Remarks:
Sets the specified flags.
Parameters:
DWORD mask
The flags to set.
Prototype:
void ClearFlag(DWORD mask);
Remarks:
Clears (sets to zero) the specified flags.
Parameters:
DWORD mask
The flags to clear.
Prototype:
BOOL TestFlag(DWORD mask);
Remarks:
Tests the specified flags. Returns TRUE if set; otherwise FALSE.
Parameters:
DWORD mask
The flags to test.