Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpMarkupPostIt Class Reference

The HOpMarkupPostIt class inserts and manipulates annotation into the current scene. More...

#include <HOpMarkupPostIt.h>

List of all members.

Public Member Functions

virtual const char * GetName ()
 HOpMarkupPostIt (HBaseView *view, int DoRepeat=0, int DoCapture=1)
virtual int OnLButtonDown (HEventInfo &hevent)

Detailed Description

The HOpMarkupPostIt class inserts and manipulates annotation into the current scene.

HOpMarkupPostIt implements three mouse event methods defined on the base class and maps the event information to operator routines. This operation consists of the following steps:

  1. Left Button Down: new annotation created/annotation selected
  2. Left Button Down and Drag: dragging
  3. Left Button Up: operation ended

More Detailed Description: see event methods


Constructor & Destructor Documentation

HOpMarkupPostIt::HOpMarkupPostIt ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1 
)

Constructs an HOpMarkupPostIt object.

Parameters:
viewA pointer to an HBaseView object
DoRepeatAn integer denoting whether this is a repeatable operator. This parameter has been deprecated.
DoCaptureAn integer denoting whether the mouse state should be captured, which means that all mouse events should be received after a mousedown, even if it leaves the window. This parameter has been deprecated.

Member Function Documentation

virtual const char* HOpMarkupPostIt::GetName ( ) [virtual]
Returns:
A pointer to a character string denoting the name of the operator, 'HOpMarkupPostIt'

Reimplemented from HOpMarkupAnnotate.

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

OnLButtonDown either selects an existing annotation or inserts a new annotation into the current markup layer at the current mouse position.

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

Reimplemented from HOpMarkupAnnotate.


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