summaryrefslogtreecommitdiffstats
path: root/app/win/drop_target.h
diff options
context:
space:
mode:
authorbrettw@chromium.org <brettw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2010-10-17 20:44:38 +0000
committerbrettw@chromium.org <brettw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2010-10-17 20:44:38 +0000
commit79a4c1e532a74ac74d72f883e52e30019fe9e731 (patch)
tree2fc9915dc6e1fe9c4b9bea3bdda5ef211da49980 /app/win/drop_target.h
parent13147160ae28933269024ba973f0a1ae3d11a57d (diff)
downloadchromium_src-79a4c1e532a74ac74d72f883e52e30019fe9e731.zip
chromium_src-79a4c1e532a74ac74d72f883e52e30019fe9e731.tar.gz
chromium_src-79a4c1e532a74ac74d72f883e52e30019fe9e731.tar.bz2
Move BaseDropTarget and BaseDragSource from base to app/win. Remove the "Base" class name prefix and put in the app::win namespace.
TEST=none BUG=none Review URL: http://codereview.chromium.org/3822007 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@62900 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'app/win/drop_target.h')
-rw-r--r--app/win/drop_target.h136
1 files changed, 136 insertions, 0 deletions
diff --git a/app/win/drop_target.h b/app/win/drop_target.h
new file mode 100644
index 0000000..e7dc1ec
--- /dev/null
+++ b/app/win/drop_target.h
@@ -0,0 +1,136 @@
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef APP_WIN_DROP_TARGET_H_
+#define APP_WIN_DROP_TARGET_H_
+#pragma once
+
+#include <objidl.h>
+
+#include "base/ref_counted.h"
+
+// Windows interface.
+struct IDropTargetHelper;
+
+namespace app {
+namespace win {
+
+// A DropTarget implementation that takes care of the nitty gritty
+// of dnd. While this class is concrete, subclasses will most likely
+// want to override various OnXXX methods.
+//
+// Because DropTarget is ref counted you shouldn't delete it directly,
+// rather wrap it in a scoped_refptr. Be sure and invoke RevokeDragDrop(m_hWnd)
+// before the HWND is deleted too.
+//
+// This class is meant to be used in a STA and is not multithread-safe.
+class DropTarget : public IDropTarget {
+ public:
+ // Create a new DropTarget associating it with the given HWND.
+ explicit DropTarget(HWND hwnd);
+ virtual ~DropTarget();
+
+ // When suspended is set to |true|, the drop target does not receive drops
+ // from drags initiated within the owning HWND.
+ bool suspended() const { return suspended_; }
+ void set_suspended(bool suspended) { suspended_ = suspended; }
+
+ // IDropTarget implementation:
+ HRESULT __stdcall DragEnter(IDataObject* data_object,
+ DWORD key_state,
+ POINTL cursor_position,
+ DWORD* effect);
+ HRESULT __stdcall DragOver(DWORD key_state,
+ POINTL cursor_position,
+ DWORD* effect);
+ HRESULT __stdcall DragLeave();
+ HRESULT __stdcall Drop(IDataObject* data_object,
+ DWORD key_state,
+ POINTL cursor_position,
+ DWORD* effect);
+
+ // IUnknown implementation:
+ HRESULT __stdcall QueryInterface(const IID& iid, void** object);
+ ULONG __stdcall AddRef();
+ ULONG __stdcall Release();
+
+ protected:
+ // Returns the hosting HWND.
+ HWND GetHWND() { return hwnd_; }
+
+ // Invoked when the cursor first moves over the hwnd during a dnd session.
+ // This should return a bitmask of the supported drop operations:
+ // DROPEFFECT_NONE, DROPEFFECT_COPY, DROPEFFECT_LINK and/or
+ // DROPEFFECT_MOVE.
+ virtual DWORD OnDragEnter(IDataObject* data_object,
+ DWORD key_state,
+ POINT cursor_position,
+ DWORD effect);
+
+ // Invoked when the cursor moves over the window during a dnd session.
+ // This should return a bitmask of the supported drop operations:
+ // DROPEFFECT_NONE, DROPEFFECT_COPY, DROPEFFECT_LINK and/or
+ // DROPEFFECT_MOVE.
+ virtual DWORD OnDragOver(IDataObject* data_object,
+ DWORD key_state,
+ POINT cursor_position,
+ DWORD effect);
+
+ // Invoked when the cursor moves outside the bounds of the hwnd during a
+ // dnd session.
+ virtual void OnDragLeave(IDataObject* data_object);
+
+ // Invoked when the drop ends on the window. This should return the operation
+ // that was taken.
+ virtual DWORD OnDrop(IDataObject* data_object,
+ DWORD key_state,
+ POINT cursor_position,
+ DWORD effect);
+
+ // Return the drag identity.
+ static int32 GetDragIdentity() { return drag_identity_; }
+
+ private:
+ // Returns the cached drop helper, creating one if necessary. The returned
+ // object is not addrefed. May return NULL if the object couldn't be created.
+ static IDropTargetHelper* DropHelper();
+
+ // The data object currently being dragged over this drop target.
+ scoped_refptr<IDataObject> current_data_object_;
+
+ // A helper object that is used to provide drag image support while the mouse
+ // is dragging over the content area.
+ //
+ // DO NOT ACCESS DIRECTLY! Use DropHelper() instead, which will lazily create
+ // this if it doesn't exist yet. This object can take tens of milliseconds to
+ // create, and we don't want to block any window opening for this, especially
+ // since often, DnD will never be used. Instead, we force this penalty to the
+ // first time it is actually used.
+ static IDropTargetHelper* cached_drop_target_helper_;
+
+ // The drag identity (id). An up-counter that increases when the cursor first
+ // moves over the HWND in a DnD session (OnDragEnter). 0 is reserved to mean
+ // the "no/unknown" identity, and is used for initialization. The identity is
+ // sent to the renderer in drag enter notifications. Note: the identity value
+ // is passed over the renderer NPAPI interface to gears, so use int32 instead
+ // of int here.
+ static int32 drag_identity_;
+
+ // The HWND of the source. This HWND is used to determine coordinates for
+ // mouse events that are sent to the renderer notifying various drag states.
+ HWND hwnd_;
+
+ // Whether or not we are currently processing drag notifications for drags
+ // initiated in this window.
+ bool suspended_;
+
+ LONG ref_count_;
+
+ DISALLOW_COPY_AND_ASSIGN(DropTarget);
+};
+
+} // namespace win
+} // namespace app
+
+#endif // APP_WIN_DROP_TARGET_H_