#include <HOpMarkupAnnotate.h>
Public Member Functions | |
virtual HBaseOperator * | Clone () |
virtual const char * | GetName () |
HOpMarkupAnnotate (HBaseView *view, bool bAddToLayer=false, int DoRepeat=0, int DoCapture=1, bool create_new_notes=true) | |
virtual int | OnKeyDown (HEventInfo &hevent) |
virtual int | OnLButtonDown (HEventInfo &hevent) |
virtual int | OnLButtonDownAndMove (HEventInfo &hevent) |
virtual int | OnLButtonUp (HEventInfo &hevent) |
virtual int | OnRButtonDown (HEventInfo &hevent) |
virtual | ~HOpMarkupAnnotate () |
Protected Member Functions | |
bool | EndOp (void) |
bool | GetAddToLayer (void) const |
HUtilityAnnotation & | GetAnnotation (void) |
int | GetBackgroundType (void) const |
bool | GetCreateNewNotes (void) const |
bool | GetHideOverlappedText (void) const |
HC_KEY | GetNoteKey (void) const |
bool | GetTouchedText (void) const |
void | SetAddToLayer (bool value) |
void | SetAnnotation (HUtilityAnnotation const &rNote) |
void | SetBackgroundType (int const type) |
void | SetCreateNewNotes (bool yesno) |
void | SetHideOverlappedText (bool onoff) |
void | SetNoteKey (HC_KEY const key) |
void | SetTouchedText (bool value) |
void | StartOp (void) |
void | TransmitMarkupSegment () |
Protected Attributes | |
HUtilityAnnotation | m_Annotation |
bool | m_bAddToLayer |
bool | m_bCreateNewNotes |
bool | m_bHideOverlappedText |
bool | m_bTouchedText |
int | m_iBackgroundType |
HC_KEY | m_pNoteKey |
HOpMarkupAnnotate 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:
HOpMarkupAnnotate::HOpMarkupAnnotate | ( | HBaseView * | view, | |
bool | bAddToLayer = false , |
|||
int | DoRepeat = 0 , |
|||
int | DoCapture = 1 , |
|||
bool | create_new_notes = true | |||
) |
Constructs an HOpMarkupAnnotate object.
view | A pointer to an HBaseView object | |
bAddToLayer | A boolean indicating whether the annotation can be added to markup layers | |
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. |
virtual HOpMarkupAnnotate::~HOpMarkupAnnotate | ( | ) | [virtual] |
Destructor
virtual HBaseOperator* HOpMarkupAnnotate::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.
Reimplemented from HBaseOperator.
bool HOpMarkupAnnotate::EndOp | ( | void | ) | [protected] |
Call this to set the operator in an inactive state.
True | of the operator was ended. False if this was called when the operator was not in progress. |
bool HOpMarkupAnnotate::GetAddToLayer | ( | void | ) | const [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
HUtilityAnnotation& HOpMarkupAnnotate::GetAnnotation | ( | void | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
int HOpMarkupAnnotate::GetBackgroundType | ( | void | ) | const [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
bool HOpMarkupAnnotate::GetCreateNewNotes | ( | void | ) | const [inline, protected] |
Accessor for this value.
bool HOpMarkupAnnotate::GetHideOverlappedText | ( | void | ) | const [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
virtual const char* HOpMarkupAnnotate::GetName | ( | ) | [virtual] |
Reimplemented from HBaseOperator.
Reimplemented in HOpMarkupPostIt.
HC_KEY HOpMarkupAnnotate::GetNoteKey | ( | void | ) | const [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
References HC_KEY.
bool HOpMarkupAnnotate::GetTouchedText | ( | void | ) | const [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
virtual int HOpMarkupAnnotate::OnKeyDown | ( | HEventInfo & | hevent | ) | [virtual] |
OnKeyDown adds and/or replaces text of the selected annotation with the character or key that was provided in hevent.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
virtual int HOpMarkupAnnotate::OnLButtonDown | ( | HEventInfo & | hevent | ) | [virtual] |
OnLButtonDown either selects an existing annotation or inserts a new annotation at the current mouse position.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
Reimplemented in HOpMarkupPostIt.
virtual int HOpMarkupAnnotate::OnLButtonDownAndMove | ( | HEventInfo & | hevent | ) | [virtual] |
OnLButtonDownAndMove computes the translation transform based on the distance between the first and current pointer positions, and translates the annotation accordingly.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
virtual int HOpMarkupAnnotate::OnLButtonUp | ( | HEventInfo & | hevent | ) | [virtual] |
OnLButtonUp finalizes movement of annotation.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
virtual int HOpMarkupAnnotate::OnRButtonDown | ( | HEventInfo & | hevent | ) | [virtual] |
OnRButtonDown finalizes movement of annotation.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
void HOpMarkupAnnotate::SetAddToLayer | ( | bool | value | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
void HOpMarkupAnnotate::SetAnnotation | ( | HUtilityAnnotation const & | rNote | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
void HOpMarkupAnnotate::SetBackgroundType | ( | int const | type | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
void HOpMarkupAnnotate::SetCreateNewNotes | ( | bool | yesno | ) | [inline, protected] |
Accessor for this value.
void HOpMarkupAnnotate::SetHideOverlappedText | ( | bool | onoff | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
void HOpMarkupAnnotate::SetNoteKey | ( | HC_KEY const | key | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
void HOpMarkupAnnotate::SetTouchedText | ( | bool | value | ) | [inline, protected] |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
void HOpMarkupAnnotate::StartOp | ( | void | ) | [protected] |
Call this to set the operator to active.
void HOpMarkupAnnotate::TransmitMarkupSegment | ( | ) | [protected] |
Transmit markup layer to HNet.
HUtilityAnnotation HOpMarkupAnnotate::m_Annotation [protected] |
The annotation object.
bool HOpMarkupAnnotate::m_bAddToLayer [protected] |
Allow annotation to be added to markup layers
bool HOpMarkupAnnotate::m_bCreateNewNotes [protected] |
If this is true, this operator will insert new node on the left mouse button.
bool HOpMarkupAnnotate::m_bHideOverlappedText [protected] |
Hide overlapped text doesn't seem to work with quickmoves so we need to keep track of it after we turn it off.
bool HOpMarkupAnnotate::m_bTouchedText [protected] |
If the text was touched at some point, then we'll need to update m_Annotation.
int HOpMarkupAnnotate::m_iBackgroundType [protected] |
Sets what type of background we're using.
HC_KEY HOpMarkupAnnotate::m_pNoteKey [protected] |
Selected annotation key