| <!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.13.2"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>libguac-terminal: guac_terminal_options Struct 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="clipboard.js"></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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { init_search(); }); |
| /* @license-end */ |
| </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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">libguac-terminal<span id="projectnumber"> 1.6.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.13.2 --> |
| <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> |
| </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('structguac__terminal__options.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-attribs">Data Fields</a> </div> |
| <div class="headertitle"><div class="title">guac_terminal_options Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Configuration options that may be passed when creating a new <a class="el" href="terminal_8h.html#a49f29d5b500f0d3089e85e0b00903030" title="Represents a terminal emulator which uses a given Guacamole client to render itself.">guac_terminal</a>. |
| <a href="#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="terminal_8h_source.html">terminal.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
| <tr class="memitem:ae2b4ce16e638e2a3ba7af2dd2fadd8dc" id="r_ae2b4ce16e638e2a3ba7af2dd2fadd8dc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2b4ce16e638e2a3ba7af2dd2fadd8dc">disable_copy</a></td></tr> |
| <tr class="memdesc:ae2b4ce16e638e2a3ba7af2dd2fadd8dc"><td class="mdescLeft"> </td><td class="mdescRight">Whether copying from the terminal clipboard should be blocked. <br /></td></tr> |
| <tr class="separator:ae2b4ce16e638e2a3ba7af2dd2fadd8dc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5bd6f6ae368ce6091a4d5d6ae3ddb53" id="r_aa5bd6f6ae368ce6091a4d5d6ae3ddb53"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5bd6f6ae368ce6091a4d5d6ae3ddb53">max_scrollback</a></td></tr> |
| <tr class="memdesc:aa5bd6f6ae368ce6091a4d5d6ae3ddb53"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of rows to allow within the scrollback buffer. <br /></td></tr> |
| <tr class="separator:aa5bd6f6ae368ce6091a4d5d6ae3ddb53"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aecdc7015e0d19b2e9b882ea0f1f1cf7b" id="r_aecdc7015e0d19b2e9b882ea0f1f1cf7b"><td class="memItemLeft" align="right" valign="top"><a id="aecdc7015e0d19b2e9b882ea0f1f1cf7b" name="aecdc7015e0d19b2e9b882ea0f1f1cf7b"></a> |
| char * </td><td class="memItemRight" valign="bottom"><b>font_name</b></td></tr> |
| <tr class="memdesc:aecdc7015e0d19b2e9b882ea0f1f1cf7b"><td class="mdescLeft"> </td><td class="mdescRight">The name of the font to use when rendering glyphs. <br /></td></tr> |
| <tr class="separator:aecdc7015e0d19b2e9b882ea0f1f1cf7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa399b8a3a47e08607d1cb05db68ce674" id="r_aa399b8a3a47e08607d1cb05db68ce674"><td class="memItemLeft" align="right" valign="top"><a id="aa399b8a3a47e08607d1cb05db68ce674" name="aa399b8a3a47e08607d1cb05db68ce674"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>font_size</b></td></tr> |
| <tr class="memdesc:aa399b8a3a47e08607d1cb05db68ce674"><td class="mdescLeft"> </td><td class="mdescRight">The size of each glyph, in points. <br /></td></tr> |
| <tr class="separator:aa399b8a3a47e08607d1cb05db68ce674"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1941b862eab4c8aefe7c600fcdd49e9e" id="r_a1941b862eab4c8aefe7c600fcdd49e9e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1941b862eab4c8aefe7c600fcdd49e9e">dpi</a></td></tr> |
| <tr class="memdesc:a1941b862eab4c8aefe7c600fcdd49e9e"><td class="mdescLeft"> </td><td class="mdescRight">The DPI of the display. <br /></td></tr> |
| <tr class="separator:a1941b862eab4c8aefe7c600fcdd49e9e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a2e49882c2844ea57f0752ac5764016" id="r_a6a2e49882c2844ea57f0752ac5764016"><td class="memItemLeft" align="right" valign="top"><a id="a6a2e49882c2844ea57f0752ac5764016" name="a6a2e49882c2844ea57f0752ac5764016"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>width</b></td></tr> |
| <tr class="memdesc:a6a2e49882c2844ea57f0752ac5764016"><td class="mdescLeft"> </td><td class="mdescRight">The width of the terminal, in pixels. <br /></td></tr> |
| <tr class="separator:a6a2e49882c2844ea57f0752ac5764016"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a21f744aaf4f034a3cec4d321ce8fce5f" id="r_a21f744aaf4f034a3cec4d321ce8fce5f"><td class="memItemLeft" align="right" valign="top"><a id="a21f744aaf4f034a3cec4d321ce8fce5f" name="a21f744aaf4f034a3cec4d321ce8fce5f"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>height</b></td></tr> |
| <tr class="memdesc:a21f744aaf4f034a3cec4d321ce8fce5f"><td class="mdescLeft"> </td><td class="mdescRight">The height of the terminal, in pixels. <br /></td></tr> |
| <tr class="separator:a21f744aaf4f034a3cec4d321ce8fce5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a13c286dc09328bdcfea511c40eb776" id="r_a2a13c286dc09328bdcfea511c40eb776"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a13c286dc09328bdcfea511c40eb776">color_scheme</a></td></tr> |
| <tr class="memdesc:a2a13c286dc09328bdcfea511c40eb776"><td class="mdescLeft"> </td><td class="mdescRight">The name of the color scheme to use. <br /></td></tr> |
| <tr class="separator:a2a13c286dc09328bdcfea511c40eb776"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a49e8dc2b85989a0a769c74518ad7260d" id="r_a49e8dc2b85989a0a769c74518ad7260d"><td class="memItemLeft" align="right" valign="top"><a id="a49e8dc2b85989a0a769c74518ad7260d" name="a49e8dc2b85989a0a769c74518ad7260d"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>backspace</b></td></tr> |
| <tr class="memdesc:a49e8dc2b85989a0a769c74518ad7260d"><td class="mdescLeft"> </td><td class="mdescRight">The integer ASCII code to send when backspace is pressed in the terminal. <br /></td></tr> |
| <tr class="separator:a49e8dc2b85989a0a769c74518ad7260d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Configuration options that may be passed when creating a new <a class="el" href="terminal_8h.html#a49f29d5b500f0d3089e85e0b00903030" title="Represents a terminal emulator which uses a given Guacamole client to render itself.">guac_terminal</a>. </p> |
| <p>Note that <a class="el" href="structguac__terminal__options.html" title="Configuration options that may be passed when creating a new guac_terminal.">guac_terminal_options</a> should not be instantiated directly - to create a new options struct, use guac_terminal_options_create. </p> |
| </div><h2 class="groupheader">Field Documentation</h2> |
| <a id="a2a13c286dc09328bdcfea511c40eb776" name="a2a13c286dc09328bdcfea511c40eb776"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a13c286dc09328bdcfea511c40eb776">◆ </a></span>color_scheme</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char* guac_terminal_options::color_scheme</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The name of the color scheme to use. </p> |
| <p>This string must be in the format accepted by guac_terminal_parse_color_scheme(). </p> |
| |
| </div> |
| </div> |
| <a id="ae2b4ce16e638e2a3ba7af2dd2fadd8dc" name="ae2b4ce16e638e2a3ba7af2dd2fadd8dc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae2b4ce16e638e2a3ba7af2dd2fadd8dc">◆ </a></span>disable_copy</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool guac_terminal_options::disable_copy</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Whether copying from the terminal clipboard should be blocked. </p> |
| <p>If set, the contents of the terminal can still be copied, but will be usable only within the terminal itself. The clipboard contents will not be automatically streamed to the client. </p> |
| |
| </div> |
| </div> |
| <a id="a1941b862eab4c8aefe7c600fcdd49e9e" name="a1941b862eab4c8aefe7c600fcdd49e9e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1941b862eab4c8aefe7c600fcdd49e9e">◆ </a></span>dpi</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_terminal_options::dpi</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The DPI of the display. </p> |
| <p>The given font size will be adjusted to produce glyphs at the given DPI. </p> |
| |
| </div> |
| </div> |
| <a id="aa5bd6f6ae368ce6091a4d5d6ae3ddb53" name="aa5bd6f6ae368ce6091a4d5d6ae3ddb53"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5bd6f6ae368ce6091a4d5d6ae3ddb53">◆ </a></span>max_scrollback</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_terminal_options::max_scrollback</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The maximum number of rows to allow within the scrollback buffer. </p> |
| <p>The user may still alter the size of the scrollback buffer using terminal codes, however the size can never exceed the maximum size given here. Note that this space is shared with the display, with the scrollable area actually only containing the given number of rows less the number of rows currently displayed, and sufficient buffer space will always be allocated to represent the display area of the terminal regardless of the value given here. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>terminal/<a class="el" href="terminal_8h_source.html">terminal.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="structguac__terminal__options.html">guac_terminal_options</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.13.2 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
