gwm17/glfw
1
0
Fork 0
mirror of https://github.com/gwm17/glfw.git synced 2024-11-26 20:28:49 -05:00
Code Issues Projects Releases Wiki Activity

Clarified language for file drop callback.

Browse Source
This commit is contained in:
Camilla Berglund 2014-03-29 21:35:21 +01:00
parent bf0adc2c70
commit 5c8121e7a8
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/news.dox
View File

@ -14,7 +14,7 @@ created with @ref glfwCreateCursor and set with @ref glfwSetCursor. Note that
custom cursors are only visible in normal cursor mode. custom cursors are only visible in normal cursor mode.
@subsection news_31_drop Drop event support @subsection news_31_drop File drop event support
GLFW now provides a callback for receiving the paths of files dropped onto GLFW GLFW now provides a callback for receiving the paths of files dropped onto GLFW
windows. The callback is set with the @ref glfwSetDropCallback function. windows. The callback is set with the @ref glfwSetDropCallback function.

18
include/GLFW/glfw3.h
View File

@ -784,13 +784,13 @@ typedef void (* GLFWkeyfun)(GLFWwindow*,int,int,int,int);
typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int); typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int);
/*! @brief The function signature for drop callbacks. /*! @brief The function signature for file drop callbacks.
* *
* This is the function signature for drop callbacks. * This is the function signature for file drop callbacks.
* *
* @param[in] window The window that received the event. * @param[in] window The window that received the event.
* @param[in] count The number of dropped objects. * @param[in] count The number of dropped files.
* @param[in] names The UTF-8 encoded names of the dropped objects. * @param[in] names The UTF-8 encoded path names of the dropped files.
* *
* @sa glfwSetDropCallback * @sa glfwSetDropCallback
* *
@ -2195,15 +2195,15 @@ GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcu
*/ */
GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun cbfun); GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun cbfun);
/*! @brief Sets the drop callback. /*! @brief Sets the file drop callback.
* *
* This function sets the drop callback of the specified window, which is * This function sets the file drop callback of the specified window, which is
* called when an object is dropped over the window. * called when one or more dragged files are dropped on the window.
* *
* *
* @param[in] window The window whose callback to set. * @param[in] window The window whose callback to set.
* @param[in] cbfun The new drop callback, or `NULL` to remove the currently * @param[in] cbfun The new file drop callback, or `NULL` to remove the
* set callback. * currently set callback.
* @return The previously set callback, or `NULL` if no callback was set or an * @return The previously set callback, or `NULL` if no callback was set or an
* error occurred. * error occurred.
* *