mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
389 lines
18 KiB
HTML
389 lines
18 KiB
HTML
<!-- HTML header for doxygen 1.9.8-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.12.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FTXUI: CapturedMouseInterface 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>
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
|
<script type="module">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
await new Promise(r => window.addEventListener('DOMContentLoaded', r));
|
|
// Remove title when a img[alt='title-img'] is present.
|
|
// Find an image with the alt "img-title".
|
|
const img = document.querySelector("img[alt='title-img']");
|
|
const header = document.querySelector(".headertitle");
|
|
if (img && header) {
|
|
// Hide the header title progressively.
|
|
header.style.display = "none";
|
|
// Show progressively the image.
|
|
img.style.maxHeight = "40vh";
|
|
img.style.maxWidth = "100%";
|
|
img.style.objectFit = "contain";
|
|
}
|
|
// In the "examples.html" page. Turn every link with text
|
|
// "examples/<...>
|
|
//
|
|
// Add a "demo" link toward.
|
|
// https://arthursonzogni.github.io/FTXUI/examples/?file=<...>
|
|
const examples = document.querySelectorAll("a")
|
|
examples.forEach((example) => {
|
|
if (!example.textContent.startsWith("examples/")) {
|
|
return;
|
|
}
|
|
// Remove the ".cpp" extension from the example name.
|
|
const exampleName = example.textContent.replace("examples/", "").replace(".cpp", "");
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + exampleName;
|
|
a.style.marginRight= "1em";
|
|
a.style.fontWeight = "bold";
|
|
example.parentElement.insertBefore(a, example)
|
|
});
|
|
// If the current URL ends with -example.html, we can add a link to the demo
|
|
// as well using the div.title textContent.
|
|
const url = new URL(window.location.href);
|
|
if (url.pathname.endsWith("-example.html")) {
|
|
// Get the title text.
|
|
const title = document.querySelector("div.title").textContent;
|
|
const example = title.replace("examples/", "").replace(".cpp", "");
|
|
// Create a link to the demo.
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + example;
|
|
a.style.marginLeft = "1em";
|
|
a.style.fontWeight = "bold";
|
|
a.style.display = "inline-block";
|
|
// Insert the link after the title.
|
|
const titleDiv = document.querySelector("div.title");
|
|
if (titleDiv) {
|
|
titleDiv.insertBefore(a, titleDiv.nextSibling);
|
|
}
|
|
}
|
|
</script>
|
|
<script type="module">
|
|
// Click on the navtree, except for the main page where this is already done
|
|
// automatically.
|
|
let delay = 0;
|
|
while(true) {
|
|
const navtree = document.querySelector("div.item.selected");
|
|
if (!navtree) {
|
|
delay *= 2;
|
|
delay += 1;
|
|
await new Promise(resolve => setTimeout(resolve, delay));
|
|
continue;
|
|
}
|
|
// Include only selected navtree items.
|
|
console.log("navtree.textContent", navtree.textContent);
|
|
if (!navtree.textContent.includes("Getting Started") &&
|
|
!navtree.textContent.includes("Installation") &&
|
|
!navtree.textContent.includes("ftxui / screen") &&
|
|
!navtree.textContent.includes("ftxui / dom") &&
|
|
!navtree.textContent.includes("ftxui / component") &&
|
|
!navtree.textContent.includes("Reference")) {
|
|
break;
|
|
}
|
|
// Find the first link inside the navtree.
|
|
const link = navtree.querySelector("a");
|
|
if (link) {
|
|
// Simulate a click on the link.
|
|
link.click();
|
|
break;
|
|
}
|
|
}
|
|
</script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="stylesheet.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">FTXUI<span id="projectnumber"> 6.1.9</span>
|
|
</div>
|
|
<div id="projectbrief">C++ functional terminal UI.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classftxui_1_1CapturedMouseInterface.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classftxui_1_1CapturedMouseInterface-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">CapturedMouseInterface Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="captured__mouse_8hpp_source.html">captured_mouse.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:abc72c038150d1866199c28dffe7ace7b" id="r_abc72c038150d1866199c28dffe7ace7b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc72c038150d1866199c28dffe7ace7b">CapturedMouseInterface</a> ()=default</td></tr>
|
|
<tr class="separator:abc72c038150d1866199c28dffe7ace7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb21b580f6362d9f5f4d25c6b8ca54cb" id="r_abb21b580f6362d9f5f4d25c6b8ca54cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abb21b580f6362d9f5f4d25c6b8ca54cb">CapturedMouseInterface</a> (const <a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &)=default</td></tr>
|
|
<tr class="separator:abb21b580f6362d9f5f4d25c6b8ca54cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f92bdd8e2c098ade383916b8e47b7e0" id="r_a2f92bdd8e2c098ade383916b8e47b7e0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f92bdd8e2c098ade383916b8e47b7e0">CapturedMouseInterface</a> (<a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &&)=delete</td></tr>
|
|
<tr class="separator:a2f92bdd8e2c098ade383916b8e47b7e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfa362c249253f9570e5c1cf42fc16c3" id="r_adfa362c249253f9570e5c1cf42fc16c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#adfa362c249253f9570e5c1cf42fc16c3">operator=</a> (const <a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &)=default</td></tr>
|
|
<tr class="separator:adfa362c249253f9570e5c1cf42fc16c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac349c4e493dbe8aa7c47052d91e0f411" id="r_ac349c4e493dbe8aa7c47052d91e0f411"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac349c4e493dbe8aa7c47052d91e0f411">operator=</a> (<a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &&)=delete</td></tr>
|
|
<tr class="separator:ac349c4e493dbe8aa7c47052d91e0f411"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af35148d7f798953f8d7e8c1a0e2b2ef0" id="r_af35148d7f798953f8d7e8c1a0e2b2ef0"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#af35148d7f798953f8d7e8c1a0e2b2ef0">~CapturedMouseInterface</a> ()=default</td></tr>
|
|
<tr class="separator:af35148d7f798953f8d7e8c1a0e2b2ef0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="captured__mouse_8hpp_source.html#l00011">11</a> of file <a class="el" href="captured__mouse_8hpp_source.html">captured_mouse.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="abc72c038150d1866199c28dffe7ace7b" name="abc72c038150d1866199c28dffe7ace7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc72c038150d1866199c28dffe7ace7b">◆ </a></span>CapturedMouseInterface() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb21b580f6362d9f5f4d25c6b8ca54cb" name="abb21b580f6362d9f5f4d25c6b8ca54cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb21b580f6362d9f5f4d25c6b8ca54cb">◆ </a></span>CapturedMouseInterface() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f92bdd8e2c098ade383916b8e47b7e0" name="a2f92bdd8e2c098ade383916b8e47b7e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f92bdd8e2c098ade383916b8e47b7e0">◆ </a></span>CapturedMouseInterface() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af35148d7f798953f8d7e8c1a0e2b2ef0" name="af35148d7f798953f8d7e8c1a0e2b2ef0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af35148d7f798953f8d7e8c1a0e2b2ef0">◆ </a></span>~CapturedMouseInterface()</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="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="adfa362c249253f9570e5c1cf42fc16c3" name="adfa362c249253f9570e5c1cf42fc16c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfa362c249253f9570e5c1cf42fc16c3">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> & operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac349c4e493dbe8aa7c47052d91e0f411" name="ac349c4e493dbe8aa7c47052d91e0f411"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac349c4e493dbe8aa7c47052d91e0f411">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> & operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="captured__mouse_8hpp_source.html">captured_mouse.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.9.8-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|