Public Member Functions | |
virtual MCCOMErr MCCOMAPI | Do ()=0 |
virtual MCCOMErr MCCOMAPI | Undo ()=0 |
virtual MCCOMErr MCCOMAPI | Redo ()=0 |
virtual boolean MCCOMAPI | WillCauseChange ()=0 |
virtual boolean MCCOMAPI | CanUndo ()=0 |
virtual MCCOMErr MCCOMAPI | GetName (TMCString &name)=0 |
virtual void MCCOMAPI | Track (IMCGraphicContext *gc, int16 stage, TMCPoint &first, TMCPoint &prev, TMCPoint &cur, boolean moved, IShMouseAction **nextAction)=0 |
virtual void MCCOMAPI | TrackEx (IMCGraphicContext *gc, int16 stage, const TMFTabletMouseSample &first, const TMFTabletMouseSample &prev, const TMFTabletMouseSample &cur, boolean moved, IShMouseAction **nextAction)=0 |
virtual MCCOMErr MCCOMAPI | Feedback (IMCGraphicContext *gc, int16 stage, const TMCPoint &first, const TMCPoint &prev, const TMCPoint &cur, boolean moved, boolean show)=0 |
virtual void MCCOMAPI | GetPartToRedraw (IMFPart **outPart, int32 stage)=0 |
virtual MCCOMErr MCCOMAPI | Constrain (IMCGraphicContext *gc, int16 stage, const TMCPoint &first, const TMCPoint &prev, TMCPoint &cur, boolean moved)=0 |
virtual boolean MCCOMAPI | NeedsToPrepareMenus (void)=0 |
virtual boolean MCCOMAPI | ConstrainedToView (void)=0 |
virtual boolean MCCOMAPI | IsPerpetualMouseAction (void)=0 |
virtual boolean MCCOMAPI | ShouldHideCursor (void)=0 |
virtual boolean MCCOMAPI | ShouldAutoScroll (void)=0 |
virtual boolean MCCOMAPI | KeepTracking ()=0 |
virtual boolean MCCOMAPI | WantsTabletTracking ()=0 |
virtual boolean MCCOMAPI IShMouseAction::CanUndo | ( | ) | [pure virtual] |
Returns true if the action is undoable. If CanUndo() returns false, Undo() and Redo() should return MC_E_NOTIMPL and do nothing.
Implemented in TBasicMouseAction.
virtual MCCOMErr MCCOMAPI IShMouseAction::Constrain | ( | IMCGraphicContext * | gc, | |
int16 | stage, | |||
const TMCPoint & | first, | |||
const TMCPoint & | prev, | |||
TMCPoint & | cur, | |||
boolean | moved | |||
) | [pure virtual] |
Use this method to constrain the 'cur' position to a value, before Track() is called
gc | Graphic context for the mouse action | |
stage | kShBeginTracking, kShContinueTracking, or kShEndTracking. Tells the function what stage of tracking we're in. | |
first | Initial mouse position when this action started tracking | |
prev | Previous mouse position from the previous call of Track() | |
cur | Current mouse position - also returns constrained current mouse position | |
moved | Pass true here if the mouse has moved since the last call to Track() |
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::ConstrainedToView | ( | void | ) | [pure virtual] |
Implemented in TBasicMouseAction.
virtual MCCOMErr MCCOMAPI IShMouseAction::Do | ( | ) | [pure virtual] |
Function called to actually perform the action.
Implemented in TBasicMouseAction.
virtual MCCOMErr MCCOMAPI IShMouseAction::Feedback | ( | IMCGraphicContext * | gc, | |
int16 | stage, | |||
const TMCPoint & | first, | |||
const TMCPoint & | prev, | |||
const TMCPoint & | cur, | |||
boolean | moved, | |||
boolean | show | |||
) | [pure virtual] |
Allows the action to draw things related to the tracking. Feedback() is called for the first time right before the first call of Track(kShBeginTracking), and then Feedback() is called right after each call to Track().
gc | Graphic context for the mouse action | |
stage | kShBeginTracking, kShContinueTracking, or kShEndTracking. Tells the function what stage of tracking we're in. | |
first | Initial mouse position when this action started tracking | |
prev | Previous mouse position from the previous call of Track() | |
cur | Current mouse position | |
moved | Pass true here if the mouse has moved since the last call to Track() | |
show | Pass false here to bypass any drawing, or true to enable drawing. |
Implemented in TBasicMouseAction.
Return the name to display in the undo/redo list.
name | The name of the action |
Implemented in TBasicMouseAction.
virtual void MCCOMAPI IShMouseAction::GetPartToRedraw | ( | IMFPart ** | outPart, | |
int32 | stage | |||
) | [pure virtual] |
Gives the action the opportunity to tell the Shell that the returned part should be redrawn after Do/Undo/Redo. Return NULL in outPart if no redraw is needed.
outPart | Returns a pointer to the part that needs to be redrawn after the action runs. | |
stage | Allows you to specify what stage to query for part redraw. kShDoAction, kShUndoAction, kShRedoAction |
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::IsPerpetualMouseAction | ( | void | ) | [pure virtual] |
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::KeepTracking | ( | ) | [pure virtual] |
Returns false if you do not want the mouse action to perform any tracking. This is useful if you just want to do something on the click.
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::NeedsToPrepareMenus | ( | void | ) | [pure virtual] |
Implemented in TBasicMouseAction.
virtual MCCOMErr MCCOMAPI IShMouseAction::Redo | ( | ) | [pure virtual] |
Called to Redo the action. This can often simply call Do().
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::ShouldAutoScroll | ( | void | ) | [pure virtual] |
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::ShouldHideCursor | ( | void | ) | [pure virtual] |
Implemented in TBasicMouseAction.
virtual void MCCOMAPI IShMouseAction::Track | ( | IMCGraphicContext * | gc, | |
int16 | stage, | |||
TMCPoint & | first, | |||
TMCPoint & | prev, | |||
TMCPoint & | cur, | |||
boolean | moved, | |||
IShMouseAction ** | nextAction | |||
) | [pure virtual] |
Called each time the mouse moves. At least, Track() is called three times (even if the mouse does not move).
gc | Graphic context for the mouse action | |
stage | kShBeginTracking, kShContinueTracking, or kShEndTracking. Tells the function what stage of tracking we're in. | |
first | Initial mouse position when this action started tracking | |
prev | Previous mouse position from the previous call of Track() | |
cur | Current mouse position | |
moved | Pass true here if the mouse has moved since the last call to Track() | |
nextAction | Returns a pointer to the next action whose Track() to call. See note in function description. |
Implemented in TBasicMouseAction, and TSimpleMouseAction.
virtual void MCCOMAPI IShMouseAction::TrackEx | ( | IMCGraphicContext * | gc, | |
int16 | stage, | |||
const TMFTabletMouseSample & | first, | |||
const TMFTabletMouseSample & | prev, | |||
const TMFTabletMouseSample & | cur, | |||
boolean | moved, | |||
IShMouseAction ** | nextAction | |||
) | [pure virtual] |
Called each time the mouse moves when the mouse action is in tablet mode. At least, TrackEx() is called three times (even if the mouse does not move).
gc | Graphic context for the mouse action | |
stage | kShBeginTracking, kShContinueTracking, or kShEndTracking. Tells the function what stage of tracking we're in. | |
first | Initial mouse position when this action started tracking | |
prev | Previous mouse position from the previous call of Track() | |
cur | Current mouse position | |
moved | Pass true here if the mouse has moved since the last call to Track() | |
nextAction | Returns a pointer to the next action whose Track() to call. See note in function description. |
Implemented in TBasicMouseAction.
virtual MCCOMErr MCCOMAPI IShMouseAction::Undo | ( | ) | [pure virtual] |
Called to undo the action.
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::WantsTabletTracking | ( | ) | [pure virtual] |
Returns true if the mouse action wants to use the tablet tracking.
Implemented in TBasicMouseAction.
virtual boolean MCCOMAPI IShMouseAction::WillCauseChange | ( | ) | [pure virtual] |
Implemented in TBasicMouseAction.