xiiLayerDragDropHandler Class Reference

Copyright (c) Theophilus Eriata. All Rights Reserved. More...

#include <LayerDragDropHandler.h>

Inheritance diagram for xiiLayerDragDropHandler:

Public Member Functions
virtual void	OnDragBegin (const xiiDragDropInfo *pInfo) override
	Called shortly after CanHandle returned true to begin handling a drag operation.
virtual void	OnDragUpdate (const xiiDragDropInfo *pInfo) override
	Called to update the drag operation with the latest state.
virtual void	OnDragCancel () override
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Protected Member Functions
const xiiRTTI *	GetCommonBaseType (const xiiDragDropInfo *pInfo) const
Protected Member Functions inherited from xiiDragDropHandler
virtual float	CanHandle (const xiiDragDropInfo *pInfo) const =0
virtual void	RequestConfiguration (xiiDragDropConfig *pConfigToFillOut)
	Potentially called by the drag drop target to request information about how to determine the xiiDragDropInfo data.
virtual void	OnDrop (const xiiDragDropInfo *pInfo)=0
	Final call to finish the drag & drop operation. Handler is destroyed after this.

Additional Inherited Members
Static Public Member Functions inherited from xiiDragDropHandler
static bool	IsHandlerActive ()
	Returns whether the last call to BeginDragDropOperation() was successful and a handler is now in effect.
static bool	BeginDragDropOperation (const xiiDragDropInfo *pInfo, xiiDragDropConfig *pConfigToFillOut=nullptr)
static void	UpdateDragDropOperation (const xiiDragDropInfo *pInfo)
	Call this when a drag event occurs. Ignored if BeginDragDropOperation() was not successful.
static void	FinishDragDrop (const xiiDragDropInfo *pInfo)
	Call this when a drop event occurs. Ignored if BeginDragDropOperation() was not successful.
static void	CancelDragDrop ()
	Call this when a drag leave event occurs. Ignored if BeginDragDropOperation() was not successful.
static bool	CanDropOnly (const xiiDragDropInfo *pInfo)
static bool	DropOnly (const xiiDragDropInfo *pInfo)
	Executes a complete drop action on a target that does not support continuous dragging. See also CanDropOnly().
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Detailed Description

Copyright (c) Theophilus Eriata. All Rights Reserved.

Base class for drag and drop handler that drop on a xiiSceneLayer.

Member Function Documentation

OnDragBegin()

virtual void xiiLayerDragDropHandler::OnDragBegin ( const xiiDragDropInfo * pInfo )

inlineoverridevirtual

Called shortly after CanHandle returned true to begin handling a drag operation.

Implements xiiDragDropHandler.

OnDragCancel()

virtual void xiiLayerDragDropHandler::OnDragCancel ( )

inlineoverridevirtual

Called when the drag operation leaves the designated area. The handler will be destroyed after this. It should clean up all temporary objects that it created before.

Implements xiiDragDropHandler.

OnDragUpdate()

virtual void xiiLayerDragDropHandler::OnDragUpdate ( const xiiDragDropInfo * pInfo )

inlineoverridevirtual

Called to update the drag operation with the latest state.

Implements xiiDragDropHandler.

---

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

• /home/runner/work/XII/XII/Source/EditorPlugins/Scene/EditorPluginScene/DragDropHandlers/LayerDragDropHandler.h
• /home/runner/work/XII/XII/Source/EditorPlugins/Scene/EditorPluginScene/DragDropHandlers/LayerDragDropHandler.cpp