PrintView Class Reference

#include <prntview.h>

Inheritance diagram for PrintView:

List of all members.

Public Member Functions
	PrintView (Document *)
	None.
virtual	~PrintView ()
	Destroys a printing view - this is because it has finished printing or something went wrong during printing.
virtual void	ContinueRenderView (RenderRegion *, Spread *, BOOL=TRUE, BOOL=TRUE, BOOL bForceImmediate=FALSE)
	Used by RenderRegion::DefaultRender() to carry on rendering a view. In this case (i.e. printing) it only gets called once, as it calls RenderView which prints the view in one go, i.e. we don't do background rendering.
virtual CNativeDC *	GetRenderDC ()
	Access function for the device context of this printing view object.
virtual BOOL	GetForeBackMode ()
	To find out if background rendering is on.
virtual void	SetForeBackMode (BOOL)
	Set the background render flag for this view.
virtual void	SetViewPixelSize ()
	Sets up the normal and scaled pixel sizes according to this view.
void	AttachToDC (CNativeDC *pDC)
	Attach a PrintView to a particular printer DC. We need this because there is no special 'PrintCamView' to ask for it, so ScreenCamView gives us this DC when it receives an OnDraw() call, so we know which DC to print to.
void	OnDraw (CNativeDC *, OilRect)
	Do the printing, guv.
virtual BOOL	ViewStateChanged ()
	Inform the PrintView that its OIL view object has changed the shared ViewState structure.
Matrix	ConstructRenderingMatrix (Spread *pSpread)
	From the given spread, construct a matrix that will convert spread coordinates to OS coordinates.
virtual DocRect	GetDocViewRect (Spread *)
	To find the rectangle describing the viewport onto the document.
virtual void	SetExtent (DocCoord, DocCoord)
	Informs the PrintView that the extent of the document has changed in some way and that the view must be altered to take this into account (namely the scrollbars).
virtual WorkRect	GetViewRect ()
	To find the rectangle describing the viewport onto the document.
Static Public Member Functions
static void	CorrectRotatedRectangle (Rect *)
	Patches up rectangles after having been transformed by the rendering matrix. Because printing can involve a rotation through a multiple of 90 degress, the corners can become swapped, so we check for this and swap them back around if necessary.
Public Attributes
PrintPatchInfo	PatchInfo
Protected Member Functions
void	PrintRegion (Spread *pSpread, DocRect ClipRect, CNativeDC *pDevContext, RenderType rType)
virtual void	MakeNewRenderRegion (Spread *, DocRect, CNativeDC *, RenderType, BOOL PaintPaper=FALSE, Node *pInvalidNode=NULL)
	Renders the document to the printer. This function will build all the render regions needed to do a print.
Protected Attributes
CNativeDC *	PrintDC
Friends
class	ScreenView

---

Detailed Description

Definition at line 108 of file prntview.h.

---

Constructor & Destructor Documentation

PrintView::PrintView (  Document *  pOwnerDoc  )

None. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/08/95 Parameters: pDocument  - the document to attach to (i.e. the one to print) [INPUTS] See also: PrintView; View Definition at line 143 of file prntview.cpp. { // Set up document; no CamView yet. pDoc = pOwnerDoc; pViewWindow = NULL; // No DC yet PrintDC = NULL; // BODGE ALERT!!! Do this properly sometime. pVState = new ViewState; PORTNOTE("printing", "removed broken memory handling") #ifndef EXCLUDE_FROM_XARALX if (pVState == NULL) AfxThrowMemoryException(); #endif // Connect this view state to this view pVState->pView = this; // Get print information for this document. PrintComponent *pPrint = (PrintComponent *) pOwnerDoc->GetDocComponent(CC_RUNTIME_CLASS(PrintComponent)); if (pPrint == NULL) { ERROR2RAW("Unable to find PrintComponent in document."); return; } PrintControl *pPrintControl = pPrint->GetPrintControl(); if (pPrintControl == NULL) { ERROR2RAW("Unable to find PrintControl object in document component."); return; } PrintMethodType PrintType = pPrintControl->GetPrintMethod(); // Work out whether or not to Anti-alias printing if (PrintType == PRINTMETHOD_AABITMAP) { Quality AntiAlias(Quality::QualityMax); RenderQuality = AntiAlias; } }

PrintView::~PrintView (   )  [virtual]

Destroys a printing view - this is because it has finished printing or something went wrong during printing. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/08/95 See also: PrintView; View Definition at line 201 of file prntview.cpp. { }

---

Member Function Documentation

void PrintView::AttachToDC (  CNativeDC *  pDC  )

Attach a PrintView to a particular printer DC. We need this because there is no special 'PrintCamView' to ask for it, so ScreenCamView gives us this DC when it receives an OnDraw() call, so we know which DC to print to. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/10/95 Parameters: pDC  - the printer DC to use (NULL if detaching). [INPUTS] See also: View::OnDraw; ScreenCamView::OnDraw; PrintView::SetPixelSize Definition at line 552 of file prntview.cpp. { // Use this DC. PrintDC = pDC; // If its a real DC (i.e. we are not being detached from a DC) then // get and remember the pixel size (used by PrintView::SetPixelSize()). if (PrintDC != NULL) { INT32 pixwidth = OSRenderRegion::GetFixedDCPPI(*pDC).GetWidth(); INT32 pixheight = OSRenderRegion::GetFixedDCPPI(*pDC).GetHeight();; // Set our own idea of pixel size. PixelWidth = FIXED16(72000.0 / pixwidth); PixelHeight = FIXED16(72000.0 / pixheight); } }

Matrix PrintView::ConstructRenderingMatrix (  Spread *  pSpread  )  [virtual]

From the given spread, construct a matrix that will convert spread coordinates to OS coordinates. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 25/04/95 Parameters: pSpread  - the spread that is to be rendered. [INPUTS] Returns: The required transformation matrix. See also: DocView::OnDraw Reimplemented from View. Definition at line 633 of file prntview.cpp. { // First, translate page to origin, taking account of rotation flag. DocCoord TranslateToOrigin; DocRect PatchClipRect = PatchInfo.GetClipRect(FALSE,FALSE); if (PatchInfo.Rotate) TranslateToOrigin = DocCoord(-PatchClipRect.lo.x, -PatchClipRect.lo.y); else TranslateToOrigin = DocCoord(-PatchClipRect.lo.x, -PatchClipRect.hi.y); // Construct the translation matrix Matrix TranslateToOriginMatrix = Matrix(TranslateToOrigin.x, TranslateToOrigin.y); // Do the optional rotation Matrix RotateMatrix(FIXED16(0)); if (PatchInfo.Rotate) RotateMatrix = Matrix(FIXED16(270)); // Do the scale operation (convert from percentage to ratio) FIXED16 fxScale = PatchInfo.Scale / FIXED16(100); Matrix PrintScaleMatrix(fxScale, fxScale); // Find the patch height so we can work out our final translation MILLIPOINT PatchHeight; PatchHeight = ((PatchInfo.Rotate) ? (PatchClipRect.Width()) : (PatchClipRect.Height())); // Calculate the translation to move our patch rectangle to the bottom of the paper MILLIPOINT YShift = -(PatchInfo.PaperHeight - ((MILLIPOINT) (PatchHeight * fxScale))); MILLIPOINT XShift = 0; // Conceptually speaking we now have a transform which scales the patch (area to print) // and positions it located at (0,-PaperHeight) bottom left on the paper with (x,y) increasing positive // to the left and up. This is the model used in the print control class to calculate a patch // position when working out best fit/multi/curstom fit. That class calculates +ive x,y translations // to fit pages onto paper considering (0,0) to be bottom left. ok so we now simply need to add // in those calculated translations and we're done. XShift += PatchInfo.XTrans; YShift += PatchInfo.YTrans; Matrix PatchTranslateMatrix(XShift, YShift); // Generate a flip matrix if necessary Matrix FlipX; if (PatchInfo.EmulsionDown) { if (PatchInfo.Rotate) FlipX = Matrix(FIXED16(1), FIXED16(0), FIXED16(0), FIXED16(-1), 0, -PatchInfo.PaperHeight); else FlipX = Matrix(FIXED16(-1), FIXED16(0), FIXED16(0), FIXED16(1), PatchInfo.PaperWidth, 0); } // MarkN wrote (way back when first descovered) // For some reason, NT takes the top-left corner of the printable area as the origin of the paper // so we compensate for that here by adjusting our X & Y translations accordingly // NB. this used to be for NT only, but it seems that MS have brought Win32s and Win95 // print borders into line with NT's setup so there is a consistent Win32 interface. // Mike wrote (more recently) // I've stollen the code out of PrintControl, which used to do this but now doesn't. // Finally fix the operating system origin. The operating system drivers // render everything as if (PALeftMargin, PATopMargin) was the origin, so // we need to shift everything slightly. Matrix FixOpTranslate(-PatchInfo.PALeftMargin,PatchInfo.PATopMargin); // The following matrix compositions MUST be performed in this order. // If you are tempted to optimise this code MAKE SURE THAT THEY ARE STILL // IN THIS ORDER WHEN YOU'VE FINISHED! // Start with identity Matrix RenderMatrix; // Translate to Origin RenderMatrix *= TranslateToOriginMatrix; // Optional rotate if (PatchInfo.Rotate) RenderMatrix *= RotateMatrix; // Scale (as in Print UI) RenderMatrix *= PrintScaleMatrix; // Patch translation RenderMatrix *= PatchTranslateMatrix; // Optional Flip around for emulsion down if nec. if (PatchInfo.EmulsionDown) RenderMatrix *= FlipX; // Opsys translation RenderMatrix *= FixOpTranslate; // All done. return RenderMatrix; }

void PrintView::ContinueRenderView (  RenderRegion *  pRRegion, Spread *  pSpread, BOOL  fRenderPaper = TRUE, BOOL  fDeleteRegionAfter = TRUE, BOOL  bForceImmediate = FALSE )  [virtual]

Used by RenderRegion::DefaultRender() to carry on rendering a view. In this case (i.e. printing) it only gets called once, as it calls RenderView which prints the view in one go, i.e. we don't do background rendering. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/09/95 Parameters: pRRegion  - the region to use to render the view. [INPUTS] pSpread - the spread that is being rendered. fRenderPaper --- by default TRUE, ignored anyway because we have *REAL* paper to scribble on. fDeleteRegionAfter --- if TRUE then the View will deallocate the render-region when it has finished rendering. If FALSE then it won't. By default TRUE. Implements View. Definition at line 250 of file prntview.cpp. { // Disable bitmap caching but remember the old state so we can set it back ScopedFlagSetter fsBitmapCacheing(NodeRenderableBounded::bEnableCacheing, FALSE); // make sure the region is ok if (pRRegion==NULL) return; // We need to find out what sort of rendering we need to do, based on the options // in the print dialog. Start by finding the view and the doc we are printing Document* pDoc = GetDoc(); if (pDoc!=NULL) { // Find print control object for this document, to see if we are // printing via bitmap or normally PrintComponent *pPrintComponent = (PrintComponent *) pDoc->GetDocComponent(CC_RUNTIME_CLASS(PrintComponent)); // see if it exists or not. if (pPrintComponent==NULL) { if (fDeleteRegionAfter) delete pRRegion; return; } // Find the Print Control out of the component PrintControl *pPrintControl = pPrintComponent->GetPrintControl(); if (pPrintControl == NULL) { if (fDeleteRegionAfter) delete pRRegion; return; } // and finally find out the printing method PrintMethodType PrintType = pPrintControl->GetPrintMethod(); if ((PrintType == PRINTMETHOD_AABITMAP) || (PrintType == PRINTMETHOD_BITMAP)) { // Get the region to clip all the rendering to DocRect ClipRect = pRRegion->GetClipRect(); Matrix ViewTrans = pRRegion->GetMatrix(); // Tell the RenderRegion that I am going to start rendering. if (!pRRegion->StartRender()) { if (fDeleteRegionAfter) delete pRRegion; return; } // Render the spreads paper marks where necessary RenderPageMarks(pRRegion, ViewTrans, ClipRect, pSpread); // No - time to start rendering ink nodes - find the first one. pRRegion->SetSubRenderState(NULL); // Work out whether to print just selected objects, or all of them. if (pPrintControl->GetObjPrintRange() == PRINTRANGEOBJ_ALL) { // Print *all* objects pRRegion->RenderTree(pSpread, FALSE); } else { // Print only *selected objects* // (We do this by not rendering any bounded object that is not selected). // // This is in a different loop so that we don't impact performance of // normal printing. PrintRenderCallback MyCallback(this); pRRegion->RenderTree(pSpread, FALSE, TRUE, &MyCallback); } // Finished rendering. pRRegion->StopRender(); // The region has finished rendering - delete it. if (fDeleteRegionAfter) delete pRRegion; } else { // Build the view matrix to use Matrix ViewMatrix = pRRegion->GetMatrix(); // Try and render the view using the 3 pass system if (PrintMonitor::PrintMaskType==PrintMonitor::MASK_OPTIMAL) RenderOptimalView(pRRegion, ViewMatrix, pSpread, FALSE); else RenderSimpleView(pRRegion, ViewMatrix, pSpread, FALSE); } } }

void PrintView::CorrectRotatedRectangle (  Rect *  pRect  )  [static]

Patches up rectangles after having been transformed by the rendering matrix. Because printing can involve a rotation through a multiple of 90 degress, the corners can become swapped, so we check for this and swap them back around if necessary. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 04/28/95 Parameters: pRect  - the rectangle to correct. [INPUTS] pRect  - the corrected rectangle. [OUTPUTS] Definition at line 813 of file prntview.cpp. { MILLIPOINT Tmp; if (pRect->lo.x > pRect->hi.x) { Tmp = pRect->lo.x; pRect->lo.x = pRect->hi.x; pRect->hi.x = Tmp; } if (pRect->lo.y > pRect->hi.y) { Tmp = pRect->lo.y; pRect->lo.y = pRect->hi.y; pRect->hi.y = Tmp; } }

DocRect PrintView::GetDocViewRect (  Spread *  pSpread  )  [virtual]

To find the rectangle describing the viewport onto the document. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 21/7/93 Parameters: pSpread  - the spread that we are interested in [INPUTS] Returns: A DocCoords rectangle describing the viewport onto the document which this view is displaying. I.E. The top left corner of this rectangle is the same as the value returned by GetScrollOffsets() except in DocCoords. Implements View. Definition at line 529 of file prntview.cpp. { ERROR3("GetDocViewRect() called on unimplemented printing class!"); return DocRect(0,0,0,0); }

BOOL PrintView::GetForeBackMode (   )  [virtual]

To find out if background rendering is on. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 10/2/95 Returns: TRUE if background rendering is on Implements View. Definition at line 449 of file prntview.cpp. { // PrintViews don't background render yet. return FALSE; }

CNativeDC * PrintView::GetRenderDC (   )  [virtual]

Access function for the device context of this printing view object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/09/95 Returns: The printer DC. See also: View; DocView Implements View. Definition at line 219 of file prntview.cpp. { return PrintDC; }

WorkRect PrintView::GetViewRect (   )  [virtual]

To find the rectangle describing the viewport onto the document. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 5/7/93 Returns: A WorkCoords rectangle describing the viewport onto the document which this view is displaying. I.E. The top left corner of this rectangle is the same as the value returned by GetScrollOffsets(). Implements View. Definition at line 506 of file prntview.cpp. { ERROR3("GetViewRect() called on unimplemented printing class!"); return WorkRect(0,0,0,0); }

void PrintView::MakeNewRenderRegion (  Spread *  pSpread, DocRect  ClipRect, CNativeDC *  pDevContext, RenderType  rType, BOOL  PaintPaper = FALSE, Node *  pInvalidNode = NULL )  [protected, virtual]

Renders the document to the printer. This function will build all the render regions needed to do a print. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 5/4/95 Parameters: pSpread  - The Spread to render [INPUTS] ClipRect - the Clipping rectangle of the bit to draw pDevContext - the Device Context to render to rType - the Type of the render region PaintPaper - Should we draw the paper? See also: View::MakeNewRenderRegion Reimplemented from View. Definition at line 589 of file prntview.cpp. { // Construct the transformation matrix for the spread. Matrix RenderMatrix = ConstructRenderingMatrix(pSpread); // Go and create the new render region RenderRegion* pNewRegion = NULL; if (pViewWindow != NULL) pNewRegion = NewRenderRegion(ClipRect, RenderMatrix, GetRenderDC(), pSpread, rType); // See if it worked if (pNewRegion == NULL) { TRACEALL( _T("Not enough memory to create render region\n")); return; } pNewRegion->SetBackmostChangedNode(pInvalidNode); // Add the region to the list of regions to render and start the // rendering process off if it has some ink to render Camelot.AddRenderRegion(pNewRegion); // Here we will actually want to create all the strange types of render region // that we will need and render them on the spot instead of putting them in // the list of render regions. Don't forget to remove the #include app.h // when the use of the Camelot var goes away. }

void PrintView::OnDraw (  CNativeDC *  pDevContext, OilRect  OilClipRect )

Do the printing, guv. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 27/04/95 Parameters: pDevContext  - the device context of the view to render. [INPUTS] OilClipRect - the clipping rectangle of the invalid region (in OilCoords). Reimplemented from View. Definition at line 744 of file prntview.cpp. { if (CCamApp::IsDisabled()) return; // If the system is disabled, ignore // Find out what sort of (printing) device context we have. RenderType rType = CCDC::GetType(pDevContext, TRUE); // Find out which spread we are rendering Spread *pSpread = Document::GetSelectedSpread(); // PatchInfo.Spread // Get the rendering matrix for this view. Matrix RenderMatrix = ConstructRenderingMatrix(pSpread); // Get its inverse matrix Matrix InverseMatrix = RenderMatrix.Inverse(); // Use this to convert OIL coords to spread coords DocRect ClipRect; ClipRect.lo.x = OilClipRect.lo.x; ClipRect.lo.y = OilClipRect.lo.y; ClipRect.hi.x = OilClipRect.hi.x; ClipRect.hi.y = OilClipRect.hi.y; InverseMatrix.transform(&ClipRect.lo); InverseMatrix.transform(&ClipRect.hi); // Rendering matrix may involve a rotation when printing so correct the rectangle // for this if necessary. CorrectRotatedRectangle((Rect *) &ClipRect); ERROR3IF(ClipRect.lo.x > ClipRect.hi.x, "PrintView::OnDraw clipping rect is invalid"); ERROR3IF(ClipRect.lo.y > ClipRect.hi.y, "PrintView::OnDraw clipping rect is invalid"); // Get the page clip rect DocRect SpreadClipRect = PatchInfo.GetClipRect(FALSE,FALSE); RenderMatrix.transform(&SpreadClipRect.lo); RenderMatrix.transform(&SpreadClipRect.hi); CorrectRotatedRectangle((Rect *) &SpreadClipRect); PatchInfo.InflateRectBy(&SpreadClipRect,TRUE,TRUE); InverseMatrix.transform(&SpreadClipRect.lo); InverseMatrix.transform(&SpreadClipRect.hi); CorrectRotatedRectangle((Rect *) &SpreadClipRect); // Clip to spread rectangle SpreadClipRect = SpreadClipRect.Intersection(ClipRect); // Make sure that the clip region is valid after the intersection if ((SpreadClipRect.IsValid()) && (!SpreadClipRect.IsEmpty())) { MakeNewRenderRegion(pSpread, SpreadClipRect, pDevContext, rType, TRUE); } }

void PrintView::PrintRegion (  Spread *  pSpread, DocRect  ClipRect, CNativeDC *  pDevContext, RenderType  rType )  [protected]

void PrintView::SetExtent (  DocCoord  lolog, DocCoord  hilog )  [virtual]

Informs the PrintView that the extent of the document has changed in some way and that the view must be altered to take this into account (namely the scrollbars). Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 26/5/93 Parameters: Two  DocCoords describing the low and high corners of a rectangle in logical [INPUTS] space describing the full extent of the document. I.E. the bottom-left corner of the last chapter and the top-right corner of the first. Implements View. Definition at line 471 of file prntview.cpp. { // "Pixelise" the extent DocCoords. // Effectively, this helps ensure that the spread will be aligned to a whole pixel boundary // and allows both GDraw and GDI to consistently plot the same pixels when rendering // the same primitive. // We need to do this even when printing because things like // DocCoord::FindEnclosingChapter() default to pixelising extents so we get errors // because our coords do not lie within the pixelised extents. lolog.Pixelise(this); hilog.Pixelise(this); // Convert the extent given in DocCoord to WorkCoords... pVState->WorkAreaExtent.lo = lolog.ToWork(pDoc, this); pVState->WorkAreaExtent.hi = hilog.ToWork(pDoc, this); }

void PrintView::SetForeBackMode (  BOOL  NewFlag  )  [virtual]

Set the background render flag for this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 10/2/95 Parameters: NewFlag  - New bg render flag. [INPUTS] Implements View. Definition at line 430 of file prntview.cpp. { // Nobody should try to set the printing to be background yet. ERROR3IF(NewFlag, "Trying to make a PrintView background render!"); }

void PrintView::SetViewPixelSize (   )  [virtual]

Sets up the normal and scaled pixel sizes according to this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/10/95 Implements View. Definition at line 410 of file prntview.cpp. { // Set the scaled pixel size ScaledPixelWidth = PixelWidth / Scale; ScaledPixelHeight = PixelHeight / Scale; }

BOOL PrintView::ViewStateChanged (   )  [virtual]

Inform the PrintView that its OIL view object has changed the shared ViewState structure. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/09/95 Returns: TRUE if all ok; FALSE if not. See also: View::ViewStateChanged Implements View. Definition at line 380 of file prntview.cpp. { // Sanity checks. ERROR2IF(this==NULL,FALSE,"DocView member func called on NULL pointer"); ERROR2IF(pDoc==NULL,FALSE,"ViewStateChanged: There MUST be an owner doc for this view!"); DocCoord ExtentLo; // coord of bottom-left of logical extent DocCoord ExtentHi; // coord of top-right of logical extent // Read DocCoords extent of document & set extent in platform-indy ViewState struct. pDoc->GetExtents(&ExtentLo, &ExtentHi, &PhysExtent, this); // Set extent in platform-indy ViewState struct SetExtent(ExtentLo, ExtentHi); return TRUE; }

---

Friends And Related Function Documentation

friend class ScreenView [friend]

Definition at line 156 of file prntview.h.

---

Member Data Documentation

PrintPatchInfo PrintView::PatchInfo

Definition at line 154 of file prntview.h.

CNativeDC* PrintView::PrintDC [protected]

Definition at line 134 of file prntview.h.

---

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

• Kernel/prntview.h (r1785/r1354)
• Kernel/prntview.cpp (r1785/r1354)

---