DragManagerOp Class Reference

An instantiation of this class (created by a call to its static StartDrag method) is used to describe a current global drag. When the drag completes, this object will self destruct. While alive, this object controls the drag, passing relevant events on to registered drag targets, etc. See the documentation for a fuller description of the global drag system. More...

#include <dragmgr.h>

Inheritance diagram for DragManagerOp:

List of all members.

Public Member Functions
virtual BOOL	OnIdleEvent (void)
	To process idle events. If the mouse hasn't moved, then we'll allow low priority handlers a look-in. This means that (e.g.) when dragging background- redrawing galleries, we get instant response while dragging, and the background redraw will only occur while the mouse is held still.
Static Public Member Functions
static void	StartDrag (DragInformation *Descriptor, CWindowID DragWindow)
	Starts a global-drag off This will create a new DragManagerOp object, set up the drag, and broadcast a DragMsg DRAGSTARTED, as a result of which, DragTargets should be created by interested parties (these will register with the Drag Manager, and then be called to handle events during the drag).
static void	EndDrag (INT32 Flags)
	Input : Flags : mouse button state( 1=leftclick/-1= rightclick ).
static void	AbortDrag (void)
	To forcibly abort the current drag. If there is no current drag, then nothing happens (so it can be called just to ensure that no drag is left current on exit for example).
static DragManagerOp *	GetCurrentManager (void)
	To find the current drag manager.
static BOOL	GetStatusText (String_256 *StatusText)
	put status text in a buffer
static CaptureHandler *	GetDragCaptureHandler ()
	return the capture handler
static DragInformation *	GetCurrentDragInfo ()
	return Current drag information
static wxPoint	GetDragMousePos ()
	return a CPoint for the Last Mouse Position
static BOOL	IsDragActive ()
static void	SetDragActive (BOOL State)
static void	RedrawStarting (void)
	Tell the drag manager that an external redraw has started. This allows it to remove its solid drag stuff so that the screen display is not screwed up. You should also call RedrawFinished when you finish redrawing.
static void	RedrawStarting (CWindowID TheWindow, CGadgetID TheGadget, DocRect *TheArea=NULL)
	Tell the drag manager that an external redraw has started, within a specific window and gadget.
static void	RedrawFinished (void)
	Tell the drag manager that an external redraw has finished.
Protected Member Functions
	DragManagerOp ()
	DragManagerOp constructor - DO NOT CALL THE DEFAULT CONSTRUCTOR!
	DragManagerOp (DragInformation *Descriptor)
	DragManagerOp constructor.
	~DragManagerOp ()
	DragManagerOp destructor.
void	RegisterTarget (DragTarget *NewTarget, BOOL HighPriority=FALSE)
	To register a Drag Target with the current Drag Manager This method is automatically called by DragTargets when they are constructed, and is only available to frined classes.
void	DeregisterTarget (DragTarget *OldTarget)
	To register a Drag Target with the current Drag Manager This method is automatically called by DragTargets when they are constructed, and is only available to frined classes.
Static Protected Member Functions
static void	SetCursor ()
	Set the cursor !
static void	SetStatusLineText ()
	Write Status line help.
Private Member Functions
BOOL	ProcessEvent (DragEventType Event)
	To process global drag events This method calls each DragTarget event processor in turn (until one claims the event), with the event. The 3 'Current' member variables are passed in to the event processor, so ensure they are set up appropriately before calling this method.
void	CleanUpAfterDrag (void)
	Generic clean-up method. Deletes all registered DragTargets, and any other information (DragInformation, last keypress info, etc) which is still lying about in the DragManagerOp. Also deregisters our idle event handlers etc. Used by destructor, and also by all forms of Drag completion to free our memory claims, etc.
Private Attributes
UINT32	CurrentID
Cursor *	CurrentCursor
List	Targets
KeyPress *	CurrentKeypress
wxPoint	InitialMousePos
wxPoint	CurrentMousePos
wxPoint	LastMousePos
DragEventType	LastEvent
Static Private Attributes
static DragManagerOp *	CurrentManager = NULL
static DragInformation *	CurrentDragInfo = NULL
static DragTarget *	CurrentDragTarget = NULL
static UINT32	StatusLineStringID = 0
static CaptureHandler *	TheCaptureHandler = NULL
static BOOL	DragPending = FALSE
static BOOL	DragEnded = FALSE
static MonotonicTime	DragStartTimer
static UINT32	DragMinDist = DEFAULT_DRAGDIST
static UINT32	DragDelay = DEFAULT_DRAGDELAY
static wxRect	DragStartRect
static wxRect	StillClickRect
static BOOL	DragActive = FALSE
static BOOL	RedrawInProgress = FALSE
Friends
class	DragTarget
class	KernelDragTarget
class	OilDragTarget
class	CaptureHandler
class	DragInformation

---

Detailed Description

An instantiation of this class (created by a call to its static StartDrag method) is used to describe a current global drag. When the drag completes, this object will self destruct. While alive, this object controls the drag, passing relevant events on to registered drag targets, etc. See the documentation for a fuller description of the global drag system.

Author:

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

Date:

2/1/95

See also:

DragManagerOp::StartDrag; DragTarget; DragInformation

Documentation: Docs.doc

Definition at line 186 of file dragmgr.h.

---

Constructor & Destructor Documentation

DragManagerOp::DragManagerOp (   )  [protected]

DragManagerOp constructor - DO NOT CALL THE DEFAULT CONSTRUCTOR! Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 927 of file dragmgr.cpp. { ERROR3("DragManagerOp::DragManagerOp - Illegal (default) constructor called!\n"); ERROR3IF(CurrentManager != NULL, "Attempt to start a drag while already dragging!"); CurrentManager = this; CurrentID = 0; CurrentCursor = NULL; }

DragManagerOp::DragManagerOp (  DragInformation *  Descriptor  )  [protected]

DragManagerOp constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Parameters: Descriptor  - Describes the current drag. May not be NULL. [INPUTS] Definition at line 953 of file dragmgr.cpp. { ERROR3IF(Descriptor == NULL, "DragManagerOp must be given a valid DragInformation ptr"); ERROR3IF(CurrentManager != NULL, "Attempt to start a drag while already dragging!"); AbortDrag(); CurrentManager = this; CurrentDragInfo = Descriptor; CurrentKeypress = NULL; DragEnded = FALSE; CurrentID = 0; CurrentCursor = NULL; // get system drag start values. We override the default values suggested by the // OLE2 docs, because their values are stupid. (2 pixels? Bleedin' heck! I wish MY // mouse was that steady!). However, we red the values from Win.INI like good boys, so // the user can override them if they so desire. // DragMinDist = GetProfileInt("windows", "DragMinDist", DEFAULT_DRAGDIST); // DragDelay = GetProfileInt("windows", "DragDelay", DEFAULT_DRAGDELAY); DragMinDist = DEFAULT_DRAGDIST; DragDelay = DEFAULT_DRAGDELAY; DragStartRect = wxRect(); }

DragManagerOp::~DragManagerOp (   )  [protected]

DragManagerOp destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 995 of file dragmgr.cpp. { // Ensure all memory allocations are deleted CleanUpAfterDrag(); // We are no longer the current drag manager CurrentManager = NULL; DragActive = FALSE; StatusLineStringID = 0; if (CurrentCursor) delete CurrentCursor; }

---

Member Function Documentation

void DragManagerOp::AbortDrag (  void   )  [static]

To forcibly abort the current drag. If there is no current drag, then nothing happens (so it can be called just to ensure that no drag is left current on exit for example). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 1248 of file dragmgr.cpp. { if (CurrentManager != NULL) { CurrentManager->LastMousePos = CurrentManager->CurrentMousePos; CurrentManager->CurrentMousePos = wxGetMousePosition(); if (TheCaptureHandler != NULL) TheCaptureHandler->CleanUpSolidDrag(); CurrentManager->ProcessEvent(DRAGEVENT_ABORT); // Let all drag targets know that the drag is well and truly dead CurrentManager->ProcessEvent(DRAGEVENT_DEINITIALISE); CurrentManager->End(); } SetDragActive(FALSE); }

void DragManagerOp::CleanUpAfterDrag (  void   )  [private]

Generic clean-up method. Deletes all registered DragTargets, and any other information (DragInformation, last keypress info, etc) which is still lying about in the DragManagerOp. Also deregisters our idle event handlers etc. Used by destructor, and also by all forms of Drag completion to free our memory claims, etc. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Scope: private Definition at line 1747 of file dragmgr.cpp. { TRACEUSER("Gerry", _T("DragManagerOp::CleanUpAfterDrag")); GetApplication()->RemoveIdleProcessor(IDLEPRIORITY_HIGH, this); if (TheCaptureHandler != NULL) { TRACEUSER("Gerry", _T("Deleting TheCaptureHandler")); // Simply delete the CaptureHandler and it will detach itself delete TheCaptureHandler; TheCaptureHandler = NULL; } if (CurrentDragInfo != NULL) { delete CurrentDragInfo; CurrentDragInfo = NULL; } if (CurrentKeypress != NULL) { delete CurrentKeypress; CurrentKeypress = NULL; } // Delete all entries from the list. We do it this way to ensure that we don't try // to destruct the same target multiple times if it registered multiple times while (!Targets.IsEmpty()) DeregisterTarget((DragTarget *) Targets.GetHead()); }

void DragManagerOp::DeregisterTarget (  DragTarget *  OldTarget  )  [protected]

To register a Drag Target with the current Drag Manager This method is automatically called by DragTargets when they are constructed, and is only available to frined classes. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Parameters: OldTarget  - points at the DragTarget object to remove [INPUTS] Notes: Copes with a drag target being registered several times. Scope: protected (for friend class DragTarget only) Definition at line 1708 of file dragmgr.cpp. { DragTarget *Ptr = (DragTarget *) Targets.GetHead(); DragTarget *Next; while (Ptr != NULL) { Next = (DragTarget *) Targets.GetNext(Ptr); if (Ptr == OldTarget) { Targets.RemoveItem(Ptr); delete Ptr; } Ptr = Next; } }

void DragManagerOp::EndDrag (  INT32  Flags  )  [static]

Input : Flags : mouse button state( 1=leftclick/-1= rightclick ). Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 1190 of file dragmgr.cpp. { if(!CurrentManager) return; // clean up if (TheCaptureHandler != NULL) { TheCaptureHandler->CleanUpSolidDrag(); } if(DragPending) // not a drag - user intended a click { // call the click handler in the drag wxPoint StartMouse; StartMouse.x = CurrentManager->InitialMousePos.x; StartMouse.y = CurrentManager->InitialMousePos.y; CurrentManager->CurrentDragInfo->OnClick(Flags,StartMouse); } else // this is a genuine end of drag { // Update the mouse position, so we give the event to the correct target CurrentManager->LastMousePos = CurrentManager->CurrentMousePos; CurrentManager->CurrentMousePos = wxGetMousePosition(); // Process the drag completion event DragEventType Event = DRAGEVENT_COMPLETED; CurrentManager->ProcessEvent(Event); // make sure we don't get any idles after the drag has finished DragEnded = TRUE; } // Let all drag targets know that the drag is well and truly dead if (CurrentManager) CurrentManager->ProcessEvent(DRAGEVENT_DEINITIALISE); SetDragActive(FALSE); // end this op if (CurrentManager) CurrentManager->End(); }

DragInformation * DragManagerOp::GetCurrentDragInfo (   )  [static]

return Current drag information Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 1064 of file dragmgr.cpp. { if( CurrentManager == NULL ) return NULL; return CurrentDragInfo; }

DragManagerOp * DragManagerOp::GetCurrentManager (  void   )  [static]

To find the current drag manager. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Returns: NULL (if no current drag), or a pointer to the current DragManagerOp Definition at line 1284 of file dragmgr.cpp. { return(CurrentManager); }

CaptureHandler * DragManagerOp::GetDragCaptureHandler (   )  [static]

return the capture handler Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 1045 of file dragmgr.cpp. { if( CurrentManager == NULL ) return NULL; return TheCaptureHandler; }

wxPoint DragManagerOp::GetDragMousePos (   )  [static]

return a CPoint for the Last Mouse Position Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Definition at line 1024 of file dragmgr.cpp. { wxPoint MPos(0,0); if( CurrentManager != NULL ) MPos = CurrentManager->CurrentMousePos; return MPos; }

BOOL DragManagerOp::GetStatusText (  String_256 *  StatusText  )  [static]

put status text in a buffer Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the buffer is valid FALSE otherwise Errors: - See also: - Definition at line 1870 of file dragmgr.cpp. { ERROR2IF(StatusText==NULL,FALSE,"DragManagerOp::GetStatusLineText() - StatusText==NULL!"); String_256 Text; if(CurrentDragTarget) { if(CurrentDragInfo->GetStatusLineText(&Text)) * StatusText = Text; else return FALSE; } else { if(CurrentDragTarget->GetStatusLineText(&Text)) * StatusText = Text; else return FALSE; } return TRUE; }

static BOOL DragManagerOp::IsDragActive (   )  [inline, static]

Definition at line 224 of file dragmgr.h. {return DragActive;}

BOOL DragManagerOp::OnIdleEvent (  void   )  [virtual]

To process idle events. If the mouse hasn't moved, then we'll allow low priority handlers a look-in. This means that (e.g.) when dragging background- redrawing galleries, we get instant response while dragging, and the background redraw will only occur while the mouse is held still. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> & Chris Date: 9/1/95 Returns: TRUE if it does not want low-priority idle handlers to be called this time FALSE if it's OK to call low-priority idles (i.e. if I'm not busy this turn) Reimplemented from Operation. Definition at line 1551 of file dragmgr.cpp. { LastMousePos = CurrentMousePos; CurrentMousePos = wxGetMousePosition(); if(DragEnded) return(FALSE); // Done nothing, so let low-priority handlers have a go BOOL JustStartedDrag = FALSE; // We have received a start drag message but we are not sure whether this is the real // thing yet. if (DragPending) { // We start a drag if DragDelay milliseconds have elapsed // or the pointer has left DragStartRect if (!DragStartTimer.Elapsed(DragDelay) && StillClickRect.Inside(CurrentMousePos)) { // The drag is still pending return(FALSE); // Done nothing, so let low-priority handlers have a go } DragPending = FALSE; JustStartedDrag = TRUE; // Flag that we have "just turned on" the drag TheCaptureHandler->SetUpSolidDrag(CurrentMousePos); } // Determine what event type to send around... DragEventType Event = DRAGEVENT_MOUSEIDLE; if (LastMousePos == CurrentMousePos) { if (LastEvent == DRAGEVENT_MOUSESTOPPED || LastEvent == DRAGEVENT_MOUSEIDLE) { // The mouse has not moved for a while, so send another idle Event = DRAGEVENT_MOUSEIDLE; } else { // The mouse has only just stopped moving, so send a mouse-stopped Event = DRAGEVENT_MOUSESTOPPED; } } else { // The mouse has moved since we last checked, so send a mouse-moved Event = DRAGEVENT_MOUSEMOVED; } // If the mouse moved, then we will not allow low-priority idle processors to have a go // this time around, for maximum mouse-move interactiveness. BOOL ClaimTheIdle = (Event == DRAGEVENT_MOUSEMOVED); // **** !!!! ToDo: This could be considered bodgy and nasty, mostly because it is. // ToDo: Somehow detect if the drag has ended? A bodge I know, but we wanna compile // this and see if it works! if (KeyPress::IsEscapePressed()) // If escape (or equivalent) pressed, abort the drag { AbortDrag(); return(FALSE); // Let low-priority handlers have a go } // **** ProcessEvent(Event); // Pass the event around all registered DragTargets #if FALSE /* On the first update, the mouse may not have moved, so we need to pop up the solid drag stuff. Unfortunately, this doesn't work quite right and I don't have time to deal with it right now. if (!DragEnded && JustStartedDrag) { // The mouse may not have moved, but we have just 'turned on' the drag - we'd // better ensure that the solid drag stuff is drawn onto screen for the fist time if (TheCaptureWindow != NULL) { CPoint PointInCaptureWnd(CurrentMousePos); // Convert the current mouse coordinate into capture window client coords, // and call it to update the solid drag TheCaptureWindow->ScreenToClient(&PointInCaptureWnd); TheCaptureWindow->DrawSolidDrag(PointInCaptureWnd); } } */ #endif return(ClaimTheIdle); // Return, allowing or not-allowing low-priority handlers to have a go // depending on whether the mouse moved or not. }

BOOL DragManagerOp::ProcessEvent (  DragEventType  Event  )  [private]

To process global drag events This method calls each DragTarget event processor in turn (until one claims the event), with the event. The 3 'Current' member variables are passed in to the event processor, so ensure they are set up appropriately before calling this method. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Parameters: Event  - Indicates what type of Drag Event is occurring [INPUTS] Returns: TRUE if a DragTarget claimed the event Notes: DragTargets can safely de-register themselves during processing of the events (i.e. the list traversal code won't get upset) When calling a kernel target which includes both a dialogue ID and a gadget, the coordinates passed into the event handler are millipoint offsets from the bottom left corner of the gadget, just as with normal kernel-rendered gadgets. Note that the event will not be passed to the gadget unless the mouse pointer is over the gadget window. If no gadget is specified, then the mouse coordinates will always be (0,0) at present. The INITIALISE and DEINITIALISE events are broadcast to all active targets, while all other events are broadcast only to general (no target window) targets, and the target (if any) over which the mouse pointer lies. See also: keyword DragEventType DragTarget::ProcessEvent Definition at line 1327 of file dragmgr.cpp. { BOOL BroadcastToAll = FALSE; // Determine if the event goes to everybody or // only to target under the pointer if (Event == DRAGEVENT_INITIALISE || Event == DRAGEVENT_DEINITIALISE) BroadcastToAll = TRUE; if(CurrentManager == NULL || (DragEnded && Event != DRAGEVENT_DEINITIALISE)) return FALSE; LastEvent = Event; // Remember the type of the last event we processed DragTarget *Ptr = (DragTarget *) Targets.GetHead(); DragTarget *Next; OilCoord KernelMousePos(0,0); wxPoint WinoilMousePos(CurrentMousePos); CurrentDragTarget = NULL; BOOL OverTarget = FALSE; // TRACEUSER("Gerry", _T("ProcessEvent = (%d, %d)"), WinoilMousePos.x, WinoilMousePos.y); while (Ptr != NULL) { // Copy the mouse position, as each iteration of the loop corrupts it WinoilMousePos = CurrentMousePos; // Allow things like targets de-registering during processing Next = (DragTarget *) Targets.GetNext(Ptr); BOOL GoAhead = TRUE; if (Ptr->IsAKernelObject()) { KernelMousePos = OilCoord(0,0); DialogOp *pDialogOp; CGadgetID GadgetID; Ptr->GetTargetAreaInfo(&pDialogOp, &GadgetID); if (pDialogOp != NULL) { wxWindow* TargetWindow = (wxWindow*)pDialogOp->WindowID; // use whole window if no gadget specified if (GadgetID != 0) TargetWindow = TargetWindow->FindWindow((INT32)GadgetID); // We want to do the following. But it doesn't work because GetRect() is relative to the // parent window when TargetWindow is not a TLW. What we need is (consistently) screen // coordinates // TRACEUSER("Gerry", _T("KernelTargetWindow = %s"), TargetWindow->GetClassInfo()->GetClassName()); wxRect TargetRect = TargetWindow->GetRect(); // TRACEUSER("Gerry", _T("TargetRect = (%d, %d) [%d, %d]"), TargetRect.x, TargetRect.y, TargetRect.width, TargetRect.height); if (TargetWindow->GetParent() && !TargetWindow->IsTopLevel()) { TargetWindow->GetParent()->ClientToScreen(&TargetRect.x, &TargetRect.y); // TRACEUSER("Gerry", _T("TargetRect = (%d, %d) [%d, %d]"), TargetRect.x, TargetRect.y, TargetRect.width, TargetRect.height); } // TRACEUSER("Gerry", _T("Point is %sinside"), TargetRect.Inside(WinoilMousePos) ? _T("") : _T("not ")); if (BroadcastToAll || Ptr->WantsAllEvents() || TargetRect.Inside(WinoilMousePos)) { // Determine if the pointer is over the target window, or any of its children wxWindow* WindowUnderPoint = wxChildWindowFromPoint(WinoilMousePos, false, -1); BOOL AreOverTargetWnd = (WindowUnderPoint == TargetWindow); if (!AreOverTargetWnd) { // We're not immediately over the background of the window, but may be over // a child-window of our window! The subtlety here is that wxChildWindowFromPoint may have // failed because another window is on top (in the way). So we also check the child window // of the target window which is under the mousepointer is also the window which is // under the mouse pointner wxWindow* ChildWindowUnderPoint = ::wxChildWindowFromPoint(TargetWindow, WinoilMousePos, false, -1); AreOverTargetWnd = (ChildWindowUnderPoint != NULL && ChildWindowUnderPoint == WindowUnderPoint); } if (BroadcastToAll || Ptr->WantsAllEvents() || AreOverTargetWnd) { wxScreenDC dc; wxSize ppi = OSRenderRegion::GetFixedDCPPI(dc); KernelMousePos.x = ((WinoilMousePos.x - TargetRect.GetLeft()) * 72000) / ppi.GetWidth(); // CHECKRECT: This may need to be the exclusive bottom coord KernelMousePos.y = ((TargetRect.GetBottom() - WinoilMousePos.y) * 72000) / ppi.GetHeight(); } else GoAhead = FALSE; } else GoAhead = FALSE; } // TRACEUSER("Gerry", _T("%s"), GoAhead ? _T("Process") : _T("Skipping")); if (GoAhead && Ptr->ProcessEvent(Event, CurrentDragInfo, &KernelMousePos, CurrentKeypress)) { CurrentDragTarget = Ptr; OverTarget = TRUE; // This Target claimed the event, so return TRUE if (!BroadcastToAll) break; } } else { wxWindow* TargetWindow; wxRect TargetRect; Ptr->GetTargetAreaInfo(&TargetWindow, &TargetRect); #if FALSE if (TargetWindow) { TRACEUSER("Gerry", _T("OilTargetWindow = %s"), TargetWindow->GetClassInfo()->GetClassName()); TRACEUSER("Gerry", _T("TargetRect = (%d, %d) [%d, %d]"), TargetRect.x, TargetRect.y, TargetRect.width, TargetRect.height); } else { TRACEUSER("Gerry", _T("OilTargetWindow = <NONE>")); } #endif wxPoint ClientPoint; // This will be screen coords, or will end up as ClientPoint.x = WinoilMousePos.x; // client coords if we have a window... ClientPoint.y = WinoilMousePos.y; if (TargetWindow != NULL) { // Get the mouse position in client coords ClientPoint = TargetWindow->ScreenToClient(ClientPoint); // Don't bother giving the event to targets which don't contain the pointer if (BroadcastToAll || Ptr->WantsAllEvents() || TargetRect.Inside(ClientPoint)) { // Don't give the event to oil targets unless the pointer is over the // window (ie dont pass on events to overlapped windows) unless we want // to broadcast to all, or this target really wants to know! wxWindow* WindowUnderPoint = ::wxChildWindowFromPoint(WinoilMousePos, false, -1); // TRACEUSER("Gerry", _T("WindowUnderPoint = 0x%08x (%s)"), WindowUnderPoint, WindowUnderPoint ? WindowUnderPoint->GetClassInfo()->GetClassName() : _T("null")); if (WindowUnderPoint) { // TRACEUSER("Gerry", _T("Title = %s"), WindowUnderPoint->GetTitle().c_str()); } BOOL AreOverTargetWnd = (WindowUnderPoint == TargetWindow); // TRACEUSER("Gerry", _T("Point is %sover target window"), AreOverTargetWnd ? _T("") : _T("not ")); if (!AreOverTargetWnd) { // We're not immediately over the background of the window, but may be over // a child-window of our window! The subtlety here is that wxChildWindowFromPoint may have // failed because another window is on top (in the way). So we also check the child window // of the target window which is under the mousepointer is also the window which is // under the mouse pointner wxWindow* ChildWindowUnderPoint = ::wxChildWindowFromPoint(TargetWindow, WinoilMousePos, false, -1); // TRACEUSER("Gerry", _T("ChildFromPoint = 0x%08x (%s)"), ChildWindowUnderPoint, ChildWindowUnderPoint ? ChildWindowUnderPoint->GetClassInfo()->GetClassName() : _T("null")); AreOverTargetWnd = (ChildWindowUnderPoint != NULL && ChildWindowUnderPoint == WindowUnderPoint); // TRACEUSER("Gerry", _T("Point is %sover child of target window"), AreOverTargetWnd ? _T("") : _T("not ")); } if (!BroadcastToAll && !Ptr->WantsAllEvents() && !AreOverTargetWnd) { GoAhead = FALSE; } } else GoAhead = FALSE; } // TRACEUSER("Gerry", _T("%s"), GoAhead ? _T("Process") : _T("Skipping")); // we are in a target area, or this is a broadcast-to-all, so send the event if (GoAhead) { wxPoint PointInWindow(ClientPoint); // "Cast" to wxPoint if (Ptr->ProcessEvent(Event, CurrentDragInfo, &PointInWindow, CurrentKeypress)) { CurrentDragTarget = Ptr; OverTarget = TRUE; // This Target claimed the event, so return TRUE if (!BroadcastToAll) break; } } } Ptr = Next; } if (!DragPending && Event != DRAGEVENT_COMPLETED) { SetStatusLineText(); SetCursor(); } return OverTarget; // Return status to indicate wheteher or not the event was claimed }

void DragManagerOp::RedrawFinished (  void   )  [static]

Tell the drag manager that an external redraw has finished. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/95 Returns: - Definition at line 2028 of file dragmgr.cpp. { if (!RedrawInProgress) return; RedrawInProgress = FALSE; if (DragManagerOp::CurrentManager && DragManagerOp::CurrentManager->CurrentDragInfo && DragManagerOp::CurrentManager->CurrentDragInfo->DoesSolidDrag) { wxPoint LastMousePos = DragManagerOp::CurrentManager->GetDragMousePos(); DragManagerOp::CurrentManager->TheCaptureHandler->SetUpSolidDrag(LastMousePos); } }

void DragManagerOp::RedrawStarting (  CWindowID  TheWindow, CGadgetID  TheGadget, DocRect *  TheArea = NULL )  [static]

Tell the drag manager that an external redraw has started, within a specific window and gadget. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 8/5/95 Parameters: TheWindow  - The CWindowID of your DialogOp [INPUTS] TheGadget - The Gadget ID of the gadget being redrawn TheArea - A kernel-rendered dialogue rectangle (MILLIPOINTS) which is being redrawn. If NULL, the entire gadget is assumed. NOTE that this is clipped within the gadget bounds, so may be outside the 'visible area' of the gadget Returns: - This allows it to remove its solid drag stuff so that the screen display is not screwed up. You should also call RedrawFinished when you finish redrawing This call specifies a particular gadget that is redrawing - if this doesn't overlap the solid drag area, then nothing will be done - this will reduce flicker if you're background redrawing while a drag is going on. See also: DragManagerOp::RedrawFinished() Definition at line 1961 of file dragmgr.cpp. { if (RedrawInProgress) return; if (DragManagerOp::CurrentManager && DragManagerOp::CurrentManager->CurrentDragInfo && DragManagerOp::CurrentManager->CurrentDragInfo->DoesSolidDrag) { wxWindow* pWindow = (wxWindow*)TheWindow; wxWindow* pGadget = pWindow->FindWindow((INT32)TheGadget); if (pGadget != NULL) { wxRect AreaClientRect; wxRect ClientRect; if (TheArea != NULL) { ReDrawInfoType DlgInfo; DialogManager::GetKernelRenderedGadgetInfo(TheWindow, TheGadget, &DlgInfo); INT32 PixelSize = 72000 / DlgInfo.Dpi; // Size of a pixel in MILLIPOINTS AreaClientRect.x = TheArea->lo.x / PixelSize; AreaClientRect.y = TheArea->hi.x / PixelSize; AreaClientRect.width = TheArea->Width() / PixelSize; AreaClientRect.height = TheArea->Height() / PixelSize; } else AreaClientRect = pGadget->GetClientRect(); ClientRect = pGadget->GetClientRect(); wxRect ScreenRect(ClientRect); // Get the intersection of the rects (clip the redrawing area within the window) if (!ScreenRect.Intersect(AreaClientRect).IsEmpty()) { // Convert the client coordinates to screen coords, and tell the drag capture window // to get it's solid drag stuff out of the way pGadget->ClientToScreen(&ScreenRect.x, &ScreenRect.y); RedrawInProgress = DragManagerOp::CurrentManager->TheCaptureHandler-> CleanUpSolidDragInScreenArea(ScreenRect); } else RedrawInProgress = FALSE; } else { // We failed to get the window area, so we'll have to clean up just in case DragManagerOp::CurrentManager->TheCaptureHandler->CleanUpSolidDrag(); RedrawInProgress = TRUE; } } }

void DragManagerOp::RedrawStarting (  void   )  [static]

Tell the drag manager that an external redraw has started. This allows it to remove its solid drag stuff so that the screen display is not screwed up. You should also call RedrawFinished when you finish redrawing. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/95 Returns: - Notes: If you are redrawing in a particular window & gadget, see the other variant of this method, which will reduce solid-drag flicker. See also: DragManagerOp::RedrawFinished() Definition at line 1914 of file dragmgr.cpp. { if (RedrawInProgress) return; RedrawInProgress = TRUE; if (DragManagerOp::CurrentManager && DragManagerOp::CurrentManager->CurrentDragInfo && DragManagerOp::CurrentManager->CurrentDragInfo->DoesSolidDrag) { DragManagerOp::CurrentManager->TheCaptureHandler->CleanUpSolidDrag(); } }

void DragManagerOp::RegisterTarget (  DragTarget *  NewTarget, BOOL  HighPriority = FALSE )  [protected]

To register a Drag Target with the current Drag Manager This method is automatically called by DragTargets when they are constructed, and is only available to frined classes. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Parameters: NewTarget  - points at the DragTarget object to add. NOTE that from this [INPUTS] time on, the manager owns the target, and it will delete it when the drag completes. However, the caller may delete the target at any time, in which case it will automatically deregister itself before it dies. HighPriority - TRUE to place the target on the front of the target list, FALSE to place it on the end. (Targets are called in list order to handle events, so one on the front of the list has higher priority...) Notes: A drag target object can be registered several times, in which case it will be placed on the list several times. Not that this should happen... Scope: protected (for friend class DragTarget only) Definition at line 1676 of file dragmgr.cpp. { ERROR3IF(NewTarget == NULL, "DragManagerOp::RegisterTarget - NULL Target parameter is illegal"); if (HighPriority) Targets.AddHead(NewTarget); else Targets.AddTail(NewTarget); }

void DragManagerOp::SetCursor (   )  [static, protected]

Set the cursor ! Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/1/95 Returns: - Definition at line 1792 of file dragmgr.cpp. { UINT32 CursorID; // are we over a target ?? if(CurrentDragTarget== NULL) CursorID = CurrentDragInfo->GetCursorID(); // nope else CursorID = CurrentDragTarget->GetCursorID(); // yep // the target does not want to change the cursor if(CursorID == 0) return; if(CurrentManager->CurrentID != CursorID) // nothing to change { if(CurrentManager->CurrentCursor) // delete the old { delete CurrentManager->CurrentCursor; CurrentManager->CurrentCursor = NULL; } if(CurrentManager->CurrentCursor==NULL) { CurrentManager->CurrentCursor = new Cursor(CursorID); // create the new if (CurrentManager->CurrentCursor) CurrentManager->CurrentCursor->SetActive(); // make the active cursor } CurrentManager->CurrentID = CursorID; } }

static void DragManagerOp::SetDragActive (  BOOL  State  )  [inline, static]

Definition at line 226 of file dragmgr.h. {DragActive = State;}

void DragManagerOp::SetStatusLineText (   )  [static, protected]

Write Status line help. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/1/95 Returns: - Definition at line 1836 of file dragmgr.cpp. { String_256 StatusText; if(CurrentDragTarget==NULL) //we are not over a target { // get the drag status text if(CurrentDragInfo) if(CurrentDragInfo->GetStatusLineText(&StatusText)) GetApplication()->UpdateStatusBarText(&StatusText,FALSE); } else { // get the target status text if(CurrentDragTarget->GetStatusLineText(&StatusText)) GetApplication()->UpdateStatusBarText(&StatusText,FALSE); } }

void DragManagerOp::StartDrag (  DragInformation *  Descriptor, CWindowID  DragWindow )  [static]

Starts a global-drag off This will create a new DragManagerOp object, set up the drag, and broadcast a DragMsg DRAGSTARTED, as a result of which, DragTargets should be created by interested parties (these will register with the Drag Manager, and then be called to handle events during the drag). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/95 Parameters: Descriptor  - A DragInformation object describing the current drag. [INPUTS] NOTE WELL that this is given to the DragManager, who is then responsible for deleting it when the drag completes. DO NOT DELETE IT! DragWindow - The window that is starting the drag. NOTE: For correct operation under wxGTK this must be the window that received the button down event that started this drag Definition at line 1097 of file dragmgr.cpp. { if (Descriptor == NULL) { // Handle a NULL pointer by just not starting up the drag TRACE( _T("NULL Descriptor given to DragManagerOp::StartDrag()\n")); return; } ERROR3IF(Descriptor == NULL, "DragManagerOp must be given a valid DragInformation ptr"); DragManagerOp* pNewManager = new DragManagerOp(Descriptor); if (Descriptor->IsAdjustDrag) // Adjust drags just immediately become clicks { DragPending = TRUE; // Make sure it turns into a click properly (see EndDrag) if (pNewManager != NULL) { pNewManager->CurrentMousePos = wxGetMousePosition(); pNewManager->InitialMousePos = pNewManager->LastMousePos = pNewManager->CurrentMousePos; EndDrag(-1); } return; } if (pNewManager != NULL) { // Attach the CaptureHandler to the correct window wxWindow* pWindow = (wxWindow*)DragWindow; if (pWindow == NULL) pWindow = GetMainFrame(); TheCaptureHandler = new CaptureHandler(pWindow); if (TheCaptureHandler != NULL) { DragPending = TRUE; // Remember where the mouse is at the start of the drag pNewManager->CurrentMousePos = wxGetMousePosition(); pNewManager->InitialMousePos = pNewManager->LastMousePos = pNewManager->CurrentMousePos; // Request that all interested parties attach DragTargets now BROADCAST_TO_ALL(DragMessage(DragMessage::DRAGSTARTED, pNewManager, Descriptor)); // views don't receive messages so we'll have to do this the hard way.. // App->Document->View... GetApplication()->CreateDragTargets(Descriptor); // Send an Initialise event to all registered targets // Forget this - drags with no targets are perfectly legal - see colour picker #if 0 #ifdef _DEBUG if (pNewManager->Targets.IsEmpty()) TRACE( _T("DragManagerOp::StartDrag - No drag targets specified for this drag!")); #endif #endif pNewManager->ProcessEvent(DRAGEVENT_INITIALISE); // Start the mouse capture TheCaptureHandler->StartCapture(); // Register for idle events GetApplication()->RegisterIdleProcessor(IDLEPRIORITY_HIGH, pNewManager); // get drag start time DragStartTimer.Sample(); // we will use this rect to test whether we have started a drag StillClickRect = wxRect( pNewManager->InitialMousePos.x - DragMinDist, pNewManager->InitialMousePos.y - DragMinDist, DragMinDist * 2, DragMinDist * 2); SetDragActive(TRUE); } } GetMainFrame()->SetFocus(); }

---

Friends And Related Function Documentation

friend class CaptureHandler [friend]

Definition at line 191 of file dragmgr.h.

friend class DragInformation [friend]

Definition at line 192 of file dragmgr.h.

friend class DragTarget [friend]

Definition at line 188 of file dragmgr.h.

friend class KernelDragTarget [friend]

Definition at line 189 of file dragmgr.h.

friend class OilDragTarget [friend]

Definition at line 190 of file dragmgr.h.

---

Member Data Documentation

Cursor* DragManagerOp::CurrentCursor [private]

Definition at line 270 of file dragmgr.h.

DragInformation * DragManagerOp::CurrentDragInfo = NULL [static, private]

Definition at line 263 of file dragmgr.h.

DragTarget * DragManagerOp::CurrentDragTarget = NULL [static, private]

Definition at line 265 of file dragmgr.h.

UINT32 DragManagerOp::CurrentID [private]

Definition at line 269 of file dragmgr.h.

KeyPress* DragManagerOp::CurrentKeypress [private]

Definition at line 274 of file dragmgr.h.

DragManagerOp * DragManagerOp::CurrentManager = NULL [static, private]

Definition at line 261 of file dragmgr.h.

wxPoint DragManagerOp::CurrentMousePos [private]

Definition at line 277 of file dragmgr.h.

BOOL DragManagerOp::DragActive = FALSE [static, private]

Definition at line 299 of file dragmgr.h.

UINT32 DragManagerOp::DragDelay = DEFAULT_DRAGDELAY [static, private]

Definition at line 292 of file dragmgr.h.

BOOL DragManagerOp::DragEnded = FALSE [static, private]

Definition at line 286 of file dragmgr.h.

UINT32 DragManagerOp::DragMinDist = DEFAULT_DRAGDIST [static, private]

Definition at line 290 of file dragmgr.h.

BOOL DragManagerOp::DragPending = FALSE [static, private]

Definition at line 284 of file dragmgr.h.

wxRect DragManagerOp::DragStartRect [static, private]

Definition at line 294 of file dragmgr.h.

MonotonicTime DragManagerOp::DragStartTimer [static, private]

Definition at line 288 of file dragmgr.h.

wxPoint DragManagerOp::InitialMousePos [private]

Definition at line 276 of file dragmgr.h.

DragEventType DragManagerOp::LastEvent [private]

Definition at line 280 of file dragmgr.h.

wxPoint DragManagerOp::LastMousePos [private]

Definition at line 278 of file dragmgr.h.

BOOL DragManagerOp::RedrawInProgress = FALSE [static, private]

Definition at line 301 of file dragmgr.h.

UINT32 DragManagerOp::StatusLineStringID = 0 [static, private]

Definition at line 267 of file dragmgr.h.

wxRect DragManagerOp::StillClickRect [static, private]

Definition at line 296 of file dragmgr.h.

List DragManagerOp::Targets [private]

Definition at line 272 of file dragmgr.h.

CaptureHandler * DragManagerOp::TheCaptureHandler = NULL [static, private]

Definition at line 282 of file dragmgr.h.

---

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

• wxOil/dragmgr.h (r1785/r1282)
• wxOil/dragmgr.cpp (r1785/r1671)

---