/usr/share/doc/libjuce/apiref/classComponentDragger.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 | <!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: ComponentDragger 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="classComponentDragger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComponentDragger Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An object to take care of the logic for dragging components around with the mouse.
<a href="classComponentDragger.html#details">More...</a></p>
<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:ac702fc282b4d5c9c059b1d5fe73a266d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponentDragger.html#ac702fc282b4d5c9c059b1d5fe73a266d">ComponentDragger</a> ()</td></tr>
<tr class="memdesc:ac702fc282b4d5c9c059b1d5fe73a266d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classComponentDragger.html" title="An object to take care of the logic for dragging components around with the mouse. ">ComponentDragger</a>. <a href="#ac702fc282b4d5c9c059b1d5fe73a266d">More...</a><br /></td></tr>
<tr class="separator:ac702fc282b4d5c9c059b1d5fe73a266d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e2b9b526ddff35060fecdbdca4ade30"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponentDragger.html#a6e2b9b526ddff35060fecdbdca4ade30">~ComponentDragger</a> ()</td></tr>
<tr class="memdesc:a6e2b9b526ddff35060fecdbdca4ade30"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6e2b9b526ddff35060fecdbdca4ade30">More...</a><br /></td></tr>
<tr class="separator:a6e2b9b526ddff35060fecdbdca4ade30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a6ae550729873ec7fa31a48bc79a352"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponentDragger.html#a3a6ae550729873ec7fa31a48bc79a352">startDraggingComponent</a> (<a class="el" href="classComponent.html">Component</a> *componentToDrag, const <a class="el" href="classMouseEvent.html">MouseEvent</a> &e)</td></tr>
<tr class="memdesc:a3a6ae550729873ec7fa31a48bc79a352"><td class="mdescLeft"> </td><td class="mdescRight">Call this from your component's mouseDown() method, to prepare for dragging. <a href="#a3a6ae550729873ec7fa31a48bc79a352">More...</a><br /></td></tr>
<tr class="separator:a3a6ae550729873ec7fa31a48bc79a352"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2ebcd662f3279b373bfaf035f2c269e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponentDragger.html#af2ebcd662f3279b373bfaf035f2c269e">dragComponent</a> (<a class="el" href="classComponent.html">Component</a> *componentToDrag, const <a class="el" href="classMouseEvent.html">MouseEvent</a> &e, <a class="el" href="classComponentBoundsConstrainer.html">ComponentBoundsConstrainer</a> *constrainer)</td></tr>
<tr class="memdesc:af2ebcd662f3279b373bfaf035f2c269e"><td class="mdescLeft"> </td><td class="mdescRight">Call this from your mouseDrag() callback to move the component. <a href="#af2ebcd662f3279b373bfaf035f2c269e">More...</a><br /></td></tr>
<tr class="separator:af2ebcd662f3279b373bfaf035f2c269e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An object to take care of the logic for dragging components around with the mouse. </p>
<p>Very easy to use - in your mouseDown() callback, call <a class="el" href="classComponentDragger.html#a3a6ae550729873ec7fa31a48bc79a352" title="Call this from your component's mouseDown() method, to prepare for dragging. ">startDraggingComponent()</a>, then in your mouseDrag() callback, call <a class="el" href="classComponentDragger.html#af2ebcd662f3279b373bfaf035f2c269e" title="Call this from your mouseDrag() callback to move the component. ">dragComponent()</a>.</p>
<p>When starting a drag, you can give it a <a class="el" href="classComponentBoundsConstrainer.html" title="A class that imposes restrictions on a Component's size or position. ">ComponentBoundsConstrainer</a> to use to limit the component's position and keep it on-screen.</p>
<p>e.g.</p><div class="fragment"><div class="line"><span class="keyword">class </span>MyDraggableComp</div><div class="line">{</div><div class="line"> <a class="code" href="classComponentDragger.html">ComponentDragger</a> myDragger;</div><div class="line"></div><div class="line"> <span class="keywordtype">void</span> mouseDown (<span class="keyword">const</span> <a class="code" href="classMouseEvent.html">MouseEvent</a>& e)</div><div class="line"> {</div><div class="line"> myDragger.<a class="code" href="classComponentDragger.html#a3a6ae550729873ec7fa31a48bc79a352">startDraggingComponent</a> (<span class="keyword">this</span>, e);</div><div class="line"> }</div><div class="line"></div><div class="line"> <span class="keywordtype">void</span> mouseDrag (<span class="keyword">const</span> <a class="code" href="classMouseEvent.html">MouseEvent</a>& e)</div><div class="line"> {</div><div class="line"> myDragger.<a class="code" href="classComponentDragger.html#af2ebcd662f3279b373bfaf035f2c269e">dragComponent</a> (<span class="keyword">this</span>, e, <span class="keyword">nullptr</span>);</div><div class="line"> }</div><div class="line">};</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac702fc282b4d5c9c059b1d5fe73a266d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac702fc282b4d5c9c059b1d5fe73a266d">§ </a></span>ComponentDragger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ComponentDragger::ComponentDragger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classComponentDragger.html" title="An object to take care of the logic for dragging components around with the mouse. ">ComponentDragger</a>. </p>
</div>
</div>
<a id="a6e2b9b526ddff35060fecdbdca4ade30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e2b9b526ddff35060fecdbdca4ade30">§ </a></span>~ComponentDragger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ComponentDragger::~ComponentDragger </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="a3a6ae550729873ec7fa31a48bc79a352"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a6ae550729873ec7fa31a48bc79a352">§ </a></span>startDraggingComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComponentDragger::startDraggingComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>componentToDrag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classMouseEvent.html">MouseEvent</a> & </td>
<td class="paramname"><em>e</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this from your component's mouseDown() method, to prepare for dragging. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">componentToDrag</td><td>the component that you want to drag </td></tr>
<tr><td class="paramname">e</td><td>the mouse event that is triggering the drag </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classComponentDragger.html#af2ebcd662f3279b373bfaf035f2c269e" title="Call this from your mouseDrag() callback to move the component. ">dragComponent</a> </dd></dl>
</div>
</div>
<a id="af2ebcd662f3279b373bfaf035f2c269e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2ebcd662f3279b373bfaf035f2c269e">§ </a></span>dragComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComponentDragger::dragComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>componentToDrag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classMouseEvent.html">MouseEvent</a> & </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponentBoundsConstrainer.html">ComponentBoundsConstrainer</a> * </td>
<td class="paramname"><em>constrainer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this from your mouseDrag() callback to move the component. </p>
<p>This will move the component, using the given constrainer object to check the new position.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">componentToDrag</td><td>the component that you want to drag </td></tr>
<tr><td class="paramname">e</td><td>the current mouse-drag event </td></tr>
<tr><td class="paramname">constrainer</td><td>an optional constrainer object that should be used to apply limits to the component's position. Pass null if you don't want to contrain the movement. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classComponentDragger.html#a3a6ae550729873ec7fa31a48bc79a352" title="Call this from your component's mouseDown() method, to prepare for dragging. ">startDraggingComponent</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ComponentDragger_8h.html">juce_ComponentDragger.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|