Functions | |
GuiDragDropStatus | mdlWindow_dragDropRegister (MSWindowP gwP) |
Registers a window as a possible drop target. More... | |
GuiDragDropStatus | mdlWindow_dragDropRevoke (MSWindowP gwP) |
Unregisters/revokes a window as a possible drop target. More... | |
void | mdlWindow_dragDropHasTarget (MSWindowP gwP, bool bHasTarget) |
Sets/clears a window's "has a drop target" flag. More... | |
GuiDragDropStatus | mdlWindow_dragDropDo (MSWindowP gwP, DialogItem *diP, GuiDataObject *pDataObject, UInt32 ulEffectsAllowed) |
Starts a Drag & Drop operation. More... | |
GuiDataObject * | mdlDataObject_create (UInt32 cfFormat, UserDataP pAppData, Int32 iDataSize) |
Creates a GuiDataObject to be used in further Drag and Drop functions. More... | |
StatusInt | mdlDataObject_destroy (GuiDataObject *pDataObject) |
Destroys a GuiDataObject. More... | |
UserDataP | mdlDataObject_getApplicationData (GuiDataObject *pDataObject, UInt32 cfFormat) |
Retrieves the application's data pointer originally passed into mdlDataObject_create or mdlDataObject_addFormat. More... | |
StatusInt | mdlDataObject_addFormat (GuiDataObject *pDataObject, UInt32 cfFormat, UserDataP pAppData, Int32 iDataSize) |
Adds a clipboard format and associated data to the GuiDataObject. More... | |
bool | mdlDataObject_isFormatAvailable (GuiDataObject *pDataObject, UInt32 cfFormat) |
Determines whether a particular clipboard format is associated with the GuiDataObject. More... | |
UserDataP | mdlDataObject_getData (GuiDataObject *pDataObject, UInt32 cfFormat) |
Retrieves a copy of the data from the GuiDataObject. More... | |
StatusInt | mdlDataObject_getDataHere (UserDataP pBuffer, Int32 iBufferSize, GuiDataObject *pDataObject, UInt32 cfFormat) |
Retrieves the data from the GuiDataObject and copies it into the caller-supplied buffer. More... | |
struct IDataObject * | mdlDataObject_getIDataObject (GuiDataObject *pDataObject) |
Retrieves the Windows IDataObject interface pointer. More... | |
Int32 | mdlDataObject_getDragFileCount (GuiDataObject *pDataObject) |
Retrieves the number of files listed in an CF_HDROP data object. More... | |
Int32 | mdlDataObject_getDragFile (WCharP pBuffer, Int32 iBufferSize, GuiDataObject *pDataObject, Int32 iFile) |
Retrieves the file name at a certain index within an CF_HDROP data object. More... | |
Int32 | mdlDataObject_getFormatCount (GuiDataObject *pDataObject) |
Retrieves the number of clipboard formats in the GuiDataObject. More... | |
StatusInt | mdlDataObject_getFormat (UInt32 *pCfFormat, GuiDataObject *pDataObject, Int32 iIndex) |
Retrieves the format at a particular index in the GuiDataObject. More... | |
StatusInt mdlDataObject_addFormat | ( | GuiDataObject * | pDataObject, |
UInt32 | cfFormat, | ||
UserDataP | pAppData, | ||
Int32 | iDataSize | ||
) |
Adds a clipboard format and associated data to the GuiDataObject.
[in] | pDataObject | The GuiDataObject to add a format and data to. |
[in] | cfFormat | A pre-defined or registered Clipboard format. Use mdlClipboard_registerClipboardFormat to register your own Clipboard formats. |
[in] | pAppData | The data to drop onto a target. |
[in] | iDataSize | The size, in bytes, of the data pointed to by pAppData. |
GuiDataObject* mdlDataObject_create | ( | UInt32 | cfFormat, |
UserDataP | pAppData, | ||
Int32 | iDataSize | ||
) |
Creates a GuiDataObject to be used in further Drag and Drop functions.
[in] | cfFormat | A pre-defined or registered clipboard format. Use mdlClipboard_registerClipboardFormat to register your own clipboard formats. |
[in] | pAppData | The data to drop onto a target. |
[in] | iDataSize | The size, in bytes, of the data pointed to by pAppData. |
StatusInt mdlDataObject_destroy | ( | GuiDataObject * | pDataObject | ) |
Destroys a GuiDataObject.
[in] | pDataObject | The GuiDataObject to be destroyed |
UserDataP mdlDataObject_getApplicationData | ( | GuiDataObject * | pDataObject, |
UInt32 | cfFormat | ||
) |
Retrieves the application's data pointer originally passed into mdlDataObject_create or mdlDataObject_addFormat.
[in] | pDataObject | The GuiDataObject from which to get the application data pointer. |
[in] | cfFormat | A pre-defined or registered Clipboard format. This should be a cfFormat used in an mdlDataObject_create call or mdlDataObject_addFormat call. |
UserDataP mdlDataObject_getData | ( | GuiDataObject * | pDataObject, |
UInt32 | cfFormat | ||
) |
Retrieves a copy of the data from the GuiDataObject.
[in] | pDataObject | The GuiDataObject from which to retrieve the data. |
[in] | cfFormat | A pre-defined or registered Clipboard format. |
StatusInt mdlDataObject_getDataHere | ( | UserDataP | pBuffer, |
Int32 | iBufferSize, | ||
GuiDataObject * | pDataObject, | ||
UInt32 | cfFormat | ||
) |
Retrieves the data from the GuiDataObject and copies it into the caller-supplied buffer.
[in] | pBuffer | The buffer receiving the data. |
[in] | iBufferSize | The size, in bytes, of the buffer receiving the data. |
[in] | pDataObject | The GuiDataObject from which to retrieve the data. |
[in] | cfFormat | A pre-defined or registered Clipboard format. |
Int32 mdlDataObject_getDragFile | ( | WCharP | pBuffer, |
Int32 | iBufferSize, | ||
GuiDataObject * | pDataObject, | ||
Int32 | iFile | ||
) |
Retrieves the file name at a certain index within an CF_HDROP data object.
[in] | pBuffer | Buffer receiving the file name. |
[in] | iBufferSize | Number of characters in the buffer receiving the file name. |
[in] | pDataObject | The GuiDataObject from which to get the number of files listed. |
[in] | iFile | Index of the file name to retrieve. |
Int32 mdlDataObject_getDragFileCount | ( | GuiDataObject * | pDataObject | ) |
Retrieves the number of files listed in an CF_HDROP data object.
[in] | pDataObject | The GuiDataObject from which to get the number of files listed. |
StatusInt mdlDataObject_getFormat | ( | UInt32 * | pCfFormat, |
GuiDataObject * | pDataObject, | ||
Int32 | iIndex | ||
) |
Retrieves the format at a particular index in the GuiDataObject.
[in] | pCfFormat | Receives the clipboard format. |
[in] | pDataObject | The GuiDataObject from which to get the number of files listed. |
[in] | iIndex | Index of the clipboard format to retrieve. |
Int32 mdlDataObject_getFormatCount | ( | GuiDataObject * | pDataObject | ) |
Retrieves the number of clipboard formats in the GuiDataObject.
[in] | pDataObject | The GuiDataObject from which to get the number of clipboard formats. |
struct IDataObject* mdlDataObject_getIDataObject | ( | GuiDataObject * | pDataObject | ) |
Retrieves the Windows IDataObject interface pointer.
[in] | pDataObject | The GuiDataObject from which to get the IDataObject pointer. |
bool mdlDataObject_isFormatAvailable | ( | GuiDataObject * | pDataObject, |
UInt32 | cfFormat | ||
) |
Determines whether a particular clipboard format is associated with the GuiDataObject.
[in] | pDataObject | The GuiDataObject to query for a format. |
[in] | cfFormat | A pre-defined or registered Clipboard format. Use mdlClipboard_registerClipboardFormat to register your own Clipboard formats. |
GuiDragDropStatus mdlWindow_dragDropDo | ( | MSWindowP | gwP, |
DialogItem * | diP, | ||
GuiDataObject * | pDataObject, | ||
UInt32 | ulEffectsAllowed | ||
) |
Starts a Drag & Drop operation.
[in] | gwP | window acting as the drop source |
[in] | diP | The source Dialog Item (NULL if gwP is not a Dialog) |
[in] | pDataObject | The data object to be dropped |
[in] | ulEffectsAllowed | A list of effects allowed from the GUIDROPEFFECT_* list |
void mdlWindow_dragDropHasTarget | ( | MSWindowP | gwP, |
bool | bHasTarget | ||
) |
Sets/clears a window's "has a drop target" flag.
[in] | gwP | window whose drop target flag is being set |
[in] | bHasTarget | true if the window has a drop target area |
GuiDragDropStatus mdlWindow_dragDropRegister | ( | MSWindowP | gwP | ) |
Registers a window as a possible drop target.
[in] | gwP | window being registered as the drop target |
GuiDragDropStatus mdlWindow_dragDropRevoke | ( | MSWindowP | gwP | ) |
Unregisters/revokes a window as a possible drop target.
[in] | gwP | window being revoked as the drop target |