/usr/share/doc/libjuce/apiref/classKeyboardFocusTraverser.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 | <!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: KeyboardFocusTraverser 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="classKeyboardFocusTraverser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KeyboardFocusTraverser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Controls the order in which focus moves between components.
<a href="classKeyboardFocusTraverser.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:a275c834346e37c782d74f08365f1a06f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyboardFocusTraverser.html#a275c834346e37c782d74f08365f1a06f">KeyboardFocusTraverser</a> ()</td></tr>
<tr class="separator:a275c834346e37c782d74f08365f1a06f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8dafe9d30ce2fbc9fb3163d1d16b2e7"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyboardFocusTraverser.html#ac8dafe9d30ce2fbc9fb3163d1d16b2e7">~KeyboardFocusTraverser</a> ()</td></tr>
<tr class="memdesc:ac8dafe9d30ce2fbc9fb3163d1d16b2e7"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac8dafe9d30ce2fbc9fb3163d1d16b2e7">More...</a><br /></td></tr>
<tr class="separator:ac8dafe9d30ce2fbc9fb3163d1d16b2e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e353323ae96807e5f9cc903e49ca839"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classComponent.html">Component</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyboardFocusTraverser.html#a7e353323ae96807e5f9cc903e49ca839">getNextComponent</a> (<a class="el" href="classComponent.html">Component</a> *current)</td></tr>
<tr class="memdesc:a7e353323ae96807e5f9cc903e49ca839"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component that should be given focus after the specified one when moving "forwards". <a href="#a7e353323ae96807e5f9cc903e49ca839">More...</a><br /></td></tr>
<tr class="separator:a7e353323ae96807e5f9cc903e49ca839"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab452631402fb9031651434f2e94b252c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classComponent.html">Component</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyboardFocusTraverser.html#ab452631402fb9031651434f2e94b252c">getPreviousComponent</a> (<a class="el" href="classComponent.html">Component</a> *current)</td></tr>
<tr class="memdesc:ab452631402fb9031651434f2e94b252c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component that should be given focus after the specified one when moving "backwards". <a href="#ab452631402fb9031651434f2e94b252c">More...</a><br /></td></tr>
<tr class="separator:ab452631402fb9031651434f2e94b252c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c21be5bdf95b97b501e595955c7d75b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classComponent.html">Component</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyboardFocusTraverser.html#a2c21be5bdf95b97b501e595955c7d75b">getDefaultComponent</a> (<a class="el" href="classComponent.html">Component</a> *parentComponent)</td></tr>
<tr class="memdesc:a2c21be5bdf95b97b501e595955c7d75b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component that should receive focus be default within the given parent component. <a href="#a2c21be5bdf95b97b501e595955c7d75b">More...</a><br /></td></tr>
<tr class="separator:a2c21be5bdf95b97b501e595955c7d75b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Controls the order in which focus moves between components. </p>
<p>The default algorithm used by this class to work out the order of traversal is as follows:</p><ul>
<li>if two components both have an explicit focus order specified, then the one with the lowest number comes first (see the <a class="el" href="classComponent.html#acea5b1758143ff5815fd13ae57f2172e" title="Sets the index used in determining the order in which focusable components should be traversed...">Component::setExplicitFocusOrder()</a> method).</li>
<li>any component with an explicit focus order greater than 0 comes before ones that don't have an order specified.</li>
<li>any unspecified components are traversed in a left-to-right, then top-to-bottom order.</li>
</ul>
<p>If you need traversal in a more customised way, you can create a subclass of <a class="el" href="classKeyboardFocusTraverser.html" title="Controls the order in which focus moves between components. ">KeyboardFocusTraverser</a> that uses your own algorithm, and use <a class="el" href="classComponent.html#a7826c4e247eb6a6901211741a3e1dca3" title="Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed...">Component::createFocusTraverser()</a> to create it.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classComponent.html#acea5b1758143ff5815fd13ae57f2172e" title="Sets the index used in determining the order in which focusable components should be traversed...">Component::setExplicitFocusOrder</a>, <a class="el" href="classComponent.html#a7826c4e247eb6a6901211741a3e1dca3" title="Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed...">Component::createFocusTraverser</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a275c834346e37c782d74f08365f1a06f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a275c834346e37c782d74f08365f1a06f">§ </a></span>KeyboardFocusTraverser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyboardFocusTraverser::KeyboardFocusTraverser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac8dafe9d30ce2fbc9fb3163d1d16b2e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8dafe9d30ce2fbc9fb3163d1d16b2e7">§ </a></span>~KeyboardFocusTraverser()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual KeyboardFocusTraverser::~KeyboardFocusTraverser </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="a7e353323ae96807e5f9cc903e49ca839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e353323ae96807e5f9cc903e49ca839">§ </a></span>getNextComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classComponent.html">Component</a>* KeyboardFocusTraverser::getNextComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>current</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>Returns the component that should be given focus after the specified one when moving "forwards". </p>
<p>The default implementation will return the next component which is to the right of or below this one.</p>
<p>This may return nullptr if there's no suitable candidate. </p>
</div>
</div>
<a id="ab452631402fb9031651434f2e94b252c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab452631402fb9031651434f2e94b252c">§ </a></span>getPreviousComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classComponent.html">Component</a>* KeyboardFocusTraverser::getPreviousComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>current</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>Returns the component that should be given focus after the specified one when moving "backwards". </p>
<p>The default implementation will return the next component which is to the left of or above this one.</p>
<p>This may return nullptr if there's no suitable candidate. </p>
</div>
</div>
<a id="a2c21be5bdf95b97b501e595955c7d75b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c21be5bdf95b97b501e595955c7d75b">§ </a></span>getDefaultComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classComponent.html">Component</a>* KeyboardFocusTraverser::getDefaultComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>parentComponent</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>Returns the component that should receive focus be default within the given parent component. </p>
<p>The default implementation will just return the foremost child component that wants focus.</p>
<p>This may return nullptr if there's no suitable candidate. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__KeyboardFocusTraverser_8h.html">juce_KeyboardFocusTraverser.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|