/usr/share/doc/libjuce/apiref/classFileDragAndDropTarget.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: FileDragAndDropTarget Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classFileDragAndDropTarget-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FileDragAndDropTarget Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Components derived from this class can have files dropped onto them by an external application.
<a href="classFileDragAndDropTarget.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for FileDragAndDropTarget:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classFileDragAndDropTarget.png" usemap="#FileDragAndDropTarget_map" alt=""/>
<map id="FileDragAndDropTarget_map" name="FileDragAndDropTarget_map">
<area href="classFilenameComponent.html" title="Shows a filename as an editable text box, with a 'browse' button and a drop-down list for recently se..." alt="FilenameComponent" shape="rect" coords="0,56,181,80"/>
<area href="classFileSearchPathListComponent.html" title="Shows a set of file paths in a list, allowing them to be added, removed or re-ordered. " alt="FileSearchPathListComponent" shape="rect" coords="191,56,372,80"/>
<area href="classPluginListComponent.html" title="A component displaying a list of plugins, with options to scan for them, add, remove and sort them..." alt="PluginListComponent" shape="rect" coords="382,56,563,80"/>
<area href="classTreeView.html" title="A tree-view component. " alt="TreeView" shape="rect" coords="573,56,754,80"/>
<area href="classFileTreeComponent.html" title="A component that displays the files in a directory as a treeview. " alt="FileTreeComponent" shape="rect" coords="573,112,754,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac2dd4bc23ee0e715943c90bfb12cfb92"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileDragAndDropTarget.html#ac2dd4bc23ee0e715943c90bfb12cfb92">~FileDragAndDropTarget</a> ()</td></tr>
<tr class="memdesc:ac2dd4bc23ee0e715943c90bfb12cfb92"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac2dd4bc23ee0e715943c90bfb12cfb92">More...</a><br /></td></tr>
<tr class="separator:ac2dd4bc23ee0e715943c90bfb12cfb92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44fa7f7e69dec8119c6b3a6ff9d2ddce"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileDragAndDropTarget.html#a44fa7f7e69dec8119c6b3a6ff9d2ddce">isInterestedInFileDrag</a> (const <a class="el" href="classStringArray.html">StringArray</a> &files)=0</td></tr>
<tr class="memdesc:a44fa7f7e69dec8119c6b3a6ff9d2ddce"><td class="mdescLeft"> </td><td class="mdescRight">Callback to check whether this target is interested in the set of files being offered. <a href="#a44fa7f7e69dec8119c6b3a6ff9d2ddce">More...</a><br /></td></tr>
<tr class="separator:a44fa7f7e69dec8119c6b3a6ff9d2ddce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a474150f8eb50c1272ea3eef9e30522e6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileDragAndDropTarget.html#a474150f8eb50c1272ea3eef9e30522e6">fileDragEnter</a> (const <a class="el" href="classStringArray.html">StringArray</a> &files, int x, int y)</td></tr>
<tr class="memdesc:a474150f8eb50c1272ea3eef9e30522e6"><td class="mdescLeft"> </td><td class="mdescRight">Callback to indicate that some files are being dragged over this component. <a href="#a474150f8eb50c1272ea3eef9e30522e6">More...</a><br /></td></tr>
<tr class="separator:a474150f8eb50c1272ea3eef9e30522e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae07df070efc3dfcd54c7b97b36dc1b8e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileDragAndDropTarget.html#ae07df070efc3dfcd54c7b97b36dc1b8e">fileDragMove</a> (const <a class="el" href="classStringArray.html">StringArray</a> &files, int x, int y)</td></tr>
<tr class="memdesc:ae07df070efc3dfcd54c7b97b36dc1b8e"><td class="mdescLeft"> </td><td class="mdescRight">Callback to indicate that the user is dragging some files over this component. <a href="#ae07df070efc3dfcd54c7b97b36dc1b8e">More...</a><br /></td></tr>
<tr class="separator:ae07df070efc3dfcd54c7b97b36dc1b8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a218984a4bb2fa6d33418c0f519e4685b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileDragAndDropTarget.html#a218984a4bb2fa6d33418c0f519e4685b">fileDragExit</a> (const <a class="el" href="classStringArray.html">StringArray</a> &files)</td></tr>
<tr class="memdesc:a218984a4bb2fa6d33418c0f519e4685b"><td class="mdescLeft"> </td><td class="mdescRight">Callback to indicate that the mouse has moved away from this component. <a href="#a218984a4bb2fa6d33418c0f519e4685b">More...</a><br /></td></tr>
<tr class="separator:a218984a4bb2fa6d33418c0f519e4685b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc7848885ab2d9380f242c6445b019d4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileDragAndDropTarget.html#adc7848885ab2d9380f242c6445b019d4">filesDropped</a> (const <a class="el" href="classStringArray.html">StringArray</a> &files, int x, int y)=0</td></tr>
<tr class="memdesc:adc7848885ab2d9380f242c6445b019d4"><td class="mdescLeft"> </td><td class="mdescRight">Callback to indicate that the user has dropped the files onto this component. <a href="#adc7848885ab2d9380f242c6445b019d4">More...</a><br /></td></tr>
<tr class="separator:adc7848885ab2d9380f242c6445b019d4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Components derived from this class can have files dropped onto them by an external application. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classDragAndDropContainer.html" title="Enables drag-and-drop behaviour for a component and all its sub-components. ">DragAndDropContainer</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac2dd4bc23ee0e715943c90bfb12cfb92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2dd4bc23ee0e715943c90bfb12cfb92">§ </a></span>~FileDragAndDropTarget()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual FileDragAndDropTarget::~FileDragAndDropTarget </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a44fa7f7e69dec8119c6b3a6ff9d2ddce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44fa7f7e69dec8119c6b3a6ff9d2ddce">§ </a></span>isInterestedInFileDrag()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool FileDragAndDropTarget::isInterestedInFileDrag </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringArray.html">StringArray</a> & </td>
<td class="paramname"><em>files</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback to check whether this target is interested in the set of files being offered. </p>
<p>Note that this will be called repeatedly when the user is dragging the mouse around over your component, so don't do anything time-consuming in here, like opening the files to have a look inside them!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">files</td><td>the set of (absolute) pathnames of the files that the user is dragging </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this component wants to receive the other callbacks regarging this type of object; if it returns false, no other callbacks will be made. </dd></dl>
<p>Implemented in <a class="el" href="classTreeView.html#aef2f83d071863ec00db59450d746c3a4">TreeView</a>, <a class="el" href="classFilenameComponent.html#a62c18fb60b1efe4913dc12e5c8da144f">FilenameComponent</a>, and <a class="el" href="classFileSearchPathListComponent.html#aa3b2399586c8004e521ec1c0f5245d15">FileSearchPathListComponent</a>.</p>
</div>
</div>
<a id="a474150f8eb50c1272ea3eef9e30522e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a474150f8eb50c1272ea3eef9e30522e6">§ </a></span>fileDragEnter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void FileDragAndDropTarget::fileDragEnter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringArray.html">StringArray</a> & </td>
<td class="paramname"><em>files</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback to indicate that some files are being dragged over this component. </p>
<p>This gets called when the user moves the mouse into this component while dragging.</p>
<p>Use this callback as a trigger to make your component repaint itself to give the user feedback about whether the files can be dropped here or not.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">files</td><td>the set of (absolute) pathnames of the files that the user is dragging </td></tr>
<tr><td class="paramname">x</td><td>the mouse x position, relative to this component </td></tr>
<tr><td class="paramname">y</td><td>the mouse y position, relative to this component </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classTreeView.html#a23da6d4d8f6844fa49b137e319aed77d">TreeView</a>, and <a class="el" href="classFilenameComponent.html#a66841d54561cec5728495aa4a7f21533">FilenameComponent</a>.</p>
</div>
</div>
<a id="ae07df070efc3dfcd54c7b97b36dc1b8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae07df070efc3dfcd54c7b97b36dc1b8e">§ </a></span>fileDragMove()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void FileDragAndDropTarget::fileDragMove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringArray.html">StringArray</a> & </td>
<td class="paramname"><em>files</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback to indicate that the user is dragging some files over this component. </p>
<p>This gets called when the user moves the mouse over this component while dragging. Normally overriding itemDragEnter() and itemDragExit() are enough, but this lets you know what happens in-between.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">files</td><td>the set of (absolute) pathnames of the files that the user is dragging </td></tr>
<tr><td class="paramname">x</td><td>the mouse x position, relative to this component </td></tr>
<tr><td class="paramname">y</td><td>the mouse y position, relative to this component </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classTreeView.html#ab85b634b58ffa73eb90190a7e3f4f20e">TreeView</a>.</p>
</div>
</div>
<a id="a218984a4bb2fa6d33418c0f519e4685b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a218984a4bb2fa6d33418c0f519e4685b">§ </a></span>fileDragExit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void FileDragAndDropTarget::fileDragExit </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringArray.html">StringArray</a> & </td>
<td class="paramname"><em>files</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback to indicate that the mouse has moved away from this component. </p>
<p>This gets called when the user moves the mouse out of this component while dragging the files.</p>
<p>If you've used <a class="el" href="classFileDragAndDropTarget.html#a474150f8eb50c1272ea3eef9e30522e6" title="Callback to indicate that some files are being dragged over this component. ">fileDragEnter()</a> to repaint your component and give feedback, use this as a signal to repaint it in its normal state.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">files</td><td>the set of (absolute) pathnames of the files that the user is dragging </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classTreeView.html#a978978d39f7f3c3f24e073b4332d57bc">TreeView</a>, and <a class="el" href="classFilenameComponent.html#abedf0bb6daf0bd9663bafabc30a2d3e7">FilenameComponent</a>.</p>
</div>
</div>
<a id="adc7848885ab2d9380f242c6445b019d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc7848885ab2d9380f242c6445b019d4">§ </a></span>filesDropped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void FileDragAndDropTarget::filesDropped </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringArray.html">StringArray</a> & </td>
<td class="paramname"><em>files</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback to indicate that the user has dropped the files onto this component. </p>
<p>When the user drops the files, this get called, and you can use the files in whatever way is appropriate.</p>
<p>Note that after this is called, the fileDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">files</td><td>the set of (absolute) pathnames of the files that the user is dragging </td></tr>
<tr><td class="paramname">x</td><td>the mouse x position, relative to this component </td></tr>
<tr><td class="paramname">y</td><td>the mouse y position, relative to this component </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classTreeView.html#a884bd3d9658450751ced2165b77d800f">TreeView</a>, <a class="el" href="classFilenameComponent.html#a2051b45db8ca9671e09d2e7c30a367ca">FilenameComponent</a>, and <a class="el" href="classFileSearchPathListComponent.html#a4cf163995fee93469999d6be23122749">FileSearchPathListComponent</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__FileDragAndDropTarget_8h.html">juce_FileDragAndDropTarget.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|