View Class Reference

The basic kernel view item. This class contains minimal functionality to maintain the 'current' view, and the connection from a kernel view object to an OIL view object. DocView and PrintView are derived from this class. More...

#include <view.h>

Inheritance diagram for View:

List of all members.

Public Member Functions
	View ()
	Initialise a View object.
virtual	~View ()
	Cleans up a view object.
BOOL	ConnectToOilView (CCamView *)
	To set up the bi-directional connection between the OIL view object and the View. The OIL view object causes the creation of the View and so already has a pointer to it when it calls this routine to set up the connection in the other direction.
Document *	GetDoc () const
	Returns the linake between this View and its Document.
CCamView *	GetConnectionToOilView () const
	To get a pointer to the OIL view object which mirrors this one. Note that this can return NULL if the View does not have a mirroring OIL object. In this case the view is closed but the View remains available so that in the future a new view will be able to use all of its viewing parameters.
PrintControl *	GetPrintControl ()
	Simple way of getting the PrintControl object associated with this view's document.
virtual void	SetViewState (ViewState *)
	Sets the structure which is shared by both View and the OIL view object to which it is connected. NB. PrintViews do NOT share the ViewState with the OIL view, because the OIL view is the screen based view, so the PrintView is the only one that needs to use the view state. The CCamView always uses the ViewState of its DocView, not its PrintView.
virtual BOOL	ViewStateChanged ()=0
BOOL	SetCurrent ()
	Make this object be the 'current' View.
virtual void	SetViewPixelSize ()=0
void	OnDraw (wxDC *, OilRect)
	Do the drawing, guv.
virtual void	ContinueRenderView (RenderRegion *, Spread *, BOOL fRenderPaper=TRUE, BOOL fDeleteRegionAfter=TRUE, BOOL bForceImmediate=FALSE)=0
virtual wxDC *	GetRenderDC ()=0
virtual void	AllocateDC ()
	Hints that we've done with our DC.
virtual void	DoneWithDC ()
	Hints that we've done with our DC.
virtual BOOL	RenderTreeCallback (Node *pNode, RenderRegion *pRender)
RenderViewResult	RenderOptimalView (RenderRegion *r, Matrix &, Spread *, BOOL)
	This function has been designed along similar lines to the RenderView() function found elsewhere in this file. This version of the function is slightly different though. This version of the function is able to render complex objects, such as transparent objects into normal render regions. It does this by first scanning through all the objects that need rendering to see if any of them require complex things. If they do, then part of the rendering is done into a bitmap and blitted over the rest of the shapes using a masked blit. All very complicated really! This is the optimal version of this function, that will render individual complex shapes to the device instead of building them all up and blitting them in one go. This will produce the best quality results as as many objects as possible will be rendered to the resolution of the device.
SlowJobResult	RenderOptimalBitmapPhase (DocRect &ClipRect, Matrix &, Spread *, RenderRegion *, Node *, Node *, BOOL RenderAllObjects, BOOL bPrintPaper, INT32 &, ProgressDisplay *pProgress, INT32 TotalProgress)
	Renders the masked bitmap part of the process. This function will get called many times during the typical rendering of the document (once for each run of complex nodes in the document).
virtual RenderViewResult	RenderSimpleView (RenderRegion *, Matrix &, Spread *, BOOL)
	This function has been designed along similar lines to the RenderView() function found elsewhere in this file. This version of the function is slightly different though. This version of the function is able to render complex objects, such as transparent objects into normal render regions. It does this by first scanning through all the objects that need rendering to see if any of them require complex things. If they do, then part of the rendering is done into a bitmap and blitted over the rest of the shapes using a masked blit. All very complicated really!
SlowJobResult	RenderBitmapPhase (DocRect &ClipRect, Matrix &, Spread *, RenderRegion *, Node *, Node *, BOOL bRenderAll, BOOL bPrintPaper, ProgressDisplay &Progress)
	This function is called from RenderSimpleView if it ends up having to do the 3 phase rendering system. This function performs the bitmap phase, where all the objects deemed to be complex by the Host render region are rendered into a bitmap using GDraw and a mono, mask bitmap. The bitmap is blitted into the host render region using the mask bitmap, minimising the amount of bitmaps ending up in the view (important for things like postscript that do not really like bitmaps very much).
virtual void	RenderPaper (Spread *, DocRect, wxDC *, Matrix &)
	Actually renders the paper onto the screen. Moved from 'MakeNewRenderRegion' so that it can be called from outside (eg. ResetRegion).
virtual BOOL	RenderPageMarks (RenderRegion *, Matrix &, DocRect &, Spread *)
	Performs the rendering of page marks, ie crop marks, registration marks etc to the screen and printer. This base class version does nothing. All mark rendering technology is held in DocView and PrintView.
virtual BOOL	GetForeBackMode ()=0
virtual void	SetForeBackMode (BOOL)=0
virtual Matrix	ConstructRenderingMatrix (Spread *pSpread)
	From the given spread, construct a matrix that will convert spread coordinates to OS coordinates.
virtual Matrix	ConstructScaledRenderingMatrix (Spread *pSpread, double ScaleFactor)
	Create a rendermatrix at ScaleFactor precision of the current Scale Allows you to create a bitmap with higher/lower resolution than the current view eg used to create a bitmap of a given invalid region at double the current zoom factor (ie synonymous concept to "double resolution" or "double DPI").
FIXED16	GetPixelWidth ()
	Get the width of a pixel in this view.
FIXED16	GetPixelHeight ()
	Get the height of a pixel in this view.
void	GetPixelSize (FIXED16 *PixelWidth, FIXED16 *PixelHeight)
	Get the size of a pixel in this view.
virtual void	SetPixelSize (FIXED16 PixelWidth, FIXED16 PixelHeight)
	Set the size of a pixel in this view.
FIXED16	GetScaledPixelWidth ()
	Get the width of a scaled pixel in this view.
FIXED16	GetScaledPixelHeight ()
	Get the height of a scaled pixel in this view.
void	GetScaledPixelSize (FIXED16 *PixelWidth, FIXED16 *PixelHeight)
	Get the size of a scaled pixel in this view.
virtual void	SetScaledPixelSize (FIXED16 PixelWidth, FIXED16 PixelHeight)
	Set the size of a scaled pixel in this view.
virtual double	GetConvertToEditableShapesDPI ()
	Allows derived view classes to override the reolution.
ColourContext *	GetColourContext (ColourModel Model, BOOL ReturnNULLIfNone=FALSE)
	To find an appropriate colour context in the given colour model for use when rendering into this view. This allows us to control colour separation and correction down to a per-view level.
ColourPlate *	GetColourPlate (void)
	To find out what colour separation options are currently in use by this view.
void	SetColourPlate (ColourPlate *NewPlate, BOOL bSendContextChanged=TRUE)
	Sets a new colour plate (colour separation description for this view. Any future requests for colour contexts for this view (e.g. the next time it is redrawn, etc) will return a ColourContext using this new ColourPlate.
void	SetColourContext (ColourModel Model, ColourContext *NewContext=NULL)
	Sets a new colour context for this view.
BOOL	GetForceDefaultColourContexts (void)
BOOL	SetForceDefaultColourContexts (BOOL bForceDefault=TRUE)
WorkCoord	GetScrollOffsets () const
	To find the position of the top left corner of the display.
virtual BOOL	SetScrollOffsets (WorkCoord, BOOL RedrawNeeded=TRUE)
	To scroll this view to a new position over the document. The coordinate supplied is the coordinate of the top left corner of the viewport onto the document. The RedrawNeeded flag is TRUE when any invalid areas created should be redrawn immediately and FALSE if they should be ignored.
FIXED16	GetViewScale () const
	Inquire the viewing scale factor from this View.
virtual BOOL	SetViewScale (FIXED16)
	Set the viewing scale factor for this view. (Also, sets up the scaled pixel size in DocCoord if this View is current.
virtual DocRect	GetDocViewRect (Spread *)=0
virtual void	SetExtent (DocCoord, DocCoord)=0
virtual WorkRect	GetViewRect ()=0
Static Public Member Functions
static void	Deinit ()
	De-initialises the view system. At the moment this involves destroying our PaperRenderRegion.
static View *	GetCurrent ()
	Find the current View object which SHOULD have been set as one of the very first actions during event processing.
static void	SetNoCurrent ()
	Set the current View pointer to be NULL, i.e., there is no current View object.
static void	DeInitOnTopRegion ()
	Deinitialises the static OnTop RenderRegion, used for blob rendering.
static BOOL	IsPrintableNodeSelected (Node *)
	Determine whether a given node should be rendered when we are printing with "selected objects only" enabled. It checks to see if the node is bounded - if it isn't, then it's an attribute or similar and so is always rendered. If it is bounded then return TRUE if it is selected or if it is the child of a selected object. Otherwise we return FALSE to indicate that it should not be printed.
Public Attributes
Quality	RenderQuality
Protected Member Functions
virtual void	RenderPaper (RenderRegion *, Spread *)
	To render the parts of a Document which are not rendered when printing. Ie. all the parts of the document that represent the paper on which the ink will be rendered. This function does not take any notice of the RenderControl object - it renders until it has finished so that at least the pages, pasteboard, etc. will be drawn when any region is invalidated.
SlowJobResult	RenderSimpleNodes (Node *pNode, RenderRegion *pRender, ProgressDisplay &Progress, Node *pLastComplexNode=NULL)
	Function to render nodes 'normally' during 3-pass rendering. This copes with stopping at the specified last complex node, and with only printing selected objects if the user has requested it.
SlowJobResult	RenderSimpleNodesUnclipped (Node *pNode, RenderRegion *pRender, ProgressDisplay &Progress, Node *pLastComplexNode=NULL)
	Function to render nodes 'normally' during 3-pass rendering. This copes with stopping at the specified last complex node, and with only printing selected objects if the user has requested it.
RenderRegion *	NewRenderRegion (DocRect InvalidRect, Matrix &ViewMatrix, wxDC *pDevContext, Spread *pSpread, RenderType rType, bool fOwned=false)
virtual void	MakeNewRenderRegion (Spread *, DocRect, wxDC *, RenderType, BOOL PaintPaper=FALSE, Node *pInvalidNode=NULL)
	Makes a new render region and adds it to the list associated with the DocView. Depending on the type of render region requested, it may be rendered to completion immediately (e.g. print regions are). Note that if PaintPaper is FALSE, pDevContext isn't used, so can be NULL.
Protected Attributes
CCamView *	pViewWindow
Document *	pDoc
ViewState *	pVState
FIXED16	PixelWidth
FIXED16	PixelHeight
FIXED16	ScaledPixelWidth
FIXED16	ScaledPixelHeight
ColourPlate *	ColPlate
ColourContextArray	ColourContexts
BOOL	ShouldDeleteContext [16]
BOOL	ForceDefaultColourContexts
FIXED16	Scale
DocRect	PhysExtent
BOOL	m_bSolidDrag
Static Protected Attributes
static View *	Current = NULL
Private Member Functions
	CC_DECLARE_DYNAMIC (View)
Static Private Attributes
static PaperRenderRegion *	pPaperRegion = NULL
static PaperRenderRegion *	pOnTopRegion = NULL

---

Detailed Description

The basic kernel view item. This class contains minimal functionality to maintain the 'current' view, and the connection from a kernel view object to an OIL view object. DocView and PrintView are derived from this class.

Author:

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

Date:

02/07/95

See also:

DocView; PrintView

Definition at line 228 of file view.h.

---

Constructor & Destructor Documentation

View::View (   )

Initialise a View object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/23/95 See also: View Definition at line 180 of file view.cpp. { // No connections yet... pViewWindow = NULL; pDoc = NULL; pVState= NULL; // Actual size of OIL pixels that this view uses - default to 96dpi. PixelWidth = PixelHeight = FIXED16(72000.0 / 96); // Scaled size of OIL pixels that this view uses - default to scale of 100% ScaledPixelWidth = ScaledPixelHeight = PixelWidth; // View scale factor - default to 100% Scale = 1.0; // Initialise our ColourPlate and colour contexts to NULL pointers ForceDefaultColourContexts = FALSE; ColPlate = NULL; for (INT32 i = 0; i < (INT32) MAX_COLOURMODELS; i++) { ColourContexts.Context[i] = NULL; ShouldDeleteContext[i] = TRUE; } m_bSolidDrag = FALSE; }

View::~View (   )  [virtual]

Cleans up a view object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/23/95 See also: View Definition at line 222 of file view.cpp. { if (this == Current) SetNoCurrent(); // Decommission all colour contexts that we own ColourContextList *cclist = ColourContextList::GetList(); ERROR3IF( cclist == NULL, "No ColourContextList? What's up?" ); // Delete any old context we had in use (ignoring the ShouldDeleteContext flags) for (INT32 i = 0; i < (INT32) MAX_COLOURMODELS; i++) { if (ColourContexts.Context[i] != NULL) cclist->RemoveContext(&(ColourContexts.Context[i])); } if (ColPlate != NULL) delete ColPlate; if (pVState != NULL) { delete pVState; pVState=NULL; } }

---

Member Function Documentation

void View::AllocateDC (   )  [virtual]

Hints that we've done with our DC. Author: Alex Bligh <alex@alex.org.uk> Date: 12/06/2006 See also: View; PaperRenderRegion. Note this is merely a hint. This routine is not guaranteed to eb called Definition at line 261 of file view.cpp. { if (pViewWindow) pViewWindow->AllocateDC(); }

View::CC_DECLARE_DYNAMIC (  View   )  [private]

BOOL View::ConnectToOilView (  CCamView *  pOilView  )

To set up the bi-directional connection between the OIL view object and the View. The OIL view object causes the creation of the View and so already has a pointer to it when it calls this routine to set up the connection in the other direction. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 18/5/93 Parameters: Pointer  to view object in the OIL layer which we will mirror. [INPUTS] None  [OUTPUTS] Returns: None Errors: None Definition at line 323 of file view.cpp. { ERROR2IF(this==NULL,FALSE,"View member func called on NULL pointer"); ERROR2IF(pViewWindow != NULL, FALSE, "View::ConnectToOilView called when connection already established"); pViewWindow = pOilView; return TRUE; }

Matrix View::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> & Rik Date: 10/12/93 Parameters: pSpread  - the spread that is to be rendered. [INPUTS] Returns: The required transformation matrix. See also: DocView::OnDraw Reimplemented in ExpressView, and PrintView. Definition at line 1113 of file view.cpp. { // 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; // Just in case the above hasn't work (the DocCoord conversion seems to produce some rounding // errors), Pixelize the offset WorkCoordOffset.Pixelise(72000.0/PixelWidth.MakeDouble(),72000.0/PixelHeight.MakeDouble()); // 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; // Apply scroll-offset translation to move origin to viewing position... RenderMatrix *= TranslateToOrigin; return RenderMatrix; }

Matrix View::ConstructScaledRenderingMatrix (  Spread *  pSpread, double  ScaleFactor )  [virtual]

Create a rendermatrix at ScaleFactor precision of the current Scale Allows you to create a bitmap with higher/lower resolution than the current view eg used to create a bitmap of a given invalid region at double the current zoom factor (ie synonymous concept to "double resolution" or "double DPI"). Author: Ilan_Copelyn (Xara Group Ltd) <camelotdev@xara.com> Date: 06/06/00 Parameters: pSpread  = the spread that is to be rendered. [INPUTS] ScaleFactor = multiplier for current Scale (ie zoom factor) Returns: The required transformation matrix. See also: View::ConstructRenderingMatrix(Spread *pSpread) Definition at line 1171 of file view.cpp. { // 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); FIXED16 ScaledScale = Scale.MakeDouble() * ScaleFactor; Matrix ScaleMat(ScaledScale, ScaledScale); // 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; // Apply scroll-offset translation to move origin to viewing position... RenderMatrix *= TranslateToOrigin; return RenderMatrix; }

virtual void View::ContinueRenderView (  RenderRegion *  , Spread *  , BOOL  fRenderPaper = TRUE, BOOL  fDeleteRegionAfter = TRUE, BOOL  bForceImmediate = FALSE )  [pure virtual]

Implemented in DocView, ExpressView, PrintView, XPFView, ClipboardView, DialogView, and MetafileView.

void View::Deinit (  void   )  [static]

De-initialises the view system. At the moment this involves destroying our PaperRenderRegion. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/23/95 See also: View; PaperRenderRegion. Definition at line 298 of file view.cpp. { // Lose our PaperRenderRegion... delete pPaperRegion; delete pOnTopRegion; }

void View::DeInitOnTopRegion (   )  [static]

Deinitialises the static OnTop RenderRegion, used for blob rendering. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/95 Definition at line 568 of file view.cpp. { if (pOnTopRegion) pOnTopRegion->DetachDevice(); }

void View::DoneWithDC (   )  [virtual]

Hints that we've done with our DC. Author: Alex Bligh <alex@alex.org.uk> Date: 12/06/2006 See also: View; PaperRenderRegion. Note this is merely a hint. This routine is not guaranteed to eb called Definition at line 280 of file view.cpp. { if (pViewWindow) pViewWindow->DoneWithDC(); }

ColourContext * View::GetColourContext (  ColourModel  Model, BOOL  ReturnNULLIfNone = FALSE )

To find an appropriate colour context in the given colour model for use when rendering into this view. This allows us to control colour separation and correction down to a per-view level. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/5/96 Parameters: Model  - The colour model of the context you want to find [INPUTS] ReturnNULLIfNone - if FALSE, an appropriate view will be found, by searching my parent document and global contexts if necessary. if TRUE, then if this view hasn't got it's own special context it will immediately return NULL. Returns: NULL, or a pointer to an appropriate context. Notes: This only functions for RGB and CMYK contexts at present. If you wish to render to a view using an output context of a different type, you will need to upgrade tios method. ONLY Use the returned pointer temporarily - If the view is deleted or if the ColourPlate options on the view are changed, the context will be deleted. You should thus always call this function to get the current Context - it's cached, and quick after the first call. See also: View::GetColourPlate; View::SetColourPlate; ColourContext; ColourManager Definition at line 1407 of file view.cpp. { // If our internal flag is set, we will return a default global colour context // This allows View::RenderOptimalBitmapPhase to create RenderRegions which will // not colour spearate or correct (as we want to do the correction as a post process // on the produced bitmap) if (ForceDefaultColourContexts) return(ColourManager::GetColourContext(Model, pDoc)); // Under normal circumstances, if we have a special ColourPlate, we look in our // cache for an appropriate context. First, we'll make sure an appropriate context // is cached (We don't do this if the caller specified ReturnNULLIfNone) if (!ReturnNULLIfNone && ColourContexts.Context[Model] == NULL && ColPlate != NULL) { // It's not cached yet - create a new context of this type ColourContext *NewCC = NULL; switch(Model) { case COLOURMODEL_RGBT: NewCC = new ColourContextRGBT(this); break; case COLOURMODEL_CMYK: NewCC = new ColourContextCMYK(this); break; default: ERROR3("View::GetColourContext only supports RGB/CMYK contexts at present"); break; } if (NewCC != NULL) { // Copy our ColourPlate ColourPlate *NewPlate = new ColourPlate(*ColPlate); if (NewPlate == NULL) { // Failure - delete the ColourContext and abandon the attempt delete NewCC; NewCC = NULL; } else { // Attach the ColourPlate to the context, add it into our cache of ColourContexts, // and add the new context to the context list NewCC->SetColourPlate(NewPlate); ColourContextList *cclist = ColourContextList::GetList(); ERROR3IF(cclist == NULL, "No ColourContextList? What's up?"); ColourContexts.Context[Model] = NewCC; cclist->AddContext(&(ColourContexts.Context[Model])); } } } // See if we've got a cached context we can return ColourContext *cc = ColourContexts.Context[Model]; // If we own our own colour context, then use it. Otherwise, find a suitable // context from our parent document; if that has none, then use a global default. // (We don't do this if the caller specified ReturnNULLIfNone) if (cc == NULL && !ReturnNULLIfNone) cc = ColourManager::GetColourContext(Model, pDoc); return(cc); }

ColourPlate * View::GetColourPlate (  void   )

To find out what colour separation options are currently in use by this view. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/6/96 Returns: NULL, or a pointer to the current ouptut ColourPlate See also: View::SetColourPlate; View::GetColourContext Definition at line 1495 of file view.cpp. { return(ColPlate); }

CCamView * View::GetConnectionToOilView (   )  const

To get a pointer to the OIL view object which mirrors this one. Note that this can return NULL if the View does not have a mirroring OIL object. In this case the view is closed but the View remains available so that in the future a new view will be able to use all of its viewing parameters. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 18/5/93 Returns: Pointer to the OIL view object which mirrors this one. Definition at line 350 of file view.cpp. { return pViewWindow; }

double View::GetConvertToEditableShapesDPI (   )  [virtual]

Allows derived view classes to override the reolution. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 18/08/2005 Returns: The resolution to use for convert top editable shapes operations while this view is current Reimplemented in XPFView. Definition at line 1343 of file view.cpp. { INT32 iPixPerInch = 0; if (!GetApplication()->GetConvertToEditableShapesDPI(&iPixPerInch)) { ERROR3("View::GetConvertToEditableShapesDPI; Couldn't get app's dpi"); iPixPerInch = 96; } return(iPixPerInch); }

View * View::GetCurrent (   )  [static]

Find the current View object which SHOULD have been set as one of the very first actions during event processing. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 24/5/93 Returns: Pointer to the current View object. Reimplemented in DocView. Definition at line 386 of file view.cpp. { #ifdef RALPH if(::GetCurrentThreadId() == RalphDocument::GetImportingThreadID()) { return RalphDocument::GetImportingDoc()->GetFirstDocView(); } #endif return Current; }

Document * View::GetDoc (   )  const

Returns the linake between this View and its Document. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 28/3/94 Returns: A pointer to the kernel Document associated with this View. Definition at line 368 of file view.cpp. { return pDoc; }

virtual DocRect View::GetDocViewRect (  Spread *   )  [pure virtual]

Implemented in DocView, ExpressView, PrintView, XPFView, ClipboardView, DialogView, and MetafileView.

BOOL View::GetForceDefaultColourContexts (  void   )  [inline]

Definition at line 374 of file view.h. { return(ForceDefaultColourContexts); }

virtual BOOL View::GetForeBackMode (   )  [pure virtual]

Implemented in DocView, ExpressView, PrintView, XPFView, ClipboardView, DialogView, and MetafileView.

FIXED16 View::GetPixelHeight (   )

Get the height of a pixel in this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/19/95 Returns: The pixel height for this view Definition at line 1238 of file view.cpp. { return PixelHeight; }

void View::GetPixelSize (  FIXED16 *  pPixelWidth, FIXED16 *  pPixelHeight )

Get the size of a pixel in this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/10/95 Parameters: pPixelWidth,pPixelHeight  - pixel size. [OUTPUTS] Definition at line 1254 of file view.cpp. { *pPixelWidth = PixelWidth; *pPixelHeight = PixelHeight; }

FIXED16 View::GetPixelWidth (   )

Get the width of a pixel in this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/19/95 Returns: The pixel width for this view Definition at line 1221 of file view.cpp. { return PixelWidth; }

PrintControl * View::GetPrintControl (   )

Simple way of getting the PrintControl object associated with this view's document. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 05/09/95 Returns: Pointer to the PrintControl object, or NULL if none found, or the view is not attached to a document. Errors: If no print control found => ERROR2 Definition at line 4172 of file view.cpp. { #ifndef STANDALONE if (pDoc == NULL) // This view is not attached to a document (e.g. it's a DialogView) return NULL; // Find print control object for this document, to see if we are // printing via bitmap, and so if we need to band the output. PrintComponent *pPrintComponent = (PrintComponent *) pDoc->GetDocComponent(CC_RUNTIME_CLASS(PrintComponent)); ERROR2IF(pPrintComponent == NULL, NULL, "Unable to find PrintComponent object in document."); PrintControl *pPrintControl = pPrintComponent->GetPrintControl(); ERROR2IF(pPrintControl == NULL, NULL, "Unable to find PrintControl object in document component."); return pPrintControl; #else return NULL; #endif }

virtual wxDC* View::GetRenderDC (   )  [pure virtual]

Implemented in DocView, ExpressView, PrintView, XPFView, ClipboardView, DialogView, and MetafileView.

FIXED16 View::GetScaledPixelHeight (   )

Get the height of a scaled pixel in this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/19/95 Returns: The scaled pixel height for this view Definition at line 1307 of file view.cpp. { return ScaledPixelHeight; }

void View::GetScaledPixelSize (  FIXED16 *  pScaledPixelWidth, FIXED16 *  pScaledPixelHeight )

Get the size of a scaled pixel in this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/10/95 Parameters: pScaledPixelWidth,pScaledPixelHeight  - scaled pixel size. [OUTPUTS] Definition at line 1323 of file view.cpp. { *pScaledPixelWidth = ScaledPixelWidth; *pScaledPixelHeight = ScaledPixelHeight; }

FIXED16 View::GetScaledPixelWidth (   )

Get the width of a scaled pixel in this view. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/19/95 Returns: The scaled pixel width for this view Definition at line 1290 of file view.cpp. { return ScaledPixelWidth; }

WorkCoord View::GetScrollOffsets (   )  const

To find the position of the top left corner of the display. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 6/7/93 Returns: Top left corner of the viewport in WorkCoords. Definition at line 1038 of file view.cpp. { ERROR2IF(this==NULL,WorkCoord(0,0),"View member func called on NULL pointer"); return pVState->GetScrollPos(); }

virtual WorkRect View::GetViewRect (   )  [pure virtual]

Implemented in DocView, ExpressView, PrintView, XPFView, ClipboardView, DialogView, and MetafileView.

FIXED16 View::GetViewScale (   )  const

Inquire the viewing scale factor from this View. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 31/5/93 Returns: Viewing scale factor for this view. Definition at line 1091 of file view.cpp. { return Scale; }

BOOL View::IsPrintableNodeSelected (  Node *  pNode  )  [static]

Determine whether a given node should be rendered when we are printing with "selected objects only" enabled. It checks to see if the node is bounded - if it isn't, then it's an attribute or similar and so is always rendered. If it is bounded then return TRUE if it is selected or if it is the child of a selected object. Otherwise we return FALSE to indicate that it should not be printed. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 05/28/95 Parameters: pNode  - the node to check. [INPUTS] Returns: TRUE if the node should be printed; FALSE if not. See also: View::RenderSimpleNodes Definition at line 2228 of file view.cpp. { if (pNode->IsBounded()) { // We must check the selected status of this node. // Even if this node is not selected, its parent might be, so we // scan upwards until we find a layer, or a selected node. Node *pTestNode = pNode; while ((pTestNode != NULL) && (!pTestNode->IsSelected()) && (!pTestNode->IsLayer())) { pTestNode = pTestNode->FindParent(); } // If we failed to find a parent at some point then it can't possibly be selected if (pTestNode == NULL) return(FALSE); // If it is selected then we'd better print this node if (pTestNode->IsSelected()) return(TRUE); // If the original node is a shadow then we should test the right sibling // and print this node if that is selected if (pNode->IsAShadow()) { Node* pRightSibling = pNode->FindNext(); if (pRightSibling && pRightSibling->IsSelected()) return(TRUE); } // Fall back to not printing this node return(FALSE); // Ok, what did we find? // return ((pTestNode != NULL) && pTestNode->IsSelected()); } else { // It is a non-bounded node such as an attribute so we render it always. return TRUE; } }

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

Makes a new render region and adds it to the list associated with the DocView. Depending on the type of render region requested, it may be rendered to completion immediately (e.g. print regions are). Note that if PaintPaper is FALSE, pDevContext isn't used, so can be NULL. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Parameters: pSpread  - pointer to the spread concerned [INPUTS] ClipRect - Rectangle to create region from pDevContect - pointer to the device context for this region (may be NULL if PaintPaper == FALSE) rType - type of rendering PaintPaper - TRUE if paper should be redrawn immediately, FALSE otherwise (ignored for non-screen render regions). -  [OUTPUTS] Returns: - Reimplemented in PrintView. Definition at line 598 of file view.cpp. { // Construct the transformation matrix for the spread. Matrix RenderMatrix = ConstructRenderingMatrix(pSpread); // Go and create the new render region