PushTool Class Reference

This class handles the Push Tool that is used to slide the document about in a more convienient way than using the scroll bars. Most of the hard work is done in the OpPush (The push operation). More...

#include <pushtool.h>

Inheritance diagram for PushTool:

List of all members.

Public Member Functions
	PushTool ()
	Dummp Constructor - It does nothing. All the real initialisation is done in PushTool::Init which is called by the Tool Manager.
virtual	~PushTool ()
	Destructor. Does nothing.
virtual BOOL	Init ()
	Used to check if the Tool was properly constructed.
virtual void	Describe (void *InfoPtr)
	Allows the tool manager to extract information about the tool.
virtual UINT32	GetID ()
virtual void	SelectChange (BOOL)
	When selected, creates a push-tool cursor object and pushes it on the cursor stack; when deselected pops the cursor from the stack and deletes it.
virtual void	OnClick (DocCoord, ClickType, ClickModifiers, Spread *)
	To handle a Mouse Click event for the Push Tool. It starts up a Push Operation.
BOOL	GetStatusLineText (String_256 *ptext, Spread *, DocCoord, ClickModifiers)
	Get status line help text for push tool when over doc.
void	OnMouseMove (DocCoord, Spread *, ClickModifiers)
	immediately updates status line text
Private Member Functions
	CC_DECLARE_MEMDUMP (PushTool)
Private Attributes
Cursor *	pcPushCursor
INT32	CurrentCursorID
ZoomInfoBarOp *	pPushInfoBarOp
Static Private Attributes
static TCHAR *	FamilyName = _T("View Tools")
static TCHAR *	ToolName = _T("Push Tool")
static TCHAR *	Purpose = _T("To push the document around")
static TCHAR *	Author = _T("Rik")

---

Detailed Description

This class handles the Push Tool that is used to slide the document about in a more convienient way than using the scroll bars. Most of the hard work is done in the OpPush (The push operation).

Author:

Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>

Date:

20/7/93

Definition at line 137 of file pushtool.h.

---

Constructor & Destructor Documentation

PushTool::PushTool (   )

Dummp Constructor - It does nothing. All the real initialisation is done in PushTool::Init which is called by the Tool Manager. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 See also: PushTool::Init Definition at line 160 of file pushtool.cpp. : pcPushCursor(NULL), pPushInfoBarOp(NULL) { // Dummy constructor }

PushTool::~PushTool (   )  [virtual]

Destructor. Does nothing. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 Definition at line 181 of file pushtool.cpp. { // Dummy destructor }

---

Member Function Documentation

PushTool::CC_DECLARE_MEMDUMP (  PushTool   )  [private]

void PushTool::Describe (  void *  InfoPtr  )  [virtual]

Allows the tool manager to extract information about the tool. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 Parameters: InfoPtr  - A pointer to a tool info block. It is passed cast to void* as [INPUTS] the version of the tool is unknown at this point. Later versions of the Tool class may have more items in this block, that this tool will not use InfoPtr  - The structure pointed to by InfoPtr will have had all the info [OUTPUTS] that this version of the Tool knows about Reimplemented from Tool_v1. Definition at line 268 of file pushtool.cpp. { // Cast structure into the latest one we understand. ToolInfo_v1 *Info = (ToolInfo_v1 *) InfoPtr; Info -> InfoVersion = 1; Info -> InterfaceVersion = GetToolInterfaceVersion(); // You should always have this line. // These are all arbitrary at present. Info -> Version = 1; Info -> ID = GetID(); Info -> TextID = _R(IDS_PUSH_TOOL); Info -> Family = FamilyName; Info -> Name = ToolName; Info -> Purpose = Purpose; Info -> Author = Author; Info -> InfoBarDialog = 0; Info->BubbleID = _R(IDBBL_PUSH_TOOLICON); }

virtual UINT32 PushTool::GetID (  void   )  [inline, virtual]

Reimplemented from Tool_v1. Definition at line 148 of file pushtool.h. { return TOOLID_PUSH; };

BOOL PushTool::GetStatusLineText (  String_256 *  pText, Spread *  , DocCoord  , ClickModifiers  )  [virtual]

Get status line help text for push tool when over doc. Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 26/1/95 Parameters: Spread*,DocCoords,ClickModifiers  - unused [INPUTS] pText  - [OUTPUTS] Returns: TRUE if pText holds valid text Errors: this==NULL Reimplemented from Tool_v1. Definition at line 464 of file pushtool.cpp. { ERROR2IF(this==NULL, FALSE,"PushTool::GetStatusLineText() - this==NULL"); ERROR2IF(pText==NULL,FALSE,"PushTool::GetStatusLineText() - pText==NULL"); return pText->Load(_R(IDS_PUSHTOOL_STATUSHELP)); }

BOOL PushTool::Init (  void   )  [virtual]

Used to check if the Tool was properly constructed. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 Returns: FALSE if it does not want to be created, TRUE otherwise See also: PushTool::PushTool Reimplemented from Tool_v1. Definition at line 200 of file pushtool.cpp. { /* // Claim right-alt for our tool. ToolKeyClaimDetails Mods; Mods.Value = 0; Mods.Keys.Alternative2 = TRUE; ClaimToolKey((Tool*) this, Mods); */ // Initially, no cursor. pcPushCursor = 0; // RALPH don't need no sissy infobar #if defined(EXCLUDE_FROM_RALPH) return OpPush::Declare(); #else pPushInfoBarOp = new ZoomInfoBarOp(_R(IDD_PUSHINFO)); // Push tool uses a zoom info bar BOOL ok=(pPushInfoBarOp!=NULL); #if 0 // Load in the info-bar stuff. CCResTextFile file; // Resource File ZoomInfoBarOpCreate BarCreate; // Object that creates PushInfoBarOp objects BOOL ok = file.open(_R(IDM_PUSH_BAR), _R(IDT_INFO_BAR_RES)); // Open resource if (ok) ok = DialogBarOp::ReadBarsFromFile(file, BarCreate); // Read & create bar if (ok) file.close(); // Close resource ENSURE(ok,"Unable to load PUSHBAR.INI from resource\n"); if (ok) { // Info bar now exists. Now get a pointer to it. String_32 str(_R(IDS_PUSHTOOL_INFOBARNAME)); DialogBarOp* pDialogBarOp = DialogBarOp::FindDialogBarOp(str); ok = (pDialogBarOp != NULL); if (ok) ok = pDialogBarOp->IsKindOf(CC_RUNTIME_CLASS(ZoomInfoBarOp)); if (ok) pPushInfoBarOp = (ZoomInfoBarOp*) pDialogBarOp; ENSURE(ok,"Couldn't find push tool info bar"); } #endif // Register our push operation. return ok && OpPush::Declare(); #endif }

void PushTool::OnClick (  DocCoord  PointerPos, ClickType  Click, ClickModifiers  ClickMods, Spread *  pSpread )  [virtual]

To handle a Mouse Click event for the Push Tool. It starts up a Push Operation. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 Parameters: PointerPos  - The Coords (in DocCoords) of the point where the mouse button [INPUTS] was clicked Click - Describes the type of click that was detected. ClickMods - Indicates which buttons caused the click and which modifers were pressed at the same time pSpread - Pointer to the spread that the click was on Returns: TRUE if it handled the Click, FALSE otherwise See also: Tool::MouseClick; ClickType; ClickModifiers Reimplemented from Tool_v1. Definition at line 316 of file pushtool.cpp. { if (ClickMods.Menu) return; // Don't do anything if the user clicked the Menu button // Make sure this click is one that we want if ( Click == CLICKTYPE_SINGLE ) { #ifdef RALPH //Graham 20/9/96: If we're in Ralph, clicking on a Hot Link activates it. //The one exception to this rule is if CTRL is pressed, in which case //the tool acts as normal. //So, is CTRL pressed? if (!(ClickMods.Constrain)) { //No. Are we on a Hot Link? Let's try and find one. //First, find a Hot Link Node* pHotLinkNode= DocView::FindHotLinkNode(PointerPos); //If we've found one, go to that Hot Link if (pHotLinkNode) { DocView::GoToHotLink((AttrUser*) pHotLinkNode); return; } } //If CTRL was pressed, or if we weren't over a Hot Link, we treat //the click as a normal Push drag. Read on... #endif //Ralph // Just what we wanted - Someone is dragging the mouse about // We need to make an operation to perform the drag with OpPush* pOpPush = new OpPush; if (pOpPush == NULL) { // Failed to get the memory to do the job // I guess we should just ignore the click, though the user is going to // wonder just what is happening! // TRACE( _T("The Push Operation could not start due to lack of memory\n") ); // Inform the person doing the clicking that life is not looking so good InformError( _R(IDS_OUT_OF_MEMORY), _R(IDS_OK) ); } else { // Start the drag operation and pass in the Anchor Point to the push operation pOpPush -> DoDrag( PointerPos ); } } }

void PushTool::OnMouseMove (  DocCoord  dcPoint, Spread *  pSpread, ClickModifiers  mods )  [virtual]

immediately updates status line text Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 26/1/95 Parameters: DocCoord,Spread*  ClickModifiers - only used in Ralph [INPUTS] In Ralph, updates status line text and changes the cursor. Reimplemented from Tool_v1. Definition at line 484 of file pushtool.cpp. { #ifdef RALPH //Graham 20/9/96. //We need to check if the zoom tool's over a Hot Link. If it is, the cursor changes //to a pointing hand. //The one exception is if CTRL is pressed, in which case the cursor is the //normal Push tool cursor (Disabled at the moment) //First, try and find a node with a Hot Link AttrUser* pHotLinkNode= (AttrUser*) DocView::FindHotLinkNode(dcPoint); if (pHotLinkNode && !(mods.Constrain)) { //Yes. So change the cursor to a pointing hand ChangeCursor(Cursor::PointingHand); //And now to update the status bar of the browser //So first get a pointer to the document //And a pointer to the Ralph document... Document* ThisDoc=Document::GetSelected(); RalphDocument* ThisRalphDoc=ThisDoc->GetRalphDoc(); ERROR3IF(ThisRalphDoc==NULL, "DocView::OnMouseMoveWithNoTool has no Ralph Doc"); //Then get the base URL of this Ralph document as a Web Address WebAddress wBase(ThisRalphDoc->GetBaseURL()); //And get the URL of this node as a Web Address WebAddress wEmbedded(pHotLinkNode->GetWebAddress()); //This function makes wEmbedded into an absolute URL (if necessary) wEmbedded.Combine(wBase); //Make the Web Address into a normal string String_256 strEmbedded=wEmbedded.GetWebAddress(); //And put that URL into the status bar string String_256 sPushTool; sPushTool.MakeMsg(_R(IDS_PUSHTOOL_HOTLINK), (TCHAR*) strEmbedded); //And tell the Ralph document to show the string in the browser's status //bar ThisRalphDoc->SetStatusBar(&sPushTool); } else { //No, the cursor is not over a Hot Link or CTRL is pressed //Change the cursor to the standard Push tool cursor //and display a standard message in the browser status bar ChangeCursor(pcPushCursor); String_256 StringToPass(_R(IDS_RALPH_PUSHTOOLSTR)); DocView::SetBrowserStatusBar(&StringToPass); } #endif //RALPH #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) if (this!=NULL) { String_256 text(""); if (text.Load(_R(IDS_PUSHTOOL_STATUSHELP))) GetApplication()->UpdateStatusBarText(&text); } else ERROR3("PushTool::OnMouseMove() - this==NULL"); #endif }

void PushTool::SelectChange (  BOOL  isSelected  )  [virtual]

When selected, creates a push-tool cursor object and pushes it on the cursor stack; when deselected pops the cursor from the stack and deletes it. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/93 Parameters: A  flag which if TRUE means the tool has just been selected, if FALSE that [INPUTS] the tool is being deselected. -  [OUTPUTS] Returns: - Errors: - See also: Tool_v1::SelectChange Reimplemented from Tool_v1. Definition at line 393 of file pushtool.cpp. { if (isSelected) { // This tool has just been selected. Create our cursor and push it on the cursor // stack. pcPushCursor = new Cursor(this, _R(IDC_PUSHTOOLCURSOR)); #ifdef RALPH //Graham 20/9/96. This cursor is needed to activate //HotLinks (TM) in Ralph (TM). The cursor is a static member of //the Cursor class and so we don't need to delete it. pcHotLinkCursor = Cursor::PointingHand; #endif //Ralph if (!pcPushCursor) { TRACE( _T("Couldn't create push-tool cursor!\n")); return; } CurrentCursorID = CursorStack::GPush(pcPushCursor, FALSE); // don't display just yet #if !defined(EXCLUDE_FROM_RALPH) pPushInfoBarOp->Create(); #endif // good to see Neville's back into his old habits of leaving huge swathes of redundant code all over the place // Which blobs do I want displayed // Used to declare an interest in no blobs which meant that all blobs disappeared // when this tool is selected. Now try not to affect this by not declaring an // interest. // Changed by Neville 16/8/94 // BlobManager* BlobMgr = GetApplication()->GetBlobManager(); // if ((BlobMgr != NULL) && (Document::GetCurrent() != NULL)) // { // // Decide which blobs to display // BlobStyle MyBlobs; // // We want them all off, which is the default // // tell the blob manager // BlobMgr->ToolInterest(MyBlobs); // } } else { // This tool is being deselected, so pop our cursor from the stack and deallocate it. if (pcPushCursor) { CursorStack::GPop(CurrentCursorID); delete pcPushCursor; CurrentCursorID = 0; } #if !defined(EXCLUDE_FROM_RALPH) pPushInfoBarOp->Delete(); #endif } }

---

Member Data Documentation

TCHAR * PushTool::Author = _T("Rik") [static, private]

Definition at line 177 of file pushtool.h.

INT32 PushTool::CurrentCursorID [private]

Definition at line 170 of file pushtool.h.

TCHAR * PushTool::FamilyName = _T("View Tools") [static, private]

Definition at line 174 of file pushtool.h.

Cursor* PushTool::pcPushCursor [private]

Definition at line 157 of file pushtool.h.

ZoomInfoBarOp* PushTool::pPushInfoBarOp [private]

Definition at line 171 of file pushtool.h.

TCHAR * PushTool::Purpose = _T("To push the document around") [static, private]

Definition at line 176 of file pushtool.h.

TCHAR * PushTool::ToolName = _T("Push Tool") [static, private]

Definition at line 175 of file pushtool.h.

---

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

• tools/pushtool.h (r1785/r1282)
• tools/pushtool.cpp (r1785/r1464)

---