ScreenView Class Reference

A subclass of CCamView which is the class actually used for screen display. More...

#include <scrvw.h>

Inheritance diagram for ScreenView:

List of all members.

Public Member Functions
	ScreenView ()
	Default constructor for a ScreenView window. Sets the pointers to the child windows to null, so that an incomplete construction of the view that is later destroyed won't try to delete invalid pointers. The Windows side of construction is done later, in the OnCreate() message handler.
virtual	~ScreenView ()
	Destroys a ScreenView window. Deletes child windows first. Updates the ScreenView population counter.
void	SetViewStateFromThis () const
	Called by a virgin ScreenView, ie. a view onto a new, unedited document. The function reads the attributes of the view window from the operating system, converts them into a device- independent form, and stores them in the ViewState.
void	SetThisFromViewState ()
	Move and resize the ScreenView according to the (device-independent) settings of a ViewState object. This typically happens when a new view is opened on a saved document.
virtual BOOL	IsScreenView ()
MouseOverRulerHit	IsMouseOverRuler ()
BOOL	IsTopmost () const
	Tests if this ScreenView is the active view, ie. is on top of all other views.
BOOL	ShouldEatClick () const
void	ClearEatFlag ()
wxDC *	GetRenderDC () const
	Allows the kernel to draw on the client area at times other than when processing WM_PAINT messages. Note that the pointer returned is temporary and should NOT be stored away for future use - it may well become invalid on the next idle event.
wxWindow *	GetRenderWindow () const
	Allows the kernel to access to the render window, useful on the odd occasion, although it does distort "encapsulation".
virtual void	GetClientSize (int *width, int *height) const
	Updates the ViewState object with the view's position, in an OS- independent form. This message is sent by the view's frame window whenever it is moved. Calculates the size of the ScreenView's RendWnd.
void	InvalidateView (const OilRect *pRect=0, BOOL updatenow=FALSE)
	Invalidates the appropriate section of the RendWnd client area - if the passed parameter is NULL then the whole client area is invalidated. The rectangle will be redrawn at some time in the (near) future.
virtual void	OnDraw (wxDC *pDc)
	Makes sure that the kernel knows which view to render into. Retrieves the clipping rectangle from the CDC. Passes the CDC and the rectangle to DocView::OnDraw(), which does the actual rendering.
virtual BOOL	OnPreparePrinting (CPrintInfo *pInfo)
	Current just returns that value of CView::DoPreparePrinting().
BOOL	GetScrollerStyle () const
	Tests whether proportional scroll bars are currently in operation.
void	SetScrollerStyle (BOOL proportional)
	Allows DocView to change the style - groovy or dull - of ScreenView's scroll bars. Records the setting and calls the appropriate functions of the scroll bar gadgets.
void	SetWorkAreaExtent (const WorkRect &area, BOOL redraw=TRUE)
	Provides read-only access to the WorkAreaExtent, as maintained by DocView/ScreenView. Calculates the size of the RendWnd, setting the "page size" of the scroll bars accordingly. Sets the scroll range of the scroll bars to the size of the WorkAreaExtent (note that the Y range is negated and inverted - the mother of all bodges).
void	GetScrollOffset (WorkCoord *pOffset) const
	Reads the offset from the horizontal and vertical scroll bars, combining then into a WorkCoord.
void	SetScrollOffset (const WorkCoord &pos, BOOL redraw=TRUE)
	Changes the scroll offset in the horizontal and vertical scroll bar. Note that it DOES NOT immediately scroll the client area, which is only done when the scroll bars send back a WM_SCROLLEREVENT message to the ScreenView.
void	ShowScrollers (BOOL Show)
	Hide or Show Scrollers.
void	ShowRulers (BOOL Show)
	Hide or Show Rulers.
BOOL	AreRulersVisible ()
BOOL	AreScrollersVisible ()
void	RecaptureMouseOnNextUpdate (void)
	Called by the OLE drag & drop system (CCamDropSource::QueryContinueDrag, winoil.cpp) when dragging a selection - if the mouse pointer goes outside the view, the selection drag is "paused", and an OLE drag is started. If the pointer comes back into our view, we cancel the OLE drag and resume the selector drag - the only thing we need to do to resume is to reclaim the mouse capture (but we must do it on the next idle to ensure that we get & keep the capture, so we flag it here and fix it up in OnTimer, above).
BOOL	StartDrag (Operation *pOp, DragType type, BOOL KeepAccuracy)
	Begins a drag operation, from the point of view of the OIL layer. Unbounds the mouse cursor, so it can go off-screen (display driver permitting). Captures all mouse input, to guarantee that the drag being started will terminate properly at some time in the future. Sets some internal variables indicating that ScreenView is in "drag mode". Finally, asks the system for a timer which is used to generate "idle" mouse events.
BOOL	EndDrag (Operation *pOp)
	Finishes a drag operation in the OIL layer. Releases mouse capture and restores the previous mouse cursor clipping rectangle (generally the screen). Sets internal variables to indicate that ScreenView is not in "drag mode". Kills the timer set in StartDrag().
BOOL	ChangeDragType (DragType Type)
	Allows someone to change the type of a drag (eg have Auto Scrolling on in some situations, but not in others). This function is mostly called from the Kernel (DocView) version of the same function.
void	ClearClickState ()
	Clear the current click state so that any logic in progress is stopped before it does anything nasty.
BOOL	InvokeDragOp (String_256 *pOpToken, OpParam *pParam, UINT32 Flags, wxPoint point)
	This func provides a mechanism that allows a drag op to be invoked as if it has been started as a result of clicking in the view. This allows drag ops to be invoked that aren't associated to a given tool.
BOOL	IsWaitingMouseMove ()
	There are some things in Camelot that are processed as a result of a mouse move message (Magnetic snapping to all the objects in the document for example). If these operations take a long time, there is little point in carrying on with the calculations if the mouse has already moved away from the coord being tested (and hence invalidating the findings of the search). This function checks to see if there is a mouse move message waiting in the queue to be processed, so that the callers can abort any processing they were doing if applicable.
BOOL	GetCurrentMousePos (OilCoord *pMousePos) const
	Finds out the current mouse position within this view window.
BOOL	CreateDragTarget (DragInformation *DragInfo)
	will create drag targets for appropriate drags
virtual BOOL	IsSelected (const CObject *pDocItem) const
	"Tests for a selected OLE client item".
void	OnFilePrint ()
void	OnFilePrintPreview ()
	Simply makes CView::OnFilePrintPreview() have public scope. Used by the menu system.
DocView *	GetDocViewPtr () const
	Used by Will's rendering system - somehow.
BOOL	IsSingleClickReallyTriple () const
BOOL	IsSingleClickReallyQuad () const
Static Public Member Functions
static BOOL	ReadViewPrefs ()
	Tries to load preferences for ScreenView, creating them with default values if they don't exist.
static INT32	HowMany ()
	None immediately springs to mind, although one day - who knows?
static DocView *	GetDocViewFromHwnd (wxWindow *hwnd)
	Given a window handle of a ScreenView render window, this function will return a pointer to the kernel DocView object that renders into that window, or NULL if there isn't one.
static DocView *	GetDocViewFromWindowID (CWindowID WinID)
static void	SetReadyMadeViewState (ViewState *pvs)
	Calls CCamView::Create() to attach a Windows object to the previously constructed C++ object. The view has a standard arrow cursor and a custom icon (_R(IDR_CAMTYPE)). The view is responsible for painting its background itself. The view is initially hidden, until its size and position have been properly set. Call this to set up a view-state object that ScreenView::OnInitialUpdate will use in preference to the one the ScreenView has got already. This is a nasty little "back-door" to changing the creation state of a ScreenView, used by the code that restores docs and views when the app starts. The reason we have to use code like this is that the Camelot doc/view architecture is NOT MFC.
static void	SetUseVisibleDefaults (BOOL state)
static BOOL	GetUseVisibleDefaults ()
static BOOL	GetDefaultRulersState ()
static BOOL	GetDefaultScrollersState ()
static void	SetDefaultRulersState (BOOL State)
static void	SetDefaultScrollersState (BOOL State)
static void	GetClickMods (wxMouseEvent &event, ClickModifiers *p)
	Helps convert an OIL-layer mouse event into a form acceptable to the kernel. Sets the fields of the ClickModifier according to which button is down/up, whether the SHIFT, CONTROL, or ALT key is held down etc. Note that as the fields of a ClickModifier are only one bit wide, we must be carefule when assigning the (integer) results of logical tests to them.
Protected Member Functions
virtual CCamCanvas *	CreateCanvas (wxView *v, wxMDIChildFrame *frame, const wxPoint &pos, const wxSize &size, long style)
void	UpdateViewPosition () const
	Updates the ViewState object shared between this ScreenView and its associated DocView with the new size of the view etc.
virtual void	OnInitialUpdate ()
virtual void	OnUpdate (wxView *sender, wxObject *hint=(wxObject *) NULL)
	Called when the view must first display the document. Moves this view/frame to the position given in the ViewState object.
virtual void	OnActivateView (bool bActivate, wxView *pActiveView, wxView *pDeactiveView)
	Called by MFC when a view gains or loses the input focus, either due to the the user clicking about, or another application popping up a window etc etc. I would just like to point out that this MFC function is the most brain-damaged Microsoft have come up so far. It's documentation bears no resemblance to the way the function is called/used - for example, as far as I can see, the two CView* parameters are NEVER different!
void	ScrollTo (const WorkCoord &offset)
	Scroll the client area of the window to the specified position. The offset must be converted to OS coordinates before being passed to Windows. If the new position of the view does not overlap the old position then the client area is completely redrawn. Otherwise, the Windows USER module is called to scroll the window.
void	HandleDragEvent (UINT32 Button, wxMouseEvent &event, ClickType t)
	Gathers together Windows information about a mouse event and passes it on to the kernel, by calling DocView::OnClick().
BOOL	HandleMouseWheelEvent (wxMouseEvent &event)
void	HandleDragScrolling (wxPoint point)
	Checks if the view window needs to be scrolled because the cursor has been dragged outside the window. The window will be scrolled if the current mode is AUTO_SCROLL (and the Scroll Lock key isn't latched!!). The scrolling itself is done by calling the routine in DocView, not ScreenView, so that the kernel has fair warning to remove any blobbies before the blit is done.
void	CalcScrollDeltas (wxPoint point, WinRect wrSize, INT32 *dx, INT32 *dy)
	Calculates the scroll deltas due to the current mouse position being outside the allowed rectangle. Helper function.
void	HandleButtonUp (UINT32 Button, wxMouseEvent &event)
	Finishes the current drag, if there is one, by elucidating the state of the buttons etc and calling DragDFinished() in the kernel (DocView). Called whenever a mouse button is released.
virtual void	HandleOleDragOutOfView (wxPoint point)
	Called when doing a DRAGTYPE_OLESCROLL and the mouse pointer moves outside the view window. The base class does nothing, so dragging continues as normal, but in the derived ScreenCamView class, this is used to cancel the internal XOR drag operation, and start an OLE drag and drop export procedure.
BOOL	PrintPaper (wxDC *pPrintDC, CCPrintInfo *pPrintInfo, PrintControl *pPrintControl)
WinRect	GetPrintClipRect (wxDC *pPrintDC, CCPrintInfo *pPrintInfo)
void	EnumeratePagePatches (CCPrintInfo *pPrintInfo)
void	OnSize (wxSizeEvent &event)
	Moved down to ScreenCamView.
void	OnLButtonDown (wxMouseEvent &event)
	Called by MFC upon receipt of a left-button-down mouse message. Finds out which other buttons are down (eg. SHIFT) and passes the message on to the kernel. Note that the mouse message will have originally come from the RendWnd object, a child window of ScreenView.
void	OnLButtonDblClk (wxMouseEvent &event)
	Passes a left-button double-click to ScreenView::HandleDragEvent().
void	OnLButtonUp (wxMouseEvent &event)
	Passes the event on to HandleButtonUp().
void	OnMButtonDown (wxMouseEvent &event)
	Called by MFC upon receipt of a middle-button-down mouse message. Finds out which other buttons are down (eg. SHIFT) and passes the message on to the kernel. Note that the mouse message will have originally come from the RendWnd object, a child window of ScreenView.
void	OnMButtonDblClk (wxMouseEvent &event)
	Passes a middle-button double-click to ScreenView::HandleDragEvent().
void	OnMButtonUp (wxMouseEvent &event)
	Passes the event on to HandleButtonUp().
void	OnRButtonDown (wxMouseEvent &event)
	Same as for ScreenView::OnLButtonDown(), but for the right mouse button.
void	OnRButtonDblClk (wxMouseEvent &event)
	Same as ScreenView::OnLButtonDblClk(), bit for the right button.
void	OnRButtonUp (wxMouseEvent &event)
	Same as ScreenView::OnLButtonUp(), but for the right mouse button.
void	OnMouseMove (wxMouseEvent &event)
	Packages up OIL-layer mouse-move messages before passing them on to DocView::DragPointerMove(). If ScreenView is not in "drag mode" the event is passed to our DocView, which will forward it to the current tool. Otherwise, checks if a CLICKTYPE_DRAG message has been sent to the kernel, sending one if it hasn't (this smooths the difference between Windows and RISC OS, the former system providing little support for drag operations).
void	OnMouseWheel (wxMouseEvent &event)
	Scope: Protected.
afx_msg void	OnDropFiles (HDROP hDropInfo)
	Respond to files being dropped onto the view window. It sets up the current document and docview, and passes control on to the OpDroppedFile operation.
afx_msg INT32	OnMouseActivate (wxWindow *pDesktopWnd, UINT32 nHitTest, UINT32 nMessage)
afx_msg void	OnTimer (UINT32 nIDEvent)
	Called when a key is pressed, so we can do something with it. It is currently only used to adjust the Pretend Pen Pressure. THIS CODE HAS BEEN COMMENTED OUT UNTIL THE NEW KEYBOARD SYSTEM IS FULLY OPERATIONAL!! Sends DragPointerIdle "events" to the kernel, when dragging. As Windows doesn't support such "idle" messages, the OIL drag system sets up a timer when a drag starts, and sends idle messages every time the timer elapses, until the drag is finished.
afx_msg void	OnCancelMode ()
	Called by the system whenever this window loses the focus to a dialogue box etc. Checks if the window is in drag mode, if it is makes sure that the drag is tidily cancelled, eg. the mouse is uncaptured and its clipping area restored. Calls DocView::DragFinished() (WITH JUNK PARAMETERS FOR THE MOUSE POSITION/BUTTONS) to indicate that the drag has been cancelled.
afx_msg void	OnInsertObject ()
	"Creates an embedded OLE object with a type-name retrieved from the user" - currently unimplemented.
afx_msg void	OnPaint ()
	Handles WM_PAINT messages for the ScreenView window. As the window is entirely covered by child windows, which know how to paint themselves, this function simply validates its (invisible) client area, removing the paint message. No drawing of any kind is done.
afx_msg BOOL	OnSetCursor (wxWindow *pWnd, UINT32 nHitTest, UINT32 nMessage)
	Calls the kernel DocView object to set the cursor for this ScreenView. Scope: Protected.
afx_msg LRESULT	OnScrollerEvent (WPARAM wp, LPARAM lp)
	This message is sent by the scroll bars in response to an earlier call to ScreenView::SetScrollOffset(). The scroll offset is read from the scroll bars and the ScrollPosition field of the ViewState is updated accordingly. If the WPARAM parameter is TRUE then the client area is repainted via a call to ScreenView::ScrollTo().
afx_msg LRESULT	OnRenderView (WPARAM wp, LPARAM lp)
	Responds to a WM_PAINT message sent to the RendWnd window object. Effectively tricks MFC into painting the RendWnd as if it was a CView window, not a child of a CView - calls CView::OnPrepareDC() and ScreenView::OnDraw().
afx_msg LRESULT	OnFrameMove (WPARAM x, LPARAM y)
afx_msg void	OnVScroll (UINT32 nSBCode, UINT32 nPos, CScrollBar *pScrollBar)
	The framework calls this member function when the user clicks a window's vertical scroll bar.
afx_msg void	OnHScroll (UINT32 nSBCode, UINT32 nPos, CScrollBar *pScrollBar)
	The framework calls this member function when the user clicks a window's horizontal scroll bar.
Protected Attributes
BOOL	fSetupDone
bool	fInitialUpdate
BOOL	fJustCreated
CWinScroller *	HScrollBar
CWinScroller *	VScrollBar
CScrollerCorner *	Corner
OILHorizontalRuler *	HRuler
OILVerticalRuler *	VRuler
OriginGadget *	OGadget
WinRect	CurrentSize
WorkRect	WorkArea
WorkCoord	OldOffset
BOOL	ScrollerStyle
BOOL	DragKeepAccuracy
BOOL	AutoScrollExcludeRulers
ClickType	LastClickType
UINT32	LastClickButton
wxPoint	LastClickPoint
wxPoint	CurrentMousePos
ClickModifiers	LastClickMods
UINT32	FirstClickButton
Operation *	pCurrentDragOp
DragType	CurrentDragType
WinRect	MouseClipRect
BOOL	OLERecaptureMouse
MonotonicTime	m_OLELastOutTime
String_256	DragOpToken
OpParam *	pDragOpParam
BOOL	DragOpInvoke
MonotonicTime	TimeOfLastClick
wxPoint	LastDoubleClickPos
BOOL	ThisSingleIsTriple
BOOL	ThisDoubleIsQuad
Static Protected Attributes
static INT32	PopCount
static ViewState *	pReadyMadeViewState
static BOOL	UnzoomOnNewView = FALSE
static BOOL	ZoomSingleView = TRUE
static BOOL	PropScrollersOn = TRUE
static BOOL	DefaultScrollersState = TRUE
static BOOL	DefaultRulersState = FALSE
static BOOL	UseVisibleDefaults = TRUE
static INT32	DragLatency = 3
	This function is called whenever the joystick moves. It is used currently to set the Pretend Pen Pressure from the joystick position. This function only exists under Win32.
static INT32	DragDelay = 500
static MonotonicTime	DragTimer
Classes
class	ScreenCanvas

---

Detailed Description

A subclass of CCamView which is the class actually used for screen display.

Author:

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

Date:

19/01/95

See also:

CCamView; PrintCamView

Definition at line 162 of file scrvw.h.

---

Constructor & Destructor Documentation

ScreenView::ScreenView (   )

Default constructor for a ScreenView window. Sets the pointers to the child windows to null, so that an incomplete construction of the view that is later destroyed won't try to delete invalid pointers. The Windows side of construction is done later, in the OnCreate() message handler. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Updates the ScreenView population counter. Called from somewhere deep inside MFC. Returns: Errors: - Scope: Protected. See also: ScreenView::OnCreate(); ScreenView::~ScreenView() Definition at line 299 of file scrvw.cpp. { // TRACEUSER( "Richard", _T("ScreenView::ScreenView()\n")); // No child windows or connections yet. // RenderWindow = NULL; HScrollBar = NULL; VScrollBar = NULL; PORTNOTE("other","Removed CScrollerCorner usage") #ifndef EXCLUDE_FROM_XARALX Corner = NULL; #endif // WEBSTER - markn 15/1/97 // No rulers in Webster #ifndef WEBSTER HRuler = NULL; VRuler = NULL; OGadget= NULL; #endif // WEBSTER // Set/clear these internal flags. fSetupDone = FALSE; fInitialUpdate = false; // Not dragging or scrolling either. ScrollerStyle = TRUE; pCurrentDragOp = NULL; OLERecaptureMouse = FALSE; // Set up click event variables LastClickType = CLICKTYPE_NONE; LastClickButton = 0; LastClickPoint.x = 0; LastClickPoint.y = 0; CurrentMousePos.x = 0; CurrentMousePos.y = 0; FirstClickButton = 0; DragKeepAccuracy = TRUE; AutoScrollExcludeRulers = FALSE; // Bump the population. PopCount++; // Vars used by InvokeDragOp() mechanism DragOpToken = ""; pDragOpParam = NULL; DragOpInvoke = FALSE; // Triple and quad click support LastDoubleClickPos = wxPoint( 0, 0 ); ThisSingleIsTriple = FALSE; ThisDoubleIsQuad = FALSE; // Set this flag until we have been through OnActivateView once, after which we can // include this view in the eat-activating-click system. fJustCreated = TRUE; }

ScreenView::~ScreenView (   )  [virtual]

Destroys a ScreenView window. Deletes child windows first. Updates the ScreenView population counter. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - Scope: Public See also: ScreenView::ScreenView() Definition at line 379 of file scrvw.cpp. { TRACEUSER( "Richard", _T("ScreenView::~ScreenView()\n")); // Deregister for WM_DROPFILES messages // VC2 Beta 1 asserts with a zero handle here so we check PORTNOTE("other","Removed DragAcceptFiles usage") #ifndef EXCLUDE_FROM_XARALX if (m_hWnd) DragAcceptFiles(TRUE); #endif // delete RenderWindow; GetCanvas()? PORTNOTE("other","Removed CWinScroller usage") #ifndef EXCLUDE_FROM_XARALX delete HScrollBar; delete VScrollBar; #endif PORTNOTE("other","Removed CScrollerCorner usage") #ifndef EXCLUDE_FROM_XARALX delete Corner; #endif // WEBSTER - markn 15/1/97 // No rulers in Webster #ifndef WEBSTER #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) delete HRuler; delete VRuler; delete OGadget; #endif #endif // WEBSTER PopCount--; // one less ScreenView in the world, sigh }

---

Member Function Documentation

BOOL ScreenView::AreRulersVisible (   )

Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Ruler Visible state. Errors: - Scope: Public Reimplemented from CCamView. Definition at line 557 of file scrvw.cpp. { #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) if(Status) return Status->RulersVisible; #endif return FALSE; };

BOOL ScreenView::AreScrollersVisible (   )

Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Scroller Visible state. Errors: - Scope: Public Reimplemented from CCamView. Definition at line 580 of file scrvw.cpp. { if(Status) return Status->ScrollersVisible; return FALSE; }

void ScreenView::CalcScrollDeltas (  wxPoint  point, WinRect  wrSize, INT32 *  dx, INT32 *  dy )  [protected]

Calculates the scroll deltas due to the current mouse position being outside the allowed rectangle. Helper function. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> (from Justin) Date: 22/9/96 Parameters: point  The current position of the mouse cursor. [INPUTS] wrSize The rectangle controlling scrolling. dx  The amount to scroll in the X axis. [OUTPUTS] dy The amount to scroll in the Y axis. Returns: - Errors: - Scope: Protected See also: ScreenView::HandleDragScrolling Reimplemented from CCamView. Definition at line 3298 of file scrvw.cpp. { if( point.x < wrSize.GetLeft() ) *dx = point.x - wrSize.GetLeft(); else if( point.x >= wrSize.GetRight() ) *dx = point.x - wrSize.GetRight(); else *dx = 0; if( point.y < wrSize.GetTop() ) *dy = point.y - wrSize.GetTop(); else if( point.y >= wrSize.GetBottom() ) *dy = point.y - wrSize.GetBottom(); else *dy = 0; }

BOOL ScreenView::ChangeDragType (  DragType  Type  )

Allows someone to change the type of a drag (eg have Auto Scrolling on in some situations, but not in others). This function is mostly called from the Kernel (DocView) version of the same function. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 3/4/95 Parameters: Type  - the type of drag to change to [INPUTS] Returns: TRUE See also: DocView::ChangeDragType Reimplemented from CCamView. Definition at line 2982 of file scrvw.cpp. { // Change the current drag type CurrentDragType = Type; m_OLELastOutTime.Sample(); OLERecaptureMouse = FALSE; return TRUE; }

void ScreenView::ClearClickState (   )

Clear the current click state so that any logic in progress is stopped before it does anything nasty. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 26/02/2004 Reimplemented from CCamView. Definition at line 4169 of file scrvw.cpp. { LastClickType = CLICKTYPE_NONE; if( GetParentFrame()->HasCapture() ) { GetParentFrame()->ReleaseMouse(); } }

void ScreenView::ClearEatFlag (   )

virtual CCamCanvas* ScreenView::CreateCanvas (  wxView *  v, wxMDIChildFrame *  frame, const wxPoint &  pos, const wxSize &  size, long  style )  [inline, protected, virtual]

Reimplemented in ScreenCamView. Definition at line 197 of file scrvw.h. : Correct */ long style ) { return new ScreenCanvas( v, frame, pos, size, style ); }

BOOL ScreenView::CreateDragTarget (  DragInformation *  DragInfo  )

will create drag targets for appropriate drags Author: Chris_Parks (Xara Group Ltd) <camelotdev@xara.com> Date: 21/1/95 Parameters: DragInfo  : details about the current drag [INPUTS] -  [OUTPUTS] Returns: Errors: - Reimplemented from CCamView. Definition at line 650 of file scrvw.cpp. { #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) // TEMPORARY - only create drag targets for the selected (frontmost/input-focus) // DocView. This stops us allowing colour drags to go into the wrong document // if the user ctrl-tabs to a different window during the drag. // Ideally, drags will be allowed, but the colour will be copied to the destination // document before being applied, but currently we don't have time to implement all that if (pDocView != DocView::GetSelected()) return FALSE; if (DragInfo->CanDropOnPage()) { // If the drag can be dropped onto an object or the page, then we will accept it ViewDragTarget * NewTarget; NewTarget = new ViewDragTarget(RenderWindow->m_hWnd,NULL,DragInfo); return TRUE; } #endif return FALSE; }

BOOL ScreenView::EndDrag (  Operation *  pOp  )

Finishes a drag operation in the OIL layer. Releases mouse capture and restores the previous mouse cursor clipping rectangle (generally the screen). Sets internal variables to indicate that ScreenView is not in "drag mode". Kills the timer set in StartDrag(). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: A  pointer to the current drag operation (currently not used). [INPUTS] -  [OUTPUTS] Returns: TRUE if the drag is successfully terminated. Errors: ASSERTion failure if ScreenView was not already in "drag mode". Scope: Public See also: ScreenView::StartDrag(); ScreenView::HandleDragEvent() Reimplemented from CCamView. Definition at line 2930 of file scrvw.cpp. { /* #ifdef _DEBUG // Prevent a very nasty recursive ENSURE! if (!CCamApp::IsDisabled()) { ENSURE(pCurrentDragOp != 0, "ScreenView::EndDrag: pCurrentDragOp is zero"); } #endif // _DEBUG */ // Restore the previous mouse clipping rectangle. Windows will move the // mouse, if necessary, so that the mouse is within the new clipping // rectangle (or so the documentation says!) //::ClipCursor(&MouseClipRect); pCurrentDragOp = 0; FirstClickButton = 0; DragKeepAccuracy = TRUE; if (m_pCanvas && m_pCanvas->GetCapture() == m_pCanvas) m_pCanvas->ReleaseMouse(); // Check status of temporary tool selection - this is because we don't change tool // mid-drag! (e.g. user holds down Alt to get selector, starts drag, releases Alt, // then ends drag - we want to restore the original tool). Tool::EndDrag(); // Kill the timer started in HandleDragEvent(). PORTNOTE("other","Removed FixKillTimer usage") #ifndef EXCLUDE_FROM_XARALX return ::FixKillTimer(m_hWnd, 1); #else return TRUE; #endif }

void ScreenView::EnumeratePagePatches (  CCPrintInfo *  pPrintInfo  )  [protected]

Reimplemented from CCamView.

void ScreenView::GetClickMods (  wxMouseEvent &  event, ClickModifiers *  p )  [static]

Helps convert an OIL-layer mouse event into a form acceptable to the kernel. Sets the fields of the ClickModifier according to which button is down/up, whether the SHIFT, CONTROL, or ALT key is held down etc. Note that as the fields of a ClickModifier are only one bit wide, we must be carefule when assigning the (integer) results of logical tests to them. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: The  mouse event passed by wx to a mouse message-handler function. [INPUTS] Changes  the ClickModifier to reflect the button flags. [OUTPUTS] Returns: - Errors: - Scope: Public See also: ScreenView::HandleDragEvent() Reimplemented from CCamView. Definition at line 2259 of file scrvw.cpp. { *p = ClickModifiers::GetClickModifiers(event); }

void ScreenView::GetClientSize (  int *  pWidth, int *  pHeight )  const [virtual]

Updates the ViewState object with the view's position, in an OS- independent form. This message is sent by the view's frame window whenever it is moved. Calculates the size of the ScreenView's RendWnd. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] The  width and height of the client area which the kernel can render into. [OUTPUTS] Returns: - Errors: - Scope: Public See also: class CRendWnd Reimplemented from CCamView. Definition at line 1429 of file scrvw.cpp. : Correct */ { // OilRect r = CurrentSize.ToOil(pDocView); // *pWidth = r.Width(); // *pHeight = r.Height(); WinRect wrect(0,0,0,0); GetCanvas()->GetClientSize(&wrect.width,&wrect.height); OilRect orect = wrect.ToOil(pDocView); *pWidth = orect.Width(); *pHeight = orect.Height(); }

BOOL ScreenView::GetCurrentMousePos (  OilCoord *  pMousePos  )  const

Finds out the current mouse position within this view window. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: -  [INPUTS] pMousePos  the mouse position within this view, in OIL coordinates [OUTPUTS] Returns: TRUE if the mouse is within this view, and hence that *pMousePos holds its position; FALSE if the mouse is outside the view (in which case pMousePos is unchanged). Errors: - See also: - Reimplemented from CCamView. Definition at line 3731 of file scrvw.cpp. { // Get the Windows screen coordinates of the mouse cursor. // Convert from screen to window coordinates. WinCoord pt; *(wxPoint *)&pt = GetCanvas()->ScreenToClient( ::wxGetMousePosition() ); // If the mouse is outside the view then we can do nothing more. if (!CurrentSize.Inside(pt)) return FALSE; // Convert to OIL coordinates. if (pMousePos!=NULL) *pMousePos = pt.ToOil(pDocView, TRUE); // We stored something useful. return TRUE; }

static BOOL ScreenView::GetDefaultRulersState (   )  [inline, static]

Reimplemented from CCamView. Definition at line 324 of file scrvw.h. { return DefaultRulersState;};

static BOOL ScreenView::GetDefaultScrollersState (   )  [inline, static]

Reimplemented from CCamView. Definition at line 325 of file scrvw.h. { return DefaultScrollersState;};

DocView * ScreenView::GetDocViewFromHwnd (  wxWindow *  hwnd  )  [static]

Given a window handle of a ScreenView render window, this function will return a pointer to the kernel DocView object that renders into that window, or NULL if there isn't one. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 28/7/94 Parameters: The  handle of the render window to find. [INPUTS] -  [OUTPUTS] Returns: A pointer to the DocView associated with a render window, or NULL if there isn't one. Errors: - See also: - Definition at line 691 of file scrvw.cpp. { PORTNOTETRACE("other","ScreenView::GetDocViewFromHwnd - do nothing"); #ifndef EXCLUDE_FROM_XARALX // For all kernel documents in existence . . . List* pDocList = &(GetApplication()->Documents); for (Document* pKernelDoc = (Document*) pDocList->GetHead(); pKernelDoc != NULL; pKernelDoc = (Document*) pDocList->GetNext(pKernelDoc)) { if(pKernelDoc->IsARalphDoc()) { // a bit unpleasent - only works because Ralph Docs have only one view.. // get the first (and only) docview DocView * pDocView = pKernelDoc->GetFirstDocView(); // check handles if(pDocView) if( pDocView->GetRenderWindow() == hwnd ) return pDocView; } else { // Convert from a kernel document to an OIL document. CCamDoc* pCamDoc = pKernelDoc->GetOilDoc(); // For all views onto the OIL document . . . POSITION pos = pCamDoc->GetFirstViewPosition(); while (pos != NULL) { // Compare the handle of the view's render window to the given handle, // returning the associated DocView if they match. ScreenView* pCamView = (ScreenView*) pCamDoc->GetNextView(pos); // Not interested unless it is a ScreenView (it could be a print preview view) if (pCamView->IsKindOf(RUNTIME_CLASS(ScreenView))) { if (pCamView->RenderWindow->m_hWnd == hwnd) { return pCamView->pDocView; } } } } } #endif // Couldn't find the handle, so return nothing. return NULL; }

DocView * ScreenView::GetDocViewFromWindowID (  CWindowID  WinID  )  [static]

Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 15/1/95 Parameters: Window  ID [INPUTS] Returns: A pointer to the DocView associated with the window ID, else NULL Also See: GetDocViewFromHwnd() Reimplemented from CCamView. Definition at line 753 of file scrvw.cpp. { return GetDocViewFromHwnd( (wxWindow *)WinID ); }

DocView * ScreenView::GetDocViewPtr (   )  const

Used by Will's rendering system - somehow. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the DocView object associated with this CCamView. Errors: - Scope: Public See also: Will's stuff. Reimplemented from CCamView. Definition at line 4224 of file scrvw.cpp. { return pDocView; }

WinRect ScreenView::GetPrintClipRect (  wxDC *  pPrintDC, CCPrintInfo *  pPrintInfo )  [protected]

Reimplemented from CCamView.

wxDC * ScreenView::GetRenderDC (   )  const [virtual]

Allows the kernel to draw on the client area at times other than when processing WM_PAINT messages. Note that the pointer returned is temporary and should NOT be stored away for future use - it may well become invalid on the next idle event. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 2nd Sept 1993 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the CDC object associated with the RenderWindow. Errors: Returns NULL if the DC could not be obtained. Scope: Public See also: ScreenView::OnDraw() Reimplemented from CCamView. Definition at line 1795 of file scrvw.cpp. { // // GAT: Warning - I don't think we want to be using this function anymore. // Create a DC when required. // PORTNOTETRACE("other","ScreenView::GetRenderDC - do nothing"); #ifndef EXCLUDE_FROM_XARALX return GetCanvas()->GetDC(); #else return NULL; #endif }

wxWindow * ScreenView::GetRenderWindow (   )  const

Allows the kernel to access to the render window, useful on the odd occasion, although it does distort "encapsulation". Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 15th October 1993 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the RenderWindow child of this ScreenView Errors: - Scope: Public See also: ScreenView::GetRenderDC() Reimplemented from CCamView. Definition at line 1827 of file scrvw.cpp. { return GetCanvas(); }

BOOL ScreenView::GetScrollerStyle (   )  const

Tests whether proportional scroll bars are currently in operation. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if this ScreenView is currently sporting proportional scroll bars, FALSE if it isn't, and its scroll bars look like typical naff Windows ones