PageRenderTime 51ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/source/python-api/examples/current_preset.html

https://github.com/gnachman/iterm2-website
HTML | 171 lines | 135 code | 33 blank | 3 comment | 0 complexity | 84f5ebe7082752bd7053cec3babd9aa2 MD5 | raw file
    

  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. 

  5. <html>
    6. 

  6.   <head>
    7. 

  7.     <meta charset="utf-8" />
    8. 

  8.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
    9. 

  9. 

  10.     <title>Get Selected Color Preset &#8212; iTerm2 Python API 0.26 documentation</title>
    11. 

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

  12.     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
    13. 

  13.     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    14. 

  14.     <script src="../_static/jquery.js"></script>
    15. 

  15.     <script src="../_static/underscore.js"></script>
    16. 

  16.     <script src="../_static/doctools.js"></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" style="text-align: right">
    74. 

  74.                 <a href="/documentation">Documentation</a> | <a href="/python-api">Python API</a>
    75. 

  75.             </div>
    76. 

  76. 

  77.             <hr/>
    78. 

  78. 

  79.       <div class="documentwrapper">
    80. 

  80. 	<div class="bodywrapper">
    81. 

  81. 	  <div class="body" role="main">
    82. 

  82. 	    
    83. 

  83.   <section id="get-selected-color-preset">
    84. 

  84. <span id="current-preset-example"></span><h1>Get Selected Color Preset<a class="headerlink" href="#get-selected-color-preset" title="Permalink to this headline">ΒΆ</a></h1>
    85. 

  85. <p>This script prints to stdout the name of the color preset the current
    86. 

  86. sesssion is using, or <cite>None</cite> if none of them matches.</p>
    87. 

  87. <p>To see the output you can either run <cite>pip3 install iterm2</cite> and then execute
    88. 

  88. this script from the command line or run it from the <strong>Scripts</strong> menu and view
    89. 

  89. the output in the <strong>Script Console</strong>.</p>
    90. 

  90. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
    91. 

  91. 

  92. <span class="kn">import</span> <span class="nn">iterm2</span>
    93. 

  93. 

  94. <span class="k">def</span> <span class="nf">ColorsUnequal</span><span class="p">(</span><span class="n">profile_color</span><span class="p">,</span> <span class="n">preset_color</span><span class="p">):</span>
    95. 

  95.     <span class="k">return</span> <span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">profile_color</span><span class="o">.</span><span class="n">red</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">round</span><span class="p">(</span><span class="n">preset_color</span><span class="o">.</span><span class="n">red</span><span class="p">)</span> <span class="ow">or</span>
    96. 

  96.             <span class="nb">round</span><span class="p">(</span><span class="n">profile_color</span><span class="o">.</span><span class="n">green</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">round</span><span class="p">(</span><span class="n">preset_color</span><span class="o">.</span><span class="n">green</span><span class="p">)</span> <span class="ow">or</span>
    97. 

  97.             <span class="nb">round</span><span class="p">(</span><span class="n">profile_color</span><span class="o">.</span><span class="n">blue</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">round</span><span class="p">(</span><span class="n">preset_color</span><span class="o">.</span><span class="n">blue</span><span class="p">)</span> <span class="ow">or</span>
    98. 

  98.             <span class="nb">round</span><span class="p">(</span><span class="n">profile_color</span><span class="o">.</span><span class="n">alpha</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">round</span><span class="p">(</span><span class="n">preset_color</span><span class="o">.</span><span class="n">alpha</span><span class="p">)</span> <span class="ow">or</span>
    99. 

  99.             <span class="n">profile_color</span><span class="o">.</span><span class="n">color_space</span> <span class="o">!=</span> <span class="n">preset_color</span><span class="o">.</span><span class="n">color_space</span><span class="p">)</span>
    100. 

  100. 

  101. <span class="k">def</span> <span class="nf">ProfileUsesPreset</span><span class="p">(</span><span class="n">profile</span><span class="p">,</span> <span class="n">preset</span><span class="p">):</span>
    102. 

  102.     <span class="k">for</span> <span class="n">preset_color</span> <span class="ow">in</span> <span class="n">preset</span><span class="o">.</span><span class="n">values</span><span class="p">:</span>
    103. 

  103.         <span class="n">key</span> <span class="o">=</span> <span class="n">preset_color</span><span class="o">.</span><span class="n">key</span>
    104. 

  104.         <span class="n">profile_color</span> <span class="o">=</span> <span class="n">profile</span><span class="o">.</span><span class="n">get_color_with_key</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
    105. 

  105.         <span class="k">if</span> <span class="n">ColorsUnequal</span><span class="p">(</span><span class="n">profile_color</span><span class="p">,</span> <span class="n">preset_color</span><span class="p">):</span>
    106. 

  106.             <span class="k">return</span> <span class="kc">False</span>
    107. 

  107.     <span class="k">return</span> <span class="kc">True</span>
    108. 

  108. 

  109. <span class="k">async</span> <span class="k">def</span> <span class="nf">PresetForProfile</span><span class="p">(</span><span class="n">connection</span><span class="p">,</span> <span class="n">profile</span><span class="p">):</span>
    110. 

  110.     <span class="n">presets</span><span class="o">=</span><span class="k">await</span> <span class="n">iterm2</span><span class="o">.</span><span class="n">ColorPreset</span><span class="o">.</span><span class="n">async_get_list</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
    111. 

  111.     <span class="k">for</span> <span class="n">preset_name</span> <span class="ow">in</span> <span class="n">presets</span><span class="p">:</span>
    112. 

  112.         <span class="n">preset</span><span class="o">=</span><span class="k">await</span> <span class="n">iterm2</span><span class="o">.</span><span class="n">ColorPreset</span><span class="o">.</span><span class="n">async_get</span><span class="p">(</span><span class="n">connection</span><span class="p">,</span> <span class="n">preset_name</span><span class="p">)</span>
    113. 

  113.         <span class="k">if</span> <span class="n">ProfileUsesPreset</span><span class="p">(</span><span class="n">profile</span><span class="p">,</span> <span class="n">preset</span><span class="p">):</span>
    114. 

  114.           <span class="k">return</span> <span class="n">preset_name</span>
    115. 

  115.     <span class="k">return</span> <span class="kc">None</span>
    116. 

  116. 

  117. 

  118. <span class="k">async</span> <span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">connection</span><span class="p">):</span>
    119. 

  119.     <span class="n">app</span> <span class="o">=</span> <span class="k">await</span> <span class="n">iterm2</span><span class="o">.</span><span class="n">async_get_app</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span>
    120. 

  120.     <span class="n">session</span><span class="o">=</span><span class="n">app</span><span class="o">.</span><span class="n">current_terminal_window</span><span class="o">.</span><span class="n">current_tab</span><span class="o">.</span><span class="n">current_session</span>
    121. 

  121.     <span class="n">profile</span><span class="o">=</span><span class="k">await</span> <span class="n">session</span><span class="o">.</span><span class="n">async_get_profile</span><span class="p">()</span>
    122. 

  122.     <span class="nb">print</span><span class="p">(</span><span class="k">await</span> <span class="n">PresetForProfile</span><span class="p">(</span><span class="n">connection</span><span class="p">,</span> <span class="n">profile</span><span class="p">))</span>
    123. 

  123. 

  124. <span class="n">iterm2</span><span class="o">.</span><span class="n">run_until_complete</span><span class="p">(</span><span class="n">main</span><span class="p">)</span>
    125. 

  125. </pre></div>
    126. 

  126. </div>
    127. 

  127. <p><a class="reference download internal" download="" href="../_downloads/8e01b8ccfa2ff9296bd955b7c2d3d767/current_preset.its"><code class="xref download docutils literal notranslate"><span class="pre">Download</span></code></a></p>
    128. 

  128. </section>
    129. 

  129. 

  130. 

  131. 	  </div>
    132. 

  132. 	</div>
    133. 

  133.       </div>
    134. 

  134.     </div>
    135. 

  135.   </div>
    136. 

  136. </div>
    137. 

  137. 

  138. <!-- Note: scripts.js not loaded because it breaks anchors, which Sphinx makes a lot of. -->
    139. 

  139. <script type="text/javascript">
    140. 

  140.   function showId(id) {
    141. 

  141.     document.getElementById("changelist" + id).style.display = 'block';
    142. 

  142.     document.getElementById("show" + id).style.display = 'none';
    143. 

  143.     document.getElementById("hide" + id).style.display = 'inline';
    144. 

  144.   }
    145. 

  145. 

  146.   function hideId(id) {
    147. 

  147.     document.getElementById("changelist" + id).style.display = 'none';
    148. 

  148.     document.getElementById("show" + id).style.display = 'inline';
    149. 

  149.     document.getElementById("hide" + id).style.display = 'none';
    150. 

  150.   }
    151. 

  151.   $(document).foundation();
    152. 

  152. </script>
    153. 

  153.       <div class="clearer"></div>
    154. 

  154.     </div>
    155. 

  155.     <div class="footer">
    156. 

  156.       &copy;2018, George Nachman.
    157. 

  157.       
    158. 

  158.       |
    159. 

  159.       Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.3</a>
    160. 

  160.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    161. 

  161.       
    162. 

  162.       |
    163. 

  163.       <a href="../_sources/examples/current_preset.rst.txt"
    164. 

  164.           rel="nofollow">Page source</a>
    165. 

  165.     </div>
    166. 

  166. 

  167.     
    168. 

  168. 

  169.     
    170. 

  170.   </body>
    171. 

  171. </html>
    172.