joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/namespacesf_1_1Clipboard.html

219 lines
15 KiB
HTML
Raw Blame History

<!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>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="namespacesf_1_1Clipboard.html">Clipboard</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sf::Clipboard Namespace Reference<div class="ingroups"><a class="el" href="group__window.html">Window module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Give access to the system clipboard.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5ffa170c4fa8674b90725936412b79aa" id="r_a5ffa170c4fa8674b90725936412b79aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ffa170c4fa8674b90725936412b79aa">getString</a> ()</td></tr>
<tr class="memdesc:a5ffa170c4fa8674b90725936412b79aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the content of the clipboard as string data. <br /></td></tr>
<tr class="separator:a5ffa170c4fa8674b90725936412b79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ab898e1e6498c0312f24ff50aa2ccb3" id="r_a5ab898e1e6498c0312f24ff50aa2ccb3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ab898e1e6498c0312f24ff50aa2ccb3">setString</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;text)</td></tr>
<tr class="memdesc:a5ab898e1e6498c0312f24ff50aa2ccb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the content of the clipboard as string data. <br /></td></tr>
<tr class="separator:a5ab898e1e6498c0312f24ff50aa2ccb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Give access to the system clipboard. </p>
<p><code><a class="el" href="namespacesf_1_1Clipboard.html" title="Give access to the system clipboard.">sf::Clipboard</a></code> provides an interface for getting and setting the contents of the system clipboard.</p>
<p>It is important to note that due to limitations on some operating systems, setting the clipboard contents is only guaranteed to work if there is currently an open window for which events are being handled.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// get the clipboard content as a string</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1String.html">sf::String</a> <span class="keywordtype">string</span> = <a class="code hl_function" href="#a5ffa170c4fa8674b90725936412b79aa">sf::Clipboard::getString</a>();</div>
<div class="line"> </div>
<div class="line"><span class="comment">// or use it in the event loop</span></div>
<div class="line"><span class="keywordflow">while</span> (<span class="keyword">const</span> std::optional event = window.pollEvent())</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">if</span> (event-&gt;is&lt;<a class="code hl_struct" href="structsf_1_1Event_1_1Closed.html">sf::Event::Closed</a>&gt;())</div>
<div class="line"> window.close();</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (<span class="keyword">const</span> <span class="keyword">auto</span>* keyPressed = event-&gt;getIf&lt;<a class="code hl_struct" href="structsf_1_1Event_1_1KeyPressed.html">sf::Event::KeyPressed</a>&gt;())</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// Using Ctrl + V to paste a string into SFML</span></div>
<div class="line"> <span class="keywordflow">if</span> (keyPressed-&gt;control &amp;&amp; keyPressed-&gt;code == <a class="code hl_enumvalue" href="namespacesf_1_1Keyboard.html#acb4cacd7cc5802dec45724cf3314a142a5206560a306a2e085a437fd258eb57ce">sf::Keyboard::Key::V</a>)</div>
<div class="line"> <span class="keywordtype">string</span> = <a class="code hl_function" href="#a5ffa170c4fa8674b90725936412b79aa">sf::Clipboard::getString</a>();</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Using Ctrl + C to copy a string out of SFML</span></div>
<div class="line"> <span class="keywordflow">if</span> (keyPressed-&gt;control &amp;&amp; keyPressed-&gt;code == <a class="code hl_enumvalue" href="namespacesf_1_1Keyboard.html#acb4cacd7cc5802dec45724cf3314a142a0d61f8370cad1d412f80b84d143e1257">sf::Keyboard::Key::C</a>)</div>
<div class="line"> <a class="code hl_function" href="#a5ab898e1e6498c0312f24ff50aa2ccb3">sf::Clipboard::setString</a>(<span class="stringliteral">&quot;Hello World!&quot;</span>);</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="ttc" id="aclasssf_1_1String_html"><div class="ttname"><a href="classsf_1_1String.html">sf::String</a></div><div class="ttdoc">Utility string class that automatically handles conversions between types and encodings.</div><div class="ttdef"><b>Definition</b> <a href="String_8hpp_source.html#l00088">String.hpp:89</a></div></div>
<div class="ttc" id="anamespacesf_1_1Clipboard_html_a5ab898e1e6498c0312f24ff50aa2ccb3"><div class="ttname"><a href="#a5ab898e1e6498c0312f24ff50aa2ccb3">sf::Clipboard::setString</a></div><div class="ttdeci">void setString(const String &amp;text)</div><div class="ttdoc">Set the content of the clipboard as string data.</div></div>
<div class="ttc" id="anamespacesf_1_1Clipboard_html_a5ffa170c4fa8674b90725936412b79aa"><div class="ttname"><a href="#a5ffa170c4fa8674b90725936412b79aa">sf::Clipboard::getString</a></div><div class="ttdeci">String getString()</div><div class="ttdoc">Get the content of the clipboard as string data.</div></div>
<div class="ttc" id="anamespacesf_1_1Keyboard_html_acb4cacd7cc5802dec45724cf3314a142a0d61f8370cad1d412f80b84d143e1257"><div class="ttname"><a href="namespacesf_1_1Keyboard.html#acb4cacd7cc5802dec45724cf3314a142a0d61f8370cad1d412f80b84d143e1257">sf::Keyboard::Key::C</a></div><div class="ttdeci">@ C</div><div class="ttdoc">The C key.</div></div>
<div class="ttc" id="anamespacesf_1_1Keyboard_html_acb4cacd7cc5802dec45724cf3314a142a5206560a306a2e085a437fd258eb57ce"><div class="ttname"><a href="namespacesf_1_1Keyboard.html#acb4cacd7cc5802dec45724cf3314a142a5206560a306a2e085a437fd258eb57ce">sf::Keyboard::Key::V</a></div><div class="ttdeci">@ V</div><div class="ttdoc">The V key.</div></div>
<div class="ttc" id="astructsf_1_1Event_1_1Closed_html"><div class="ttname"><a href="structsf_1_1Event_1_1Closed.html">sf::Event::Closed</a></div><div class="ttdoc">Closed event subtype.</div><div class="ttdef"><b>Definition</b> <a href="Event_8hpp_source.html#l00053">Event.hpp:54</a></div></div>
<div class="ttc" id="astructsf_1_1Event_1_1KeyPressed_html"><div class="ttname"><a href="structsf_1_1Event_1_1KeyPressed.html">sf::Event::KeyPressed</a></div><div class="ttdoc">Key pressed event subtype.</div><div class="ttdef"><b>Definition</b> <a href="Event_8hpp_source.html#l00095">Event.hpp:96</a></div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code>, <code><a class="el" href="classsf_1_1Event.html" title="Defines a system event and its parameters.">sf::Event</a></code> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a5ffa170c4fa8674b90725936412b79aa" name="a5ffa170c4fa8674b90725936412b79aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ffa170c4fa8674b90725936412b79aa">&#9670;&#160;</a></span>getString()</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="classsf_1_1String.html">String</a> sf::Clipboard::getString </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">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the content of the clipboard as string data. </p>
<p>This function returns the content of the clipboard as a string. If the clipboard does not contain string it returns an empty <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> object.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespacesf_1_1Clipboard.html" title="Give access to the system clipboard.">Clipboard</a> contents as <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> object </dd></dl>
</div>
</div>
<a id="a5ab898e1e6498c0312f24ff50aa2ccb3" name="a5ab898e1e6498c0312f24ff50aa2ccb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ab898e1e6498c0312f24ff50aa2ccb3">&#9670;&#160;</a></span>setString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Clipboard::setString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the content of the clipboard as string data. </p>
<p>This function sets the content of the clipboard as a string.</p>
<dl class="section warning"><dt>Warning</dt><dd>Due to limitations on some operating systems, setting the clipboard contents is only guaranteed to work if there is currently an open window for which events are being handled.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td><code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> containing the data to be sent to the clipboard </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink