PageRenderTime 50ms CodeModel.GetById 11ms RepoModel.GetById 0ms app.codeStats 1ms

/source/python-api/api.html

https://github.com/gnachman/iterm2-website
HTML | 197 lines | 166 code | 29 blank | 2 comment | 0 complexity | f49988621d718fec64bbb2e77e72476b MD5 | raw file
    

  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     <title>iTerm2 Python API Class Reference &#8212; iTerm2 Python API 0.26 documentation</title>
    10. 

  10.     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    12. 

  12.     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    13. 

  13.     <script type="text/javascript" src="_static/jquery.js"></script>
    14. 

  14.     <script type="text/javascript" src="_static/underscore.js"></script>
    15. 

  15.     <script type="text/javascript" src="_static/doctools.js"></script>
    16. 

  16.     <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    17. 

  17.     <link rel="index" title="Index" href="genindex.html" />
    18. 

  18.     <link rel="search" title="Search" href="search.html" />
    19. 

  19.     <meta name="HandheldFriendly" content="True">
    20. 

  20.     <meta name="MobileOptimized" content="320">
    21. 

  21.     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    22. 

  22. 

  23.   </head><body>
    24. 

  24.   <header >
    25. 

  25.     <div class="row">
    26. 

  26.       <div class="small-12 medium-12 large-10 large-centered columns wide-row">
    27. 

  27.         <div class="text-center"><a href="/index.html"><img src="https://iterm2.com/img/logo2x.jpg" width=800 height=312></a></div>
    28. 

  28.         <div class="sticky contain-to-grid">
    29. 

  29.           <nav class="top-bar" data-topbar>
    30. 

  30.             <ul class="title-area">
    31. 

  31.               <li class="name">
    32. 

  32. 

  33.               </li>
    34. 

  34.               <li class="toggle-topbar menu-icon"><a href="#">Menu</a></li>
    35. 

  35.               <li class="small-screen-donate">
    36. 

  36. 		  <a href="/donate.html"><img src="https://iterm2.com/images/DonateButton.png" width="92" height="26"></a>
    37. 

  37.                 </li>
    38. 

  38.             </ul>
    39. 

  39. 

  40.             <section class="top-bar-section">
    41. 

  41.               <!-- Right Nav Section -->
    42. 

  42.               <ul class="right"> <li>
    43. 

  43. 		  <a href="/donate.html"><img src="https://iterm2.com/images/DonateButton.png" width="92" height="26"></a>
    44. 

  44.                 </li>
    45. 

  45.               </ul>
    46. 

  46.             </li>
    47. 

  47.           </ul>
    48. 

  48. 

  49.           <!-- Left Nav Section -->
    50. 

  50.           <ul class="left">
    51. 

  51.             <li><a href="/index.html">Home</a></li>
    52. 

  52.             <li ><a href="/news.html">News</a></li>
    53. 

  53.             <li ><a href="/features.html">Features</a></li>
    54. 

  54.             <li ><a href="/faq.html">FAQ</a></li>
    55. 

  55.             <li class="active"><a href="/documentation.html">Documentation</a></li>
    56. 

  56.             <li ><a href="/downloads.html">Downloads</a></li>
    57. 

  57.           </ul>
    58. 

  58.         </section>
    59. 

  59.       </nav>
    60. 

  60.     </div>
    61. 

  61.   </div>
    62. 

  62. </div>
    63. 

  63. </header>
    64. 

  64. 

  65. 

  66. 

  67. 

  68.     <div class="document">
    69. 

  69. <div class="row">
    70. 

  70.   <div class="small-12 medium-12 large-10 large-centered columns wide-row">
    71. 

  71.     <div class="main panel">
    72. 

  72. 

  73.       <div class="doc-wrapper">
    74. 

  74. 	<a href="#" data-dropdown="drop-menu">Table of Contents</a>
    75. 

  75. 	<div id="drop-menu" data-dropdown-content class="f-dropdown content">
    76. 

  76. 	  <div class="inner-menu">
    77. 

  77. 	    <ul class="sub-nav">
    78. 

  78. 	      <div class="toc_subhead">iTerm2</div>
    79. 

  79. 

  80. 	      <li><a href="/documentation.html">iTerm2 Documentation</a></li>
    81. 

  81. 

  82. 	      <div class="toc_subhead">Python API</div>
    83. 

  83. 

  84. 	      <li><a href="/python-api">Python API</a></li>
    85. 

  85. 	      <li><a href="/python-api/tutorial/index.html">Tutorial</a></li>
    86. 

  86. 	      <li><a href="/python-api/examples/index.html">Examples</a></li>
    87. 

  87. 

  88. 	    </ul>
    89. 

  89. 	  </div>
    90. 

  90. 	</div>
    91. 

  91.       </div>
    92. 

  92. 

  93. <hr/>
    94. 

  94. 

  95.       <div class="documentwrapper">
    96. 

  96. 	<div class="bodywrapper">
    97. 

  97. 	  <div class="body" role="main">
    98. 

  98. 	    
    99. 

  99.   <div class="section" id="iterm2-python-api-class-reference">
    100. 

  100. <h1>iTerm2 Python API Class Reference<a class="headerlink" href="#iterm2-python-api-class-reference" title="Permalink to this headline"></a></h1>
    101. 

  101. <div class="toctree-wrapper compound">
    102. 

  102. <p class="caption"><span class="caption-text">Contents:</span></p>
    103. 

  103. <ul>
    104. 

  104. <li class="toctree-l1"><a class="reference internal" href="app.html">App</a><ul>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="app.html#indices-and-tables">Indices and tables</a></li>
    106. 

  106. </ul>
    107. 

  107. </li>
    108. 

  108. <li class="toctree-l1"><a class="reference internal" href="connection.html">Connection</a><ul>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="connection.html#indices-and-tables">Indices and tables</a></li>
    110. 

  110. </ul>
    111. 

  111. </li>
    112. 

  112. <li class="toctree-l1"><a class="reference internal" href="notifications.html">Notifications</a><ul>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="notifications.html#indices-and-tables">Indices and tables</a></li>
    114. 

  114. </ul>
    115. 

  115. </li>
    116. 

  116. <li class="toctree-l1"><a class="reference internal" href="profile.html">Profile</a><ul>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="profile.html#indices-and-tables">Indices and tables</a></li>
    118. 

  118. </ul>
    119. 

  119. </li>
    120. 

  120. <li class="toctree-l1"><a class="reference internal" href="session.html">Session</a><ul>
    121. 

  121. <li class="toctree-l2"><a class="reference internal" href="session.html#indices-and-tables">Indices and tables</a></li>
    122. 

  122. </ul>
    123. 

  123. </li>
    124. 

  124. <li class="toctree-l1"><a class="reference internal" href="tab.html">Tab</a><ul>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="tab.html#indices-and-tables">Indices and tables</a></li>
    126. 

  126. </ul>
    127. 

  127. </li>
    128. 

  128. <li class="toctree-l1"><a class="reference internal" href="tool.html">Tool</a><ul>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="tool.html#indices-and-tables">Indices and tables</a></li>
    130. 

  130. </ul>
    131. 

  131. </li>
    132. 

  132. <li class="toctree-l1"><a class="reference internal" href="transaction.html">Transaction</a><ul>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="transaction.html#indices-and-tables">Indices and tables</a></li>
    134. 

  134. </ul>
    135. 

  135. </li>
    136. 

  136. <li class="toctree-l1"><a class="reference internal" href="util.html">Utilities</a><ul>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="util.html#indices-and-tables">Indices and tables</a></li>
    138. 

  138. </ul>
    139. 

  139. </li>
    140. 

  140. <li class="toctree-l1"><a class="reference internal" href="window.html">Window</a><ul>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="window.html#indices-and-tables">Indices and tables</a></li>
    142. 

  142. </ul>
    143. 

  143. </li>
    144. 

  144. </ul>
    145. 

  145. </div>
    146. 

  146. </div>
    147. 

  147. <hr class="docutils" />
    148. 

  148. <div class="section" id="indices-and-tables">
    149. 

  149. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
    150. 

  150. <ul class="simple">
    151. 

  151. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
    152. 

  152. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
    153. 

  153. </ul>
    154. 

  154. </div>
    155. 

  155. 

  156. 

  157. 	  </div>
    158. 

  158. 	</div>
    159. 

  159.       </div>
    160. 

  160.     </div>
    161. 

  161.   </div>
    162. 

  162. </div>
    163. 

  163. 

  164. <script src="https://iterm2.com/js/scripts.js"></script>                
    165. 

  165. <script type="text/javascript">
    166. 

  166.   function showId(id) {
    167. 

  167.     document.getElementById("changelist" + id).style.display = 'block';
    168. 

  168.     document.getElementById("show" + id).style.display = 'none';
    169. 

  169.     document.getElementById("hide" + id).style.display = 'inline';
    170. 

  170.   }
    171. 

  171. 

  172.   function hideId(id) {
    173. 

  173.     document.getElementById("changelist" + id).style.display = 'none';
    174. 

  174.     document.getElementById("show" + id).style.display = 'inline';
    175. 

  175.     document.getElementById("hide" + id).style.display = 'none';
    176. 

  176.   }
    177. 

  177.   $(document).foundation();
    178. 

  178. </script>
    179. 

  179.       <div class="clearer"></div>
    180. 

  180.     </div>
    181. 

  181.     <div class="footer">
    182. 

  182.       &copy;2018, George Nachman.
    183. 

  183.       
    184. 

  184.       |
    185. 

  185.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.1</a>
    186. 

  186.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
    187. 

  187.       
    188. 

  188.       |
    189. 

  189.       <a href="_sources/api.rst.txt"
    190. 

  190.           rel="nofollow">Page source</a>
    191. 

  191.     </div>
    192. 

  192. 

  193.     
    194. 

  194. 

  195.     
    196. 

  196.   </body>
    197. 

  197. </html>
    198.