Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpFramedAnnotate Class Reference

List of all members.

Public Member Functions

HBaseOperatorClone ()
virtual const char * GetName ()
 HOpFramedAnnotate (HBaseView *view, bool bAddToLayer=false, int DoRepeat=0, int DoCapture=1)
int OnKeyDown (HEventInfo &hevent)
int OnLButtonDown (HEventInfo &hevent)
int OnLButtonDownAndMove (HEventInfo &hevent)
int OnLButtonUp (HEventInfo &hevent)

Protected Member Functions

void finalize_text (bool emit_message=false)
void TransmitMarkupSegment ()

Protected Attributes

bool m_bAddToLayer
HC_KEY m_pNoteKey
unsigned short * m_pString

Member Function Documentation

HBaseOperator* HOpFramedAnnotate::Clone ( ) [virtual]

Creates a new operator which is associated with the same view as the current operator. The user is responsible for deleting the newly created operator.

Returns:
A pointer to an HBaseOperator object

Reimplemented from HBaseOperator.

virtual const char* HOpFramedAnnotate::GetName ( ) [virtual]
Returns:
A character pointer denoting the name of operator.

Reimplemented from HBaseOperator.

int HOpFramedAnnotate::OnKeyDown ( HEventInfo hevent) [virtual]

The derived operator should overload this function to intercept and handle the case where a keyboard key has been pressed down. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

Parameters:
heventAn HEventInfo object containing information about the current event
Returns:
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

int HOpFramedAnnotate::OnLButtonDown ( HEventInfo hevent) [virtual]

The derived operator should overload this function to intercept and handle the case where the left mouse button has been pressed down. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

Parameters:
heventAn HEventInfo object containing information about the current event
Returns:
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

int HOpFramedAnnotate::OnLButtonDownAndMove ( HEventInfo hevent) [virtual]

The derived operator should overload this function to intercept and handle the case where the left mouse button is pressed down and the mouse has moved. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

Parameters:
heventAn HEventInfo object containing information about the current event
Returns:
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

int HOpFramedAnnotate::OnLButtonUp ( HEventInfo hevent) [virtual]

The derived operator should overload this function to intercept and handle the case where the left mouse button has been released. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

Parameters:
heventAn HEventInfo object containing information about the current event
Returns:
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.


Member Data Documentation

allow annotation to be added to markup layers

selected annotation key

unsigned short* HOpFramedAnnotate::m_pString [protected]

returns a pointer to a copy of the operator pointer to annotation text


The documentation for this class was generated from the following file: