doxygen: add newline after \file
[blender.git] / intern / ghost / intern / GHOST_EventDragnDrop.h
index ea13a33..b3572c4 100644 (file)
@@ -1,7 +1,4 @@
-/**
- * $Id$
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
+/*
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): Damien Plisson 11/2009
- *
- * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef _GHOST_EVENT_DRAGNDROP_H_
-#define _GHOST_EVENT_DRAGNDROP_H_
+/** \file
+ * \ingroup GHOST
+ */
+
+
+#ifndef __GHOST_EVENTDRAGNDROP_H__
+#define __GHOST_EVENTDRAGNDROP_H__
 
 #include "GHOST_Event.h"
 extern "C" {
@@ -37,22 +33,24 @@ extern "C" {
 
 /**
  * Drag & drop event
- * 
+ *
  * The dragging sequence is performed in four phases:
- * 
- * <li> Start sequence (GHOST_kEventDraggingEntered) that tells a drag'n'drop operation has started. Already gives the object data type,
- * and the entering mouse location
  *
- * <li> Update mouse position (GHOST_kEventDraggingUpdated) sent upon each mouse move until the drag'n'drop operation stops, to give the updated mouse position.
- * Useful to highlight a potential destination, and update the status (through GHOST_setAcceptDragOperation) telling if the object can be dropped at
+ * <li> Start sequence (GHOST_kEventDraggingEntered) that tells a drag'n'drop operation has started.
+ * Already gives the object data type, and the entering mouse location
+ *
+ * <li> Update mouse position (GHOST_kEventDraggingUpdated) sent upon each mouse move until the drag'n'drop operation
+ * stops, to give the updated mouse position. Useful to highlight a potential destination, and update the status
+ * (through GHOST_setAcceptDragOperation) telling if the object can be dropped at
  * the current cursor position.
  *
  * <li> Abort drag'n'drop sequence (GHOST_kEventDraggingExited) sent when the user moved the mouse outside the window.
  *
  * <li> Send the dropped data (GHOST_kEventDraggingDropDone)
  *
- * <li> Outside of the normal sequence, dropped data can be sent (GHOST_kEventDraggingDropOnIcon). This can happen when the user drops an object
- * on the application icon. (Also used in OSX to pass the filename of the document the user doubled-clicked in the finder)
+ * <li> Outside of the normal sequence, dropped data can be sent (GHOST_kEventDraggingDropOnIcon).
+ * This can happen when the user drops an object on the application icon.
+ * (Also used in OSX to pass the filename of the document the user doubled-clicked in the finder)
  *
  * <br><br>Note that the mouse positions are given in Blender coordinates (y=0 at bottom)
  *
@@ -66,16 +64,19 @@ class GHOST_EventDragnDrop : public GHOST_Event
 public:
        /**
         * Constructor.
-        * @param time          The time this event was generated.
-        * @param type          The type of this event.
-        * @param dataType      The type of the drop candidate object
-        * @param window        The window where the event occured
-        * @param x                     The x-coordinate of the location the cursor was at at the time of the event.
-        * @param y                     The y-coordinate of the location the cursor was at at the time of the event.
-        * @param data          The "content" dropped in the window
+        * \param time      The time this event was generated.
+        * \param type      The type of this event.
+        * \param dataType  The type of the drop candidate object
+        * \param window    The window where the event occurred
+        * \param x         The x-coordinate of the location the cursor was at at the time of the event.
+        * \param y         The y-coordinate of the location the cursor was at at the time of the event.
+        * \param data      The "content" dropped in the window
         */
-       GHOST_EventDragnDrop(GHOST_TUns64 time, GHOST_TEventType type, GHOST_TDragnDropTypes dataType, GHOST_IWindow* window,
-                                                int x, int y, GHOST_TEventDataPtr data)
+       GHOST_EventDragnDrop(GHOST_TUns64 time,
+                            GHOST_TEventType type,
+                            GHOST_TDragnDropTypes dataType,
+                            GHOST_IWindow *window,
+                            int x, int y, GHOST_TEventDataPtr data)
                : GHOST_Event(time, type, window)
        {
                m_dragnDropEventData.x = x;
@@ -84,43 +85,43 @@ public:
                m_dragnDropEventData.data = data;
                m_data = &m_dragnDropEventData;
        }
-       
+
        ~GHOST_EventDragnDrop()
        {
                //Free the dropped object data
                if (m_dragnDropEventData.data == NULL)
                        return;
-               
+
                switch (m_dragnDropEventData.dataType) {
                        case GHOST_kDragnDropTypeBitmap:
-                               IMB_freeImBuf((ImBuf*)m_dragnDropEventData.data);
+                               IMB_freeImBuf((ImBuf *)m_dragnDropEventData.data);
                                break;
                        case GHOST_kDragnDropTypeFilenames:
                        {
-                               GHOST_TStringArray *strArray = (GHOST_TStringArray*)m_dragnDropEventData.data;
+                               GHOST_TStringArray *strArray = (GHOST_TStringArray *)m_dragnDropEventData.data;
                                int i;
-                               
-                               for (i=0;i<strArray->count;i++)
+
+                               for (i = 0; i < strArray->count; i++)
                                        free(strArray->strings[i]);
-                               
+
+                               free(strArray->strings);
                                free(strArray);
                        }
-                               break;
+                       break;
                        case GHOST_kDragnDropTypeString:
                                free(m_dragnDropEventData.data);
-                       break;
+                               break;
 
                        default:
                                break;
                }
        }
-       
-       
+
+
 
 protected:
        /** The x,y-coordinates of the cursor position. */
        GHOST_TEventDragnDropData m_dragnDropEventData;
 };
 
-#endif // _GHOST_EVENT_DRAGNDROP_H_
-
+#endif // __GHOST_EVENTDRAGNDROP_H__