Back to index

lightning-sunbird  0.9+nobinonly
nsDragHelperService.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsDragHelperService_h__
00039 #define nsDragHelperService_h__
00040 
00041 #include "nsCOMPtr.h"
00042 #include "nsIDragService.h"
00043 
00044 #include <Carbon/Carbon.h>
00045 
00046 #include "nsIDragHelperService.h"
00047 
00048 
00049 //
00050 // nsDragHelperService
00051 //
00052 // Implementation of nsIDragHelperService, a helper for managing
00053 // drag and drop mechanics.
00054 //
00055 
00056 // {75993200-f3b2-11d5-a384-c7054d07d6fc}
00057 #define NS_DRAGHELPERSERVICE_CID      \
00058 { 0x75993200, 0xf3b2, 0x11d5, { 0xa3, 0x84, 0xc7, 0x05, 0x4d, 0x07, 0xd6, 0xfc } }
00059 
00060 
00061 class nsDragHelperService : public nsIDragHelperService
00062 {
00063 public:
00064   nsDragHelperService();
00065   virtual ~nsDragHelperService();
00066 
00067   NS_DECL_ISUPPORTS
00068   NS_DECL_NSIDRAGHELPERSERVICE
00069 
00070 protected:
00071 
00072     // Send a drag event into Gecko
00073   PRBool DoDragAction(PRUint32      aMessage,
00074                       DragReference aDragRef,
00075                       nsIEventSink* aSink);
00076 
00077     // handles modifier keys (cmd, option, etc) and sets the appropriate 
00078     // action (move, copy, etc) based on the given modifiers.
00079   void SetDragActionBasedOnModifiers ( short inModifiers ) ;
00080 
00081     // Arranges to send NS_DRAGDROP_OVER events at regular intervals
00082   void SetDragOverTimer(nsIEventSink* aSink, DragRef aDragRef);
00083   static void DragOverTimerHandler(EventLoopTimerRef aTimer, void* aUserData);
00084   
00085     // holds our drag service across multiple calls to this callback. The reference to
00086     // the service is obtained when the mouse enters the window and is released when
00087     // the mouse leaves the window (or there is a drop). This prevents us from having
00088     // to re-establish the connection to the service manager 15 times a second when
00089     // handling the |kDragTrackingInWindow| message.
00090   nsCOMPtr<nsIDragService> mDragService;
00091 
00092     // Used to implement the NS_DRAGDROP_OVER timer
00093   EventLoopTimerRef      mDragOverTimer;
00094   nsCOMPtr<nsIEventSink> mDragOverSink;
00095   DragRef                mDragOverDragRef;
00096 }; // nsDragHelperService
00097 
00098 
00099 #endif // nsDragHelperService_h__