OpPaste Class Reference

This class represents the Paste operation. When executed this takes a copy of all objects on the internal clipboard and adds them to the visible spread. More...

#include <cutop.h>

Inheritance diagram for OpPaste:

List of all members.

Public Member Functions
	OpPaste ()
	OpPaste constructor.
void	Do (OpDescriptor *)
	Performs the Paste operation.
void	DoWithParam (OpDescriptor *, OpParam *pOpParam)
	Performs the Paste operation using the give param object. This mechanism is used by the "paste at position" op, utilised by the OLE drag & drop system.
Static Public Member Functions
static BOOL	Init ()
	OpPaste initialiser method.
static OpState	GetState (String_256 *, OpDescriptor *)
	For finding OpPaste's state.
static BOOL	RemoveNamesAlreadyUsedInStretching (Node *pAttrib, UndoableOperation *pOp)
	Remove set information from pasted attributes if that name would interfere with stretching if added... Notes: Made static so that it can also be used by the PasteAttributes operation.
Protected Member Functions
void	DoPaste (OpDescriptor *, Spread *pSpread, DocCoord *pCentre)
	Helper function for Do() & DoWithParam(), which in turn interfaces with DoPasteStandard() (don't look at me - I didn't design this stuff).
BOOL	FindCentreInsertionPosition (Spread **Spread, DocCoord *Position)
	Finds the centre insertion position for clipboard objects.
BOOL	DoPasteStandard (BOOL PasteAtSamePos, BOOL ExternalData, Spread *pSpread=NULL, DocCoord *pCentre=NULL)
	Pastes the contents of the clipboard into the current document.

---

Detailed Description

This class represents the Paste operation. When executed this takes a copy of all objects on the internal clipboard and adds them to the visible spread.

Author:

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

Date:

9/7/93

Definition at line 213 of file cutop.h.

---

Constructor & Destructor Documentation

OpPaste::OpPaste (   )

OpPaste constructor. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 29/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 727 of file cutop.cpp. : SelOperation() { }

---

Member Function Documentation

void OpPaste::Do (  OpDescriptor *  WhichOp  )  [virtual]

Performs the Paste operation. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 16/8/93 Parameters: OpDescriptor  (unused) [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from Operation. Reimplemented in OpTextPaste. Definition at line 852 of file cutop.cpp. { DoPaste(WhichOp,NULL,NULL); }

void OpPaste::DoPaste (  OpDescriptor *  WhichOp, Spread *  pSpread, DocCoord *  pCentre )  [protected]

Helper function for Do() & DoWithParam(), which in turn interfaces with DoPasteStandard() (don't look at me - I didn't design this stuff). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 10/10/96 Parameters: WhichOp  = ptr to op descriptor [INPUTS] pSpread = ptr to spread to paste objects into (can be NULL) pCentre = coord of centre point of paste destination (can be NULL if pSpread is NULL) -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 917 of file cutop.cpp. { BeginSlowJob(-1, FALSE); // Make sure we have a simple hourglass, without a delay // Check with the clipboard if it is OK to go ahead. If the clipboard contents are // currently external, this means it'll have to import them into the InternalClipboard // before we can actually copy them into our document. InternalClipboard *Clipboard = InternalClipboard::Instance(); BOOL ExternalObjects; BOOL ok = (Clipboard!=NULL && Clipboard->PrepareForPaste(&ExternalObjects)); if (ok) { // We paste at the same position if the operation was invoked via the PASTEATSAMEPOS OpDescriptor // and the stuff we are pasting has not come from an external source. BOOL PasteAtSamePos = (((WhichOp->Token) == String(OPTOKEN_PASTEATSAMEPOS)) && (!ExternalObjects)); ok = DoPasteStandard(PasteAtSamePos, ExternalObjects, pSpread, pCentre); } if (ok) ok = Clipboard->PasteCompleted(); if (!ok) FailAndExecute(); EndSlowJob(); End(); }

BOOL OpPaste::DoPasteStandard (  BOOL  PasteAtSamePos, BOOL  ExternalData, Spread *  pSpread = NULL, DocCoord *  pCentre = NULL )  [protected]

Pastes the contents of the clipboard into the current document. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> / Mike Date: 28/7/94 Parameters: PasteAtSamePos,:  TRUE if we should paste the objects at their existing positions. [INPUTS] FALSE if they should be pasted in the centre of the view ExternalData: This flag indicates that the data has come from the external clipboard. We transform all objects in the clipboard to the centre of the view whenever this flag is set. This is so that subsequent PasteAtSamePos operations position the objects somewhere sensible. pSpread: ptr to insertion spread. If NULL, spread in the centre of the current view is used AND pCentre is ignored. pCentre: ptr to coord defining the centre of the paste. if PasteAtSamePos is TRUE, this coord is not used (I think! - Markn) Parameters: -  [OUTPUTS] Returns: - Errors: - Scope: protected See also: - Changes: 1/6/95 - Fixed the error recovery mechanisms so they don't leave the undo system in a state. Made this function more accessible to derived classes. Definition at line 1071 of file cutop.cpp. { // Assume failure until told otherwise BOOL HasFailed=TRUE; Spread* InsertionSpread = pSpread; DocCoord PastePosition; if (InsertionSpread == NULL) { if (!FindCentreInsertionPosition(&InsertionSpread, &PastePosition)) return FALSE; } else { ERROR3IF(pCentre == NULL,"You've supplied a spread, but no centre coord. Are you mad?"); if (pCentre != NULL) PastePosition = *pCentre; } ERROR3IF(InsertionSpread == NULL,"Spread is NULL"); // ----------------------------------- // This is an horrendous bodge! // What's the point passing in a centre of the routine insists on calculating it for itself? // Ho hum... // If the data has come from the outside world it's original position is unknown // So now that the user has committed themselves to pasting at a certain position // record that as being the data's "original position". if (ExternalData) { InternalClipboard::SetOriginalCentrePoint(PastePosition); } // If trying to paste data at its original position // Then retrieve that info from the clipboard and use it as the paste position if (PasteAtSamePos) { PastePosition = InternalClipboard::GetOriginalCentrePoint(); } // ----------------------------------- if (InsertionSpread != NULL) { Node* Current; InternalClipboard* IntClip = InternalClipboard::Instance(); if (IntClip==NULL) { ERROR3("Could not find internal clipboard"); goto EndOperation; } BOOL FirstObjectCopied = TRUE; DocRect ObjectsBounds; DocCoord CentreOfObjectsBounds; // Create the transform to be applied to all pasted objects ObjectsBounds = IntClip->GetObjectsBounds(); CentreOfObjectsBounds.x = ObjectsBounds.lo.x + (ObjectsBounds.Width()/2); CentreOfObjectsBounds.y = ObjectsBounds.lo.y + (ObjectsBounds.Height()/2); Trans2DMatrix ObjectTrans (PastePosition.x - CentreOfObjectsBounds.x, PastePosition.y - CentreOfObjectsBounds.y); // Set the selected spread (assume it is in the Selected Doc and DocView - an // ENSURE will occur if this turns out not to be the case!) // NOTE selected spread should change due to a change in the sel range! Document::SetSelectedViewAndSpread(NULL, NULL, InsertionSpread); // Get the current tool Tool* pTool = Tool::GetCurrent(); Spread* pSelSpread = Document::GetSelectedSpread(); // Get the tool to remove all its blobs before we deselect the nodes. // Only do this if the current tool dosent update itself on sel changed messages if (pSelSpread!=NULL && pTool!=NULL && !pTool->AreToolBlobsRenderedOnSelection()) pTool->RenderToolBlobs(pSelSpread,NULL); if (!DoStartSelOp(FALSE, TRUE)) // Try to record the selection state goto EndOperation; // After the operation ends we will need to inform all DocComponents in the // destination document of the outcome. InformDocComponentsOfOperationsOutcome(GetWorkingDoc()); // Inform all DocComponents in the destination doc that a copy is about to take place BOOL ok; CALL_WITH_FAIL((GetWorkingDoc()->StartComponentCopy()),this, ok) if (!ok) { // Start Component copy has failed so abort operation // Note that AbortComponentCopy will have been called goto EndOperation; } Current = IntClip->GetInsertionLayer()->FindFirstChild(); // Create a range of all clipboard objects which are about to be copied // Selected + Unselected + don't cross layers // DMc - also need to set the PromoteToParent flag Range ClipRange(Current,NULL,RangeControl(TRUE,TRUE,FALSE, FALSE, FALSE, FALSE, FALSE, FALSE)); Node* FirstCopiedObj = NULL; Node* Copy; // Now we try and copy all clipboard nodes while (Current != NULL) { // Make a copy of Current CALL_WITH_FAIL(Current->NodeCopy(&Copy), this, ok); if (!ok) goto EndOperation; // Sanity check, will vapourise in retails ENSURE(Copy->IsKindOf(CC_RUNTIME_CLASS(NodeRenderableBounded)), "Object being pasted is not a NodeRenderableBounded"); // Remember the first copy we make if (FirstCopiedObj == NULL) FirstCopiedObj = Copy; NodeRenderableBounded* pBoundCopy = (NodeRenderableBounded*)Copy; // Insert object if (!DoInsertNewNode(pBoundCopy, (Spread*)NULL, // Selected spread FALSE, // Dont Invalidate region FirstObjectCopied // Only clear the selection if this is the // first object being copied )) { // Tidyup Copy->CascadeDelete(); delete Copy; goto EndOperation; } // Now translate the object into the correct position. // Note: This has to be done even when PasteInPlace is operational because // the clipboard may have moved the objects ready for OLE external use. pBoundCopy->Transform(ObjectTrans); // Now call PostDuplicate on the copied node aand all it's children BOOL ok = TRUE; Node* pCurrent = pBoundCopy->FindFirstDepthFirst(); while (pCurrent!=NULL && ok) { ok = pCurrent->PostDuplicate(this); pCurrent = pCurrent->FindNextDepthFirst(pBoundCopy); } // We also need to invalidate the region of the node now that it has been transformed if (!ok || !DoInvalidateNodeRegion(pBoundCopy, TRUE, FALSE)) { // Tidyup Copy->CascadeDelete(); delete Copy; goto EndOperation; } // Normalise the attributes ((NodeRenderableInk*) pBoundCopy)->NormaliseAttributes(); // remove any name attribs from the clipboard pasted object (sjk 15/8/00) Node * pAttrib = SliceHelper::FindNextNameNode(pBoundCopy,pBoundCopy); while (pAttrib) { BOOL leave = RemoveNamesAlreadyUsedInStretching(pAttrib, this); Node * pDelMe = pAttrib; pAttrib = SliceHelper::FindNextNameNode(pAttrib,pBoundCopy); if (!leave) { pDelMe->UnlinkNodeFromTree(); delete pDelMe; } } // Get the next object from the clipboard to copy Current = Current->FindNext(); FirstObjectCopied = FALSE; } ENSURE(FirstCopiedObj != NULL, "No nodes were copied"); if (FirstCopiedObj == NULL) goto EndOperation; // We now need to ask all copied nodes to copy their component data to the // current document Range CopiedRange(FirstCopiedObj, Copy, RangeControl(TRUE,TRUE,FALSE)); CALL_WITH_FAIL((CopiedRange.CopyComponentDataToDoc(IntClip, pOurDoc)), this, ok); if (!ok) goto EndOperation; // THIS MUST BE LAST! HasFailed = FALSE; } EndOperation: return (!HasFailed); }

void OpPaste::DoWithParam (  OpDescriptor *  WhichOp, OpParam *  pOpParam )  [virtual]

Performs the Paste operation using the give param object. This mechanism is used by the "paste at position" op, utilised by the OLE drag & drop system. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 10/10/96 Parameters: WhichOp  = ptr to op descriptor [INPUTS] pOpParam = ptr to the params (must be an OpParamPasteAtPosition object) -  [OUTPUTS] Returns: - pOpParam should be a ptr to an OpParamPasteAtPosition, so that the spread and centre coord of the paste can be passed in. If pOpParam is not an OpParamPasteAtPosition, the op fails Returns: Errors: - See also: - Reimplemented from Operation. Definition at line 880 of file cutop.cpp. { if (pOpParam != NULL && IS_A(pOpParam,OpParamPasteAtPosition)) { OpParamPasteAtPosition* pPasteParam = (OpParamPasteAtPosition*)pOpParam; Spread* pSpread = pPasteParam->GetSpread(); DocCoord Centre = pPasteParam->GetCentre(); DoPaste(WhichOp,pSpread,&Centre); } else { FailAndExecute(); End(); } }

BOOL OpPaste::FindCentreInsertionPosition (  Spread **  Spread, DocCoord *  Position )  [protected]

Finds the centre insertion position for clipboard objects. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 28/7/94 Parameters: -  [INPUTS] Spread,:  The spread to place the clipboard objects on [OUTPUTS] Position:The centre of the view (Spread coords) Returns: FALSE if it failed. In this case, Spread is returned containing a NULL, and Position is returned as DocCoord(0,0) Errors: - Scope: private See also: - Definition at line 966 of file cutop.cpp. { // Let's chuck in a smattering of defensive programming ERROR3IF(Spread == NULL || Position == NULL, "Illegal NULL params"); *Spread = NULL; *Position = DocCoord(0,0); // A default value if we fail // --------------------------------------------------------------------------------- // Find out which spread is in the centre of the view // this is the spread that the pasted objects will be placed on // Obtain the current DocView DocView* CurDocView = DocView::GetCurrent(); ENSURE(CurDocView != NULL, "The current DocView is NULL"); if (CurDocView == NULL) { return FALSE; // No DocView } // Get the view rect WorkRect WrkViewRect = CurDocView->GetViewRect(); if (WrkViewRect.IsEmpty() || (!WrkViewRect.IsValid()) ) { return FALSE; // Defensive } // Determine the centre of the view WorkCoord WrkCentreOfView; WrkCentreOfView.x = WrkViewRect.lo.x + (WrkViewRect.Width()/2); WrkCentreOfView.y = WrkViewRect.lo.y + (WrkViewRect.Height()/2); // FindEnclosing spread requires an OilCoord OilCoord OilCentreOfView = WrkCentreOfView.ToOil(CurDocView->GetScrollOffsets()); // Find out which spread to insert the pasteboard objects onto (*Spread) = CurDocView->FindEnclosingSpread(OilCentreOfView); if ((*Spread) == NULL) { // There is no spread return FALSE; } // Phew // --------------------------------------------------------------------------------- // Now lets find the spread coordinate of the centre of the view DocRect DocViewRect = CurDocView->GetDocViewRect(*Spread); if ( DocViewRect.IsEmpty() || (!DocViewRect.IsValid()) ) { ERROR3("DocViewRect is invalid"); return FALSE; // Defensive } // Find the centre of the DocViewRect DocCoord DocCentreOfView; DocCentreOfView.x = DocViewRect.lo.x + (DocViewRect.Width()/2); DocCentreOfView.y = DocViewRect.lo.y + (DocViewRect.Height()/2); // -------------------------------------------------------------------------------- // Now convert from DocCoords to spread coords (*Spread)->DocCoordToSpreadCoord(&DocCentreOfView); // Finally, copy the result into the output parameter *Position = DocCentreOfView; return TRUE; }

OpState OpPaste::GetState (  String_256 *  UIDescription, OpDescriptor *  pOpDesc )  [static]

For finding OpPaste's state. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 28/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The state of the OpPaste Errors: - See also: - Reimplemented in OpTextPaste. Definition at line 808 of file cutop.cpp. { OpState OpSt; if (InternalClipboard::IsEmpty()) { // There is no data to paste, so grey out, and return a reason for greying OpSt.Greyed = TRUE; *UIDescription = String_256(_R(IDS_CLIPBOARD_EMPTY)); } else { // Otherwise, determine a string to display - always show "Paste", but if possible // add a description, e.g. "Paste quickshape", "Paste bitmap" String_64 Type; InternalClipboard::DescribeContents(&Type); if (!Type.IsEmpty() && pOpDesc->Token==String_256(OPTOKEN_PASTE)) { *UIDescription = String_256(_R(IDS_CLIPBOARD_PREPASTE)); *UIDescription += Type; } } return(OpSt); }

BOOL OpPaste::Init (  void   )  [static]

OpPaste initialiser method. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 28/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the operation could be successfully initialised FALSE if no more memory could be allocated Errors: ERROR will be called if there was insufficient memory to allocate the operation. See also: - Reimplemented from SimpleCCObject. Reimplemented in OpTextPaste. Definition at line 749 of file cutop.cpp. { BOOL ok = (RegisterOpDescriptor(0, _R(IDS_PASTEOP), CC_RUNTIME_CLASS(OpPaste), OPTOKEN_PASTE, OpPaste::GetState, 0, // help ID _R(IDBBL_PASTE), 0, // bitmap ID 0, SYSTEMBAR_ILLEGAL, // For now ! TRUE, // Receive messages FALSE, FALSE, 0, (GREY_WHEN_NO_CURRENT_DOC | DONT_GREY_WHEN_SELECT_INSIDE) )); if (ok) { // Register a second OpDescriptor, for paste at same position. This OpDescriptor // will probably never appear directly on a bar/menu so it uses the same strings // as the above. ok = (RegisterOpDescriptor(0, _R(IDS_PASTEATSAMEPOSOP), CC_RUNTIME_CLASS(OpPaste), OPTOKEN_PASTEATSAMEPOS, OpPaste::GetState, 0, // help ID _R(IDBBL_PASTEATSAMEPOS), _R(IDD_BARCONTROLSTORE), // resource ID _R(IDC_PASTEATSAMEPOS), // control ID SYSTEMBAR_EDIT, // Bar ID TRUE, // Receive messages FALSE, FALSE, 0, (GREY_WHEN_NO_CURRENT_DOC | DONT_GREY_WHEN_SELECT_INSIDE) )); } return ok; }

BOOL OpPaste::RemoveNamesAlreadyUsedInStretching (  Node *  pAttrib, UndoableOperation *  pOp )  [static]

Remove set information from pasted attributes if that name would interfere with stretching if added... Notes: Made static so that it can also be used by the PasteAttributes operation. Author: Simon_Knight (Xara Group Ltd) <camelotdev@xara.com> (put in a function of its own by Matt) Date: 22/01/2001 Parameters: -  [INPUTS] Returns: - False if the set info should not be pasted Definition at line 1299 of file cutop.cpp. { // try only removing names that has anything to do with extending String_256 Temp = SliceHelper::GetBarName((TemplateAttribute *)pAttrib); // is it a bar element? BOOL ok = Temp.IsEmpty(); SGNameItem* pGalleryItem = NULL; if (ok) { Temp = ((TemplateAttribute *)pAttrib)->GetParam(); pGalleryItem = SliceHelper::LookupNameGalleryItem(Temp); if (pGalleryItem) { // is it a trigger? if (pGalleryItem->m_IsATrigger == TRUE) // use == TRUE since it is often undefined ok = FALSE; else { // is it a target? NamedStretchProp* pProp = (NamedStretchProp*)pGalleryItem->GetProperty(NamedStretchProp::nIndex); if (pProp && !pProp->GetTriggers().empty()) ok = FALSE; } } else { // create a default property for a new set SliceHelper::CreatePropertiesForSet(Temp, TEXT(""), TRUE, FALSE, FALSE, 0, TEXT(""), TRUE, NULL, NULL, pOp); } } return ok; }

---

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

• Kernel/cutop.h (r1785/r1282)
• Kernel/cutop.cpp (r1785/r1467)

---