The HOpObjectAnnotate class provides support for attaching text to an object. More...
#include <HOpObjectAnnotate.h>
Public Member Functions | |
virtual HBaseOperator * | Clone () |
virtual const char * | GetName () |
HOpObjectAnnotate (HBaseView *view, int DoRepeat=0, int DoCapture=1) | |
virtual int | OnKeyDown (HEventInfo &hevent) |
virtual int | OnLButtonDown (HEventInfo &hevent) |
virtual int | OnNoButtonDownAndMove (HEventInfo &hevent) |
Static Public Member Functions | |
static void | AnnotateObject (HBaseView *pView, const char *segment, char *AnnotationText, HPoint lineStart, HPoint lineEnd, bool emit_message) |
static void | AnnotateObjectFromMessage (HBaseView *pView, const char *in_data, unsigned int data_length) |
Protected Member Functions | |
void | finalize_text () |
The HOpObjectAnnotate class provides support for attaching text to an object.
HOpObjectAnnotate implements three mouse event handlers and one keypress handler defined on the base class and maps the event information to HOOPS routines which insert an annotation line and text. This second point in this line is used as the insertion point for text. This provides the basic functionality for annotating objects with useful information. The operation consists of the following steps:
More Detailed Description: see event methods.
HOpObjectAnnotate::HOpObjectAnnotate | ( | HBaseView * | view, |
int | DoRepeat = 0 , |
||
int | DoCapture = 1 |
||
) |
Constructs an HOpObjectAnnotate object.
view | A pointer to an HBaseView object, |
DoRepeat | An integer denoting whether this is a repeatable operator. This parameter has been deprecated. |
DoCapture | An 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. |
static void HOpObjectAnnotate::AnnotateObject | ( | HBaseView * | pView, |
const char * | segment, | ||
char * | AnnotationText, | ||
HPoint | lineStart, | ||
HPoint | lineEnd, | ||
bool | emit_message | ||
) | [static] |
This is a utility function which creates an annotation.
pView | A pointer to HBaseView object. |
segment | The name of the segment to insert text into. |
AnnotationText | The annotation text string to insert. |
lineStart | The location of the beginning of the annotation line. |
lineEnd | The location of the end of the annotation line. |
emit_message | Pass true to indicate that a message should be sent to the emit_message_function, which (if implemented) would typically use the HOOPS/Net 'Send' function to dispatch the message to clients. |
static void HOpObjectAnnotate::AnnotateObjectFromMessage | ( | HBaseView * | pView, |
const char * | in_data, | ||
unsigned int | data_length | ||
) | [static] |
This method annotates an object based on the information in the message.
pView | A pointer to HBaseView object. |
in_data | A character pointer containing the annotation information. |
data_length | The size of the in_data. |
Referenced by HAnnotateObjectMessageHandler::ProcessMessage().
virtual HBaseOperator* HOpObjectAnnotate::Clone | ( | ) | [virtual] |
Creates a new operator which is a copy of the current operator. The user is responsible for deleting the newly created operator.
Reimplemented from HBaseOperator.
void HOpObjectAnnotate::finalize_text | ( | ) | [protected] |
This is a cleanup method that moves annotation from construction segment to the include segment.
virtual const char* HOpObjectAnnotate::GetName | ( | ) | [virtual] |
Reimplemented from HBaseOperator.
virtual int HOpObjectAnnotate::OnKeyDown | ( | HEventInfo & | hevent | ) | [virtual] |
OnKeyDown inserts annotation text near the second point in the annotation line. The text field is terminated by a carriage return event. To erase, use the backspace key.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
virtual int HOpObjectAnnotate::OnLButtonDown | ( | HEventInfo & | hevent | ) | [virtual] |
OnLButtonDown records the first pointer position and initiates the line-drawing mechanism. If the annotation line has already been started, OnLButtonDown finishes the line and prepares for text to be entered as described in OnKeyDown.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
virtual int HOpObjectAnnotate::OnNoButtonDownAndMove | ( | HEventInfo & | hevent | ) | [virtual] |
OnNoButtonDownAndMove draws a rubberbanded line from the first point to the current mouse position.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.