Mozilla/mozilla/widget/src/mac/nsDragHelperService.cpp
pinkerton%netscape.com f517505c3f separate out drag code into a helper so embedding apps can make use of it. bug 102529. r=ccarlen/sr=sfraser.
git-svn-id: svn://10.0.0.236/trunk@111246 18797224-902f-48f8-a5cc-f745e15eee43
2002-01-02 21:16:37 +00:00

268 lines
8.9 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the NPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsDragHelperService.h"
#include "nsGUIEvent.h"
#include "nsIDragSessionMac.h"
#include "nsIServiceManager.h"
#define kDragServiceContractID "@mozilla.org/widget/dragservice;1"
NS_IMPL_ADDREF(nsDragHelperService)
NS_IMPL_RELEASE(nsDragHelperService)
NS_IMPL_QUERY_INTERFACE1(nsDragHelperService, nsIDragHelperService);
//
// nsDragHelperService constructor
//
nsDragHelperService::nsDragHelperService()
{
NS_INIT_ISUPPORTS();
}
//
// nsDragHelperService destructor
//
nsDragHelperService::~nsDragHelperService()
{
NS_ASSERTION ( !mDragService.get(), "A drag was not correctly ended by shutdown" );
}
//
// Enter
//
// Called when the mouse has entered the rectangle bounding the browser
// during a drag. Cache the drag service so we don't have to fetch it
// repeatedly, and handles setting up the drag reference and sending an
// enter event.
//
NS_IMETHODIMP
nsDragHelperService::Enter ( DragReference inDragRef, nsIEventSink *inSink )
{
// get our drag service for the duration of the drag.
mDragService = do_GetService(kDragServiceContractID);
NS_ASSERTION ( mDragService, "Couldn't get a drag service, we're in biiig trouble" );
if ( !mDragService )
return NS_ERROR_FAILURE;
// tell the session about this drag
mDragService->StartDragSession();
nsCOMPtr<nsIDragSessionMac> macSession ( do_QueryInterface(mDragService) );
if ( macSession )
macSession->SetDragReference ( inDragRef );
// let gecko know that the mouse has entered the window so it
// can start tracking and sending enter/exit events to frames.
Point mouseLocGlobal;
::GetDragMouse ( inDragRef, &mouseLocGlobal, nsnull );
PRBool handled = PR_FALSE;
inSink->DragEvent ( NS_DRAGDROP_ENTER, mouseLocGlobal.h, mouseLocGlobal.v, 0L, &handled );
return NS_OK;
}
//
// Tracking
//
// Called while the mouse is inside the rectangle bounding the browser
// during a drag. The important thing done here is to clear the |canDrop|
// property of the drag session every time through. The event handlers
// will reset it if appropriate.
//
NS_IMETHODIMP
nsDragHelperService::Tracking ( DragReference inDragRef, nsIEventSink *inSink, PRBool* outDropAllowed )
{
NS_ASSERTION ( mDragService, "Couldn't get a drag service, we're in biiig trouble" );
if ( !mDragService ) {
*outDropAllowed = PR_FALSE;
return NS_ERROR_FAILURE;
}
Point mouseLocGlobal;
::GetDragMouse ( inDragRef, &mouseLocGlobal, nsnull );
short modifiers;
::GetDragModifiers ( inDragRef, &modifiers, nsnull, nsnull );
// set the drag action on the service so the frames know what is going on
SetDragActionBasedOnModifiers ( modifiers );
// clear out the |canDrop| property of the drag session. If it's meant to
// be, it will be set again.
nsCOMPtr<nsIDragSession> session;
mDragService->GetCurrentSession(getter_AddRefs(session));
NS_ASSERTION ( session, "If we don't have a drag session, we're fucked" );
if ( session )
session->SetCanDrop(PR_FALSE);
// pass into gecko for handling...
PRBool handled = PR_FALSE;
inSink->DragEvent ( NS_DRAGDROP_OVER, mouseLocGlobal.h, mouseLocGlobal.v, modifiers, &handled );
// check if gecko has since allowed the drop and return it
if ( session )
session->GetCanDrop(outDropAllowed);
return NS_OK;
}
//
// Leave
//
// Called when the mouse leaves the rectangle bounding the browser
// during a drag. Cleans up the drag service and releases it.
//
NS_IMETHODIMP
nsDragHelperService::Leave ( DragReference inDragRef, nsIEventSink *inSink )
{
NS_ASSERTION ( mDragService, "Couldn't get a drag service, we're in biiig trouble" );
if ( !mDragService )
return NS_ERROR_FAILURE;
// tell the drag service that we're done with it.
mDragService->EndDragSession();
// clear out the dragRef in the drag session. We are guaranteed that
// this will be called _after_ the drop has been processed (if there
// is one), so we're not destroying valuable information if the drop
// was in our window.
nsCOMPtr<nsIDragSessionMac> macSession ( do_QueryInterface(mDragService) );
if ( macSession )
macSession->SetDragReference ( 0 );
// let gecko know that the mouse has left the window so it
// can stop tracking and sending enter/exit events to frames.
Point mouseLocGlobal;
::GetDragMouse ( inDragRef, &mouseLocGlobal, nsnull );
PRBool handled = PR_FALSE;
inSink->DragEvent ( NS_DRAGDROP_EXIT, mouseLocGlobal.h, mouseLocGlobal.v, 0L, &handled );
::HideDragHilite ( inDragRef );
// we're _really_ done with it, so let go of the service.
mDragService = nsnull;
return NS_OK;
}
//
// Drop
//
// Called when a drop occurs within the rectangle bounding the browser
// during a drag. Cleans up the drag service and releases it.
//
NS_IMETHODIMP
nsDragHelperService::Drop ( DragReference inDragRef, nsIEventSink *inSink, PRBool* outAccepted )
{
NS_ASSERTION ( mDragService, "Couldn't get a drag service, we're in biiig trouble" );
if ( !mDragService ) {
*outAccepted = PR_FALSE;
return NS_ERROR_FAILURE;
}
// We make the assuption that the dragOver handlers have correctly set
// the |canDrop| property of the Drag Session. Before we dispatch the event
// into Gecko, check that value and either dispatch it or set the result
// code to "spring-back" and show the user the drag failed.
OSErr result = noErr;
nsCOMPtr<nsIDragSession> dragSession;
mDragService->GetCurrentSession ( getter_AddRefs(dragSession) );
if ( dragSession ) {
// if the target has set that it can accept the drag, pass along
// to gecko, otherwise set phasers for failure.
PRBool canDrop = PR_FALSE;
if ( NS_SUCCEEDED(dragSession->GetCanDrop(&canDrop)) )
if ( canDrop ) {
// pass the drop event along to Gecko
Point mouseLocGlobal;
::GetDragMouse ( inDragRef, &mouseLocGlobal, nsnull );
short modifiers;
::GetDragModifiers ( inDragRef, &modifiers, nsnull, nsnull );
PRBool handled = PR_FALSE;
inSink->DragEvent ( NS_DRAGDROP_DROP, mouseLocGlobal.h, mouseLocGlobal.v, modifiers, &handled );
}
else
result = dragNotAcceptedErr;
} // if a valid drag session
// we don't need the drag session anymore, the user has released the
// mouse and the event has already gone to gecko.
mDragService->EndDragSession();
// if there was any kind of error, the drag wasn't accepted
*outAccepted = (result == noErr);
return NS_OK;
}
//
// SetDragActionsBasedOnModifiers
//
// Examines the MacOS modifier keys and sets the appropriate drag action on the
// drag session to copy/move/etc
//
void
nsDragHelperService::SetDragActionBasedOnModifiers ( short inModifiers )
{
nsCOMPtr<nsIDragSession> dragSession;
mDragService->GetCurrentSession ( getter_AddRefs(dragSession) );
if ( dragSession ) {
PRUint32 action = nsIDragService::DRAGDROP_ACTION_MOVE;
// force copy = option, alias = cmd-option, default is move
if ( inModifiers & optionKey ) {
if ( inModifiers & cmdKey )
action = nsIDragService::DRAGDROP_ACTION_LINK;
else
action = nsIDragService::DRAGDROP_ACTION_COPY;
}
dragSession->SetDragAction ( action );
}
} // SetDragActionBasedOnModifiers