ExpressView Class Reference

Renders the current document into the device context given in OnDraw() This is primarily used for embedding documents. More...

#include <exprview.h>

Inheritance diagram for ExpressView:

List of all members.

Public Member Functions
	ExpressView (Document *)
	First stage of two part constructor.
BOOL	Init ()
	Second stage of two part constructor.
virtual	~ExpressView ()
	Destroys a printing view - this is because it has finished printing or something went wrong during printing.
virtual BOOL	ViewStateChanged ()
	Inform the ExpressView that its OIL view object has changed the shared ViewState structure.
virtual void	SetViewPixelSize ()
	Sets up the normal and scaled pixel sizes according to this view.
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 CDC *	GetRenderDC ()
	Access function for the device context of this ExpressView passed in via OnDraw().
virtual BOOL	GetForeBackMode ()
	To find out if background rendering is on.
virtual void	SetForeBackMode (BOOL)
	Set the background render flag for this view. Notes: Should never be asked to render in background.
BOOL	DoRender (CDC *pDC, DocRect drClip, const DocRect &BitmapSize, BPP Bpp)
	Renders immediately this ExpressView's bitmap.
OILBitmap *	GetBitmap () const
	Having called DoRender() to render the document into a bitmap of the given specification, we can get a pointer to it here.
virtual DocRect	GetDocViewRect (Spread *)
	To find the rectangle describing the viewport onto the document.
virtual void	SetExtent (DocCoord, DocCoord)
	Informs the ExpressView 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.
Protected Member Functions
virtual Matrix	ConstructRenderingMatrix (Spread *pSpread)
	From the given spread, construct a matrix that will convert spread coordinates to OS coordinates.
virtual void	MakeNewRenderRegion (Spread *, DocRect, CDC *, 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
FIXED16	m_XScale
FIXED16	m_YScale
Matrix	m_ScaleMatrix
GRenderBitmap *	m_pBitmapRegion
CDC *	m_pCDC
BPP	m_Bpp
OILBitmap *	m_pBitmap

---

Detailed Description

Renders the current document into the device context given in OnDraw() This is primarily used for embedding documents.

Author:

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

Date:

18/09/96

Definition at line 123 of file exprview.h.

---

Constructor & Destructor Documentation

ExpressView::ExpressView (  Document *  pOwnerDoc  )

First stage of two part constructor. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 Parameters: pDocument  - the document to attach to (i.e. the one to print) [INPUTS] See also: ExpressView::Init() Definition at line 143 of file exprview.cpp. { // Set up document; no CamView yet. pDoc = pOwnerDoc; pViewWindow = NULL; m_pBitmapRegion = NULL; m_pCDC = NULL; m_pBitmap = NULL; m_Bpp = 8; m_XScale = 1.0; m_YScale = 1.0; }

ExpressView::~ExpressView (   )  [virtual]

Destroys a printing view - this is because it has finished printing or something went wrong during printing. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 See also: ExpressView; View Definition at line 206 of file exprview.cpp. { delete pVState; pVState = 0; }

---

Member Function Documentation

Matrix ExpressView::ConstructRenderingMatrix (  Spread *  pSpread  )  [protected, virtual]

From the given spread, construct a matrix that will convert spread coordinates to OS coordinates. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim & Rik) Date: 18/09/96 Parameters: pSpread  - the spread that is to be rendered. [INPUTS] Returns: The required transformation matrix. See also: ExpressView::OnDraw Reimplemented from View. Definition at line 488 of file exprview.cpp. { ERROR2IF(pSpread == NULL, Matrix(), "pSpread == NULL"); // Get the PIXELISED origin of spread coordinates, in document coords DocCoord SpreadCoordOrigin = pSpread->GetSpreadCoordOrigin(TRUE, this); // Convert it into logical Work Coords // NOTE: We convert this via the spread, because the Spread Coord Origin can now // lie *outside* the current chapter/spread pasteboard bounds, and so the version // of this call that takes a document pointer can't find the enclosing chapter! // Of course, we know the enclosing chapter, because this point is in a known spread! WorkCoord WorkCoordOffset = SpreadCoordOrigin.ToWork(pSpread, this); // Offset it by the window scroll position WorkCoordOffset.x -= pVState->GetScrollPos().x; WorkCoordOffset.y -= pVState->GetScrollPos().y; // Construct the transformation matrix for the spread. Matrix RenderMatrix; // We can chop the 64bit values down to 32bit now, as we have them in the correct range Matrix TranslateToOrigin( (INT32)WorkCoordOffset.x, (INT32)WorkCoordOffset.y); Matrix ScaleMat(Scale, Scale); // 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! // Apply scale factors to convert from millipoint distances to pixel distances... RenderMatrix *= ScaleMat; // And to the bitmap size RenderMatrix *= m_ScaleMatrix; // Apply scroll-offset translation to move origin to viewing position... RenderMatrix *= TranslateToOrigin; return RenderMatrix; }

void ExpressView::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: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 Parameters: pRRegion  - the region to use to render the view. [INPUTS] pSpread - the spread that is being rendered. fRenderPaper --- by default TRUE 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 256 of file exprview.cpp. { // Render the document in one operation. Matrix mxRndr = ConstructRenderingMatrix(pSpread); // Scroll offsets etc may have changed, so transfer matrix. pRRegion->SetMatrix(mxRndr); #ifdef RALPH // Wait until it's safe to enter CCamApp::EnterGDrawCriticalSection(); #endif // Tell the RenderRegion that I am going to start rendering. if (!pRRegion->StartRender()) { TRACEALL( _T("StartRender failed in RenderView\n")); // will be deleted quickly } else { // Never render the paper but do all the ink (non-paper) parts of the document. pRRegion->RenderTree(pSpread, FALSE); // Reset state to new posn in tree. pRRegion->StopRender(); } // Our render regions are always Bitmap ones // Assume there's only one GRenderBitmap* pGRBRegion = (GRenderBitmap*)pRRegion; ERROR3IF(!pGRBRegion->IS_KIND_OF(GRenderBitmap), "pGRBRegion isn't kinda GRenderBitmap"); m_pBitmap = pGRBRegion->ExtractBitmapCopy(); #ifdef RALPH // Let another process have a go CCamApp::ExitGDrawCriticalSection(); #endif if (fDeleteRegionAfter) { delete pRRegion; } }

BOOL ExpressView::DoRender (  CDC *  pDC, DocRect  drClip, const DocRect &  BitmapSize, BPP  Bpp )

Renders immediately this ExpressView's bitmap. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 18/09/96 Returns: TRUE if completed successfully FALSE otherwise Definition at line 602 of file exprview.cpp. { ERROR2IF(pDC == NULL, FALSE, "pDC == NULL"); TRACEUSER( "Colin", _T("dpi %d drClip %ld,%ld\tBitmapSize %ld,%ld BPP %d Quality %d\n"), pDC->GetDeviceCaps(LOGPIXELSX), drClip.hix, drClip.hiy, BitmapSize.hix, BitmapSize.hiy, Bpp, RenderQuality.GetQuality()); // Remember the current view so we can give it back after rendering View* pCurrentView = GetCurrent(); m_pCDC = pDC; m_Bpp = Bpp; // Convert clip rect to OIL coords PORTNOTE("spread", "Multi-spread warning!") Spread* pSpread = pDoc->FindFirstSpread(); ERROR2IF(!pSpread, FALSE, "pSpread NULL"); pSpread->DocCoordToSpreadCoord(&drClip); OilRect orClip = drClip.ToOil(pSpread, this); // Scale to the bitmap size m_ScaleMatrix = Matrix(drClip, BitmapSize); // Construct the invalid render regions OnDraw(pDC, orClip); BOOL bSuccessful = FALSE; // And render them into the given DC if (m_pBitmapRegion != NULL) { #ifndef RALPH // Start the rendering indicator going. if (GetApplication()->GetpStatusLine()) GetApplication()->GetpStatusLine()->SetRenderIndicator(Rendering); #endif // Render it. Error::RenderThreadIn(); // Make errors close window m_pBitmapRegion->DefaultRender(); Error::RenderThreadOut(); // Normal errors #ifndef RALPH // Disable rendering indicator. if (GetApplication()->GetpStatusLine()) GetApplication()->GetpStatusLine()->SetRenderIndicator(NotRendering); #endif bSuccessful = TRUE; } // Restore the view pCurrentView->SetCurrent(); return bSuccessful; }

OILBitmap * ExpressView::GetBitmap (  void   )  const

Having called DoRender() to render the document into a bitmap of the given specification, we can get a pointer to it here. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 18/09/96 Returns: A pointer to the currently rendered bitmap Definition at line 671 of file exprview.cpp. { return m_pBitmap; }

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

To find the rectangle describing the viewport onto the document. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Phil) Date: 18/09/96 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 466 of file exprview.cpp. { ERROR3("GetDocViewRect() called"); return DocRect(0,0,0,0); }

BOOL ExpressView::GetForeBackMode (   )  [virtual]

To find out if background rendering is on. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 Returns: FALSE always, indicating foreground rendering only. Implements View. Definition at line 389 of file exprview.cpp. { // ExpressViews don't background render yet. return FALSE; }

CDC * ExpressView::GetRenderDC (   )  [virtual]

Access function for the device context of this ExpressView passed in via OnDraw(). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 Returns: The printer DC. Implements View. Definition at line 226 of file exprview.cpp. { return m_pCDC; }

WorkRect ExpressView::GetViewRect (   )  [virtual]

To find the rectangle describing the viewport onto the document. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Phil) Date: 18/09/96 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 443 of file exprview.cpp. { ERROR3("GetViewRect() called"); return WorkRect(0,0,0,0); }

BOOL ExpressView::Init (  void   )

Second stage of two part constructor. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 18/09/96 Returns: TRUE if successful, FALSE otherwise See also: ExpressView::ExpressView() Reimplemented from SimpleCCObject. Definition at line 171 of file exprview.cpp. { pVState = new ViewState; if (pVState == NULL) { TRACE( _T("Unable to create ViewState\n")); return FALSE; } // Connect this view state to this view pVState->pView = this; PORTNOTE("spread", "Multi-spread warning!") Spread* pSpread = pDoc->FindFirstSpread(); DocView* pView = pDoc->GetFirstDocView(); // Get the real bounds, in millipoints, of the document's first spread, converted // to pixels. GetScaledPixelSize(&ScaledPixelWidth, &ScaledPixelHeight); return TRUE; }

void ExpressView::MakeNewRenderRegion (  Spread *  pSpread, DocRect  ClipRect, CDC *  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: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Rik) Date: 18/09/96 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 Definition at line 549 of file exprview.cpp. { // Construct the transformation matrix for the spread. Matrix RenderMatrix = ConstructRenderingMatrix(pSpread); // Go and create the new render region m_pBitmapRegion = NULL; double dpi = pDevContext->GetDeviceCaps(LOGPIXELSX); // We'll restrict it to 96dpi for now to avoid huge bitmaps if (dpi > 96.0) { TRACE( _T("dpi request for %f\n"), dpi); dpi = 96.0; } m_pBitmapRegion = new GRenderBitmap (ClipRect, RenderMatrix, Scale, m_Bpp, dpi, FALSE, XARADITHER_ERROR_DIFFUSION, 0, TRUE); // See if it worked if (m_pBitmapRegion == NULL) { TRACEALL( _T("Not enough memory to create render region\n")); return; } // If the construction was succesful then // Attach the new RenderRegion to a Window and its DC for rendering... if (!m_pBitmapRegion->AttachDevice(this, pDevContext, pSpread)) { // the AttachDevice failed, so tidy up delete m_pBitmapRegion; return; } m_pBitmapRegion->SetBackmostChangedNode(pInvalidNode); }

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

Informs the ExpressView 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: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Phil) Date: 18/09/96 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 411 of file exprview.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. 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 ExpressView::SetForeBackMode (  BOOL  NewFlag  )  [virtual]

Set the background render flag for this view. Notes: Should never be asked to render in background. 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 370 of file exprview.cpp. { // Nobody should try to set the printing to be background yet. ERROR3IF(NewFlag, "Trying to make a ExpressView background render!"); }

void ExpressView::SetViewPixelSize (   )  [virtual]

Sets up the normal and scaled pixel sizes according to this view. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 Implements View. Definition at line 349 of file exprview.cpp. { // Set the scaled pixel size ScaledPixelWidth = PixelWidth / m_XScale; ScaledPixelHeight = PixelHeight / m_YScale; }

BOOL ExpressView::ViewStateChanged (   )  [virtual]

Inform the ExpressView that its OIL view object has changed the shared ViewState structure. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) Date: 18/09/96 Returns: TRUE if all ok; FALSE if not. See also: View::ViewStateChanged Implements View. Definition at line 319 of file exprview.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; }

---

Member Data Documentation

BPP ExpressView::m_Bpp [protected]

Definition at line 166 of file exprview.h.

OILBitmap* ExpressView::m_pBitmap [protected]

Definition at line 167 of file exprview.h.

GRenderBitmap* ExpressView::m_pBitmapRegion [protected]

Definition at line 163 of file exprview.h.

CDC* ExpressView::m_pCDC [protected]

Definition at line 165 of file exprview.h.

Matrix ExpressView::m_ScaleMatrix [protected]

Definition at line 161 of file exprview.h.

FIXED16 ExpressView::m_XScale [protected]

Definition at line 159 of file exprview.h.

FIXED16 ExpressView::m_YScale [protected]

Definition at line 160 of file exprview.h.

---

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

• Kernel/exprview.h (r1785/r1282)
• Kernel/exprview.cpp (r1785/r1282)

---