← Back to branch summary

~stephen-j-boddy/terminator/bugfix-1318542-double-chars

« back to all changes in this revision

Viewing changes to doc/apidoc/_build/html/_modules/terminatorlib/plugins/activitywatch.html

  • Committer: Stephen Boddy
  • Date: 2015-08-08 02:11:30 UTC
  • Revision ID: stephen.j.boddy@gmail.com-20150808021130-9c1npu4gvenkcb1p
A manual has been added to Terminator
* Added source and generated html of manual, and API doc
* setup.py can install the manual (and by extension do can debuild)
* setup.py has (inactive) code for generating the html from the source
  but this will break if rtd theme is not available
* A few changes to doc strings to make the autodoc prettier
* Added help shortcut, by default F1 to open the local manual
* Added button to About tab to launch manual
* A couple of additional string to translate related to manual/help

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/apidoc/_build/html/_modules/terminatorlib/plugins/activitywatch.html
 
1
 
 
2
 
 
3
<!DOCTYPE html>
 
4
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 
5
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 
6
<head>
 
7
  <meta charset="utf-8">
 
8
  
 
9
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
10
  
 
11
  <title>terminatorlib.plugins.activitywatch &mdash; terminatorlib 0.98 documentation</title>
 
12
  
 
13
 
 
14
  
 
15
  
 
16
 
 
17
  
 
18
 
 
19
  
 
20
  
 
21
    
 
22
 
 
23
  
 
24
 
 
25
  
 
26
  
 
27
    <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
 
28
  
 
29
 
 
30
  
 
31
 
 
32
  
 
33
    <link rel="top" title="terminatorlib 0.98 documentation" href="../../../index.html"/>
 
34
        <link rel="up" title="Module code" href="../../index.html"/> 
 
35
 
 
36
  
 
37
  <script src="_static/js/modernizr.min.js"></script>
 
38
 
 
39
</head>
 
40
 
 
41
<body class="wy-body-for-nav" role="document">
 
42
 
 
43
  <div class="wy-grid-for-nav">
 
44
 
 
45
    
 
46
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 
47
      <div class="wy-side-nav-search">
 
48
        
 
49
 
 
50
        
 
51
          <a href="../../../index.html" class="icon icon-home"> terminatorlib
 
52
        
 
53
 
 
54
        
 
55
        </a>
 
56
 
 
57
        
 
58
<div role="search">
 
59
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
 
60
    <input type="text" name="q" placeholder="Search docs" />
 
61
    <input type="hidden" name="check_keywords" value="yes" />
 
62
    <input type="hidden" name="area" value="default" />
 
63
  </form>
 
64
</div>
 
65
 
 
66
        
 
67
      </div>
 
68
 
 
69
      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
70
        
 
71
          
 
72
          
 
73
              <ul>
 
74
<li class="toctree-l1"><a class="reference internal" href="../../../terminatorlib.html">terminatorlib package</a><ul>
 
75
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#subpackages">Subpackages</a><ul>
 
76
<li class="toctree-l3"><a class="reference internal" href="../../../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
 
77
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#submodules">Submodules</a></li>
 
78
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
 
79
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
 
80
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
 
81
</ul>
 
82
</li>
 
83
<li class="toctree-l3"><a class="reference internal" href="../../../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
 
84
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#submodules">Submodules</a></li>
 
85
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
 
86
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
 
87
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
 
88
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
 
89
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
 
90
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
 
91
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
 
92
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
 
93
</ul>
 
94
</li>
 
95
</ul>
 
96
</li>
 
97
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#submodules">Submodules</a></li>
 
98
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
 
99
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
 
100
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
 
101
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
 
102
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
 
103
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
 
104
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
 
105
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
 
106
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
 
107
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
 
108
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
 
109
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
 
110
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
 
111
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
 
112
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
 
113
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
 
114
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
 
115
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
 
116
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
 
117
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
 
118
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
 
119
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
 
120
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
 
121
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
 
122
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
 
123
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
 
124
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
 
125
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib">Module contents</a></li>
 
126
</ul>
 
127
</li>
 
128
</ul>
 
129
 
 
130
          
 
131
        
 
132
      </div>
 
133
      &nbsp;
 
134
    </nav>
 
135
 
 
136
    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
137
 
 
138
      
 
139
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 
140
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 
141
        <a href="../../../index.html">terminatorlib</a>
 
142
      </nav>
 
143
 
 
144
 
 
145
      
 
146
      <div class="wy-nav-content">
 
147
        <div class="rst-content">
 
148
          <div role="navigation" aria-label="breadcrumbs navigation">
 
149
  <ul class="wy-breadcrumbs">
 
150
    <li><a href="../../../index.html">Docs</a> &raquo;</li>
 
151
      
 
152
          <li><a href="../../index.html">Module code</a> &raquo;</li>
 
153
      
 
154
    <li>terminatorlib.plugins.activitywatch</li>
 
155
      <li class="wy-breadcrumbs-aside">
 
156
        
 
157
          
 
158
        
 
159
      </li>
 
160
  </ul>
 
161
  <hr/>
 
162
</div>
 
163
          <div role="main" class="document">
 
164
            
 
165
  <h1>Source code for terminatorlib.plugins.activitywatch</h1><div class="highlight"><pre>
 
166
<span class="c">#!/usr/bin/python</span>
 
167
<span class="c"># Terminator by Chris Jones &lt;cmsj@tenshu.net&gt;</span>
 
168
<span class="c"># GPL v2 only</span>
 
169
<span class="sd">&quot;&quot;&quot;activitywatch.py - Terminator Plugin to watch a terminal for activity&quot;&quot;&quot;</span>
 
170
 
 
171
<span class="kn">import</span> <span class="nn">time</span>
 
172
<span class="kn">import</span> <span class="nn">gtk</span>
 
173
<span class="kn">import</span> <span class="nn">gobject</span>
 
174
 
 
175
<span class="kn">from</span> <span class="nn">terminatorlib.config</span> <span class="kn">import</span> <span class="n">Config</span>
 
176
<span class="kn">import</span> <span class="nn">terminatorlib.plugin</span> <span class="kn">as</span> <span class="nn">plugin</span>
 
177
<span class="kn">from</span> <span class="nn">terminatorlib.translation</span> <span class="kn">import</span> <span class="n">_</span>
 
178
<span class="kn">from</span> <span class="nn">terminatorlib.util</span> <span class="kn">import</span> <span class="n">err</span><span class="p">,</span> <span class="n">dbg</span>
 
179
<span class="kn">from</span> <span class="nn">terminatorlib.version</span> <span class="kn">import</span> <span class="n">APP_NAME</span>
 
180
 
 
181
<span class="k">try</span><span class="p">:</span>
 
182
    <span class="kn">import</span> <span class="nn">pynotify</span>
 
183
    <span class="c"># Every plugin you want Terminator to load *must* be listed in &#39;AVAILABLE&#39;</span>
 
184
    <span class="c"># This is inside this try so we only make the plugin available if pynotify</span>
 
185
    <span class="c">#  is present on this computer.</span>
 
186
    <span class="n">AVAILABLE</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;ActivityWatch&#39;</span><span class="p">,</span> <span class="s">&#39;InactivityWatch&#39;</span><span class="p">]</span>
 
187
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
 
188
    <span class="n">err</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">&#39;ActivityWatch plugin unavailable: please install python-notify&#39;</span><span class="p">))</span>
 
189
 
 
190
<span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">()</span>
 
191
<span class="n">inactive_period</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">plugin_get</span><span class="p">(</span><span class="s">&#39;InactivityWatch&#39;</span><span class="p">,</span> <span class="s">&#39;inactive_period&#39;</span><span class="p">,</span>
 
192
                                        <span class="mf">10.0</span><span class="p">))</span>
 
193
<span class="n">watch_interval</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">plugin_get</span><span class="p">(</span><span class="s">&#39;InactivityWatch&#39;</span><span class="p">,</span> <span class="s">&#39;watch_interval&#39;</span><span class="p">,</span>
 
194
                                       <span class="mi">5000</span><span class="p">))</span>
 
195
<span class="n">hush_period</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">plugin_get</span><span class="p">(</span><span class="s">&#39;ActivityWatch&#39;</span><span class="p">,</span> <span class="s">&#39;hush_period&#39;</span><span class="p">,</span>
 
196
                                        <span class="mf">10.0</span><span class="p">))</span>
 
197
 
 
198
<div class="viewcode-block" id="ActivityWatch"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.ActivityWatch">[docs]</a><span class="k">class</span> <span class="nc">ActivityWatch</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">MenuItem</span><span class="p">):</span>
 
199
    <span class="sd">&quot;&quot;&quot;Add custom commands to the terminal menu&quot;&quot;&quot;</span>
 
200
    <span class="n">capabilities</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;terminal_menu&#39;</span><span class="p">]</span>
 
201
    <span class="n">watches</span> <span class="o">=</span> <span class="bp">None</span>
 
202
    <span class="n">last_notifies</span> <span class="o">=</span> <span class="bp">None</span>
 
203
    <span class="n">timers</span> <span class="o">=</span> <span class="bp">None</span>
 
204
 
 
205
<div class="viewcode-block" id="ActivityWatch.__init__"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.ActivityWatch.__init__">[docs]</a>    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
206
        <span class="n">plugin</span><span class="o">.</span><span class="n">MenuItem</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
207
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">:</span>
 
208
            <span class="bp">self</span><span class="o">.</span><span class="n">watches</span> <span class="o">=</span> <span class="p">{}</span>
 
209
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_notifies</span><span class="p">:</span>
 
210
            <span class="bp">self</span><span class="o">.</span><span class="n">last_notifies</span> <span class="o">=</span> <span class="p">{}</span>
 
211
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">timers</span><span class="p">:</span>
 
212
            <span class="bp">self</span><span class="o">.</span><span class="n">timers</span> <span class="o">=</span> <span class="p">{}</span>
 
213
 
 
214
        <span class="n">pynotify</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">APP_NAME</span><span class="o">.</span><span class="n">capitalize</span><span class="p">())</span>
 
215
</div>
 
216
<div class="viewcode-block" id="ActivityWatch.callback"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.ActivityWatch.callback">[docs]</a>    <span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">menuitems</span><span class="p">,</span> <span class="n">menu</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
217
        <span class="sd">&quot;&quot;&quot;Add our menu item to the menu&quot;&quot;&quot;</span>
 
218
        <span class="n">item</span> <span class="o">=</span> <span class="n">gtk</span><span class="o">.</span><span class="n">CheckMenuItem</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">&#39;Watch for _activity&#39;</span><span class="p">))</span>
 
219
        <span class="n">item</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">terminal</span><span class="p">))</span>
 
220
        <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">get_active</span><span class="p">():</span>
 
221
            <span class="n">item</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&quot;activate&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">unwatch</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
222
        <span class="k">else</span><span class="p">:</span>
 
223
            <span class="n">item</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&quot;activate&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">watch</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
224
        <span class="n">menuitems</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
225
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Menu item appended&#39;</span><span class="p">)</span>
 
226
</div>
 
227
<div class="viewcode-block" id="ActivityWatch.watch"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.ActivityWatch.watch">[docs]</a>    <span class="k">def</span> <span class="nf">watch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_widget</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
228
        <span class="sd">&quot;&quot;&quot;Watch a terminal&quot;&quot;&quot;</span>
 
229
        <span class="n">vte</span> <span class="o">=</span> <span class="n">terminal</span><span class="o">.</span><span class="n">get_vte</span><span class="p">()</span>
 
230
        <span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span> <span class="o">=</span> <span class="n">vte</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&#39;contents-changed&#39;</span><span class="p">,</span> 
 
231
                                             <span class="bp">self</span><span class="o">.</span><span class="n">notify</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
232
</div>
 
233
<div class="viewcode-block" id="ActivityWatch.unwatch"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.ActivityWatch.unwatch">[docs]</a>    <span class="k">def</span> <span class="nf">unwatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_widget</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
234
        <span class="sd">&quot;&quot;&quot;Stop watching a terminal&quot;&quot;&quot;</span>
 
235
        <span class="n">vte</span> <span class="o">=</span> <span class="n">terminal</span><span class="o">.</span><span class="n">get_vte</span><span class="p">()</span>
 
236
        <span class="n">vte</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
237
        <span class="k">del</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
238
</div>
 
239
<div class="viewcode-block" id="ActivityWatch.notify"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.ActivityWatch.notify">[docs]</a>    <span class="k">def</span> <span class="nf">notify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_vte</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
240
        <span class="sd">&quot;&quot;&quot;Notify that a terminal did something&quot;&quot;&quot;</span>
 
241
        <span class="n">show_notify</span> <span class="o">=</span> <span class="bp">False</span>
 
242
 
 
243
        <span class="c"># Don&#39;t notify if the user is already looking at this terminal.</span>
 
244
        <span class="k">if</span> <span class="n">terminal</span><span class="o">.</span><span class="n">vte</span><span class="o">.</span><span class="n">flags</span><span class="p">()</span> <span class="o">&amp;</span> <span class="n">gtk</span><span class="o">.</span><span class="n">HAS_FOCUS</span><span class="p">:</span>
 
245
            <span class="k">return</span> <span class="bp">True</span>
 
246
 
 
247
        <span class="n">note</span> <span class="o">=</span> <span class="n">pynotify</span><span class="o">.</span><span class="n">Notification</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">&#39;Terminator&#39;</span><span class="p">),</span> <span class="n">_</span><span class="p">(</span><span class="s">&#39;Activity in: </span><span class="si">%s</span><span class="s">&#39;</span><span class="p">)</span> <span class="o">%</span> 
 
248
                                  <span class="n">terminal</span><span class="o">.</span><span class="n">get_window_title</span><span class="p">(),</span> <span class="s">&#39;terminator&#39;</span><span class="p">)</span>
 
249
 
 
250
        <span class="n">this_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">gmtime</span><span class="p">())</span>
 
251
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_notifies</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">terminal</span><span class="p">):</span>
 
252
            <span class="n">show_notify</span> <span class="o">=</span> <span class="bp">True</span>
 
253
        <span class="k">else</span><span class="p">:</span>
 
254
            <span class="n">last_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_notifies</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span>
 
255
            <span class="k">if</span> <span class="n">this_time</span> <span class="o">-</span> <span class="n">last_time</span> <span class="o">&gt;</span> <span class="n">hush_period</span><span class="p">:</span>
 
256
                <span class="n">show_notify</span> <span class="o">=</span> <span class="bp">True</span>
 
257
 
 
258
        <span class="k">if</span> <span class="n">show_notify</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 
259
            <span class="n">note</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 
260
            <span class="bp">self</span><span class="o">.</span><span class="n">last_notifies</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span> <span class="o">=</span> <span class="n">this_time</span>
 
261
 
 
262
        <span class="k">return</span> <span class="bp">True</span>
 
263
</div></div>
 
264
<div class="viewcode-block" id="InactivityWatch"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch">[docs]</a><span class="k">class</span> <span class="nc">InactivityWatch</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">MenuItem</span><span class="p">):</span>
 
265
    <span class="sd">&quot;&quot;&quot;Add custom commands to notify when a terminal goes inactive&quot;&quot;&quot;</span>
 
266
    <span class="n">capabilities</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;terminal_menu&#39;</span><span class="p">]</span>
 
267
    <span class="n">watches</span> <span class="o">=</span> <span class="bp">None</span>
 
268
    <span class="n">last_activities</span> <span class="o">=</span> <span class="bp">None</span>
 
269
    <span class="n">timers</span> <span class="o">=</span> <span class="bp">None</span>
 
270
 
 
271
<div class="viewcode-block" id="InactivityWatch.__init__"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch.__init__">[docs]</a>    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
272
        <span class="n">plugin</span><span class="o">.</span><span class="n">MenuItem</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
273
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">:</span>
 
274
            <span class="bp">self</span><span class="o">.</span><span class="n">watches</span> <span class="o">=</span> <span class="p">{}</span>
 
275
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span><span class="p">:</span>
 
276
            <span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span> <span class="o">=</span> <span class="p">{}</span>
 
277
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">timers</span><span class="p">:</span>
 
278
            <span class="bp">self</span><span class="o">.</span><span class="n">timers</span> <span class="o">=</span> <span class="p">{}</span>
 
279
 
 
280
        <span class="n">pynotify</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">APP_NAME</span><span class="o">.</span><span class="n">capitalize</span><span class="p">())</span>
 
281
</div>
 
282
<div class="viewcode-block" id="InactivityWatch.callback"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch.callback">[docs]</a>    <span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">menuitems</span><span class="p">,</span> <span class="n">menu</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
283
        <span class="sd">&quot;&quot;&quot;Add our menu item to the menu&quot;&quot;&quot;</span>
 
284
        <span class="n">item</span> <span class="o">=</span> <span class="n">gtk</span><span class="o">.</span><span class="n">CheckMenuItem</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">&quot;Watch for _silence&quot;</span><span class="p">))</span>
 
285
        <span class="n">item</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">terminal</span><span class="p">))</span>
 
286
        <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">get_active</span><span class="p">():</span>
 
287
            <span class="n">item</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&quot;activate&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">unwatch</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
288
        <span class="k">else</span><span class="p">:</span>
 
289
            <span class="n">item</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&quot;activate&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">watch</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
290
        <span class="n">menuitems</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
291
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Menu items appended&#39;</span><span class="p">)</span>
 
292
</div>
 
293
<div class="viewcode-block" id="InactivityWatch.watch"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch.watch">[docs]</a>    <span class="k">def</span> <span class="nf">watch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_widget</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
294
        <span class="sd">&quot;&quot;&quot;Watch a terminal&quot;&quot;&quot;</span>
 
295
        <span class="n">vte</span> <span class="o">=</span> <span class="n">terminal</span><span class="o">.</span><span class="n">get_vte</span><span class="p">()</span>
 
296
        <span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span> <span class="o">=</span> <span class="n">vte</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&#39;contents-changed&#39;</span><span class="p">,</span>
 
297
                                             <span class="bp">self</span><span class="o">.</span><span class="n">reset_timer</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
298
        <span class="n">timeout_id</span> <span class="o">=</span> <span class="n">gobject</span><span class="o">.</span><span class="n">timeout_add</span><span class="p">(</span><span class="n">watch_interval</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_times</span><span class="p">,</span> <span class="n">terminal</span><span class="p">)</span>
 
299
        <span class="bp">self</span><span class="o">.</span><span class="n">timers</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span> <span class="o">=</span> <span class="n">timeout_id</span>
 
300
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;timer </span><span class="si">%s</span><span class="s"> added for </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span><span class="p">(</span><span class="n">timeout_id</span><span class="p">,</span> <span class="n">terminal</span><span class="p">))</span>
 
301
</div>
 
302
<div class="viewcode-block" id="InactivityWatch.unwatch"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch.unwatch">[docs]</a>    <span class="k">def</span> <span class="nf">unwatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_vte</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
303
        <span class="sd">&quot;&quot;&quot;Unwatch a terminal&quot;&quot;&quot;</span>
 
304
        <span class="n">vte</span> <span class="o">=</span> <span class="n">terminal</span><span class="o">.</span><span class="n">get_vte</span><span class="p">()</span>
 
305
        <span class="n">vte</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
306
        <span class="k">del</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">watches</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
307
        <span class="n">gobject</span><span class="o">.</span><span class="n">source_remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timers</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
308
        <span class="k">del</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timers</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
309
</div>
 
310
<div class="viewcode-block" id="InactivityWatch.reset_timer"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch.reset_timer">[docs]</a>    <span class="k">def</span> <span class="nf">reset_timer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_vte</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
311
        <span class="sd">&quot;&quot;&quot;Reset the last-changed time for a terminal&quot;&quot;&quot;</span>
 
312
        <span class="n">time_now</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">gmtime</span><span class="p">())</span>
 
313
        <span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_now</span>
 
314
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;reset activity time for </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">terminal</span><span class="p">)</span>
 
315
</div>
 
316
<div class="viewcode-block" id="InactivityWatch.check_times"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.activitywatch.InactivityWatch.check_times">[docs]</a>    <span class="k">def</span> <span class="nf">check_times</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">terminal</span><span class="p">):</span>
 
317
        <span class="sd">&quot;&quot;&quot;Check if this terminal has gone silent&quot;&quot;&quot;</span>
 
318
        <span class="n">time_now</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">gmtime</span><span class="p">())</span>
 
319
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">terminal</span><span class="p">):</span>
 
320
            <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Terminal </span><span class="si">%s</span><span class="s"> has no last activity&#39;</span> <span class="o">%</span> <span class="n">terminal</span><span class="p">)</span>
 
321
            <span class="k">return</span> <span class="bp">True</span>
 
322
 
 
323
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;seconds since last activity: </span><span class="si">%f</span><span class="s"> (</span><span class="si">%s</span><span class="s">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">time_now</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span><span class="p">[</span><span class="n">terminal</span><span class="p">],</span> <span class="n">terminal</span><span class="p">))</span>
 
324
        <span class="k">if</span> <span class="n">time_now</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span><span class="p">[</span><span class="n">terminal</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="n">inactive_period</span><span class="p">:</span>
 
325
            <span class="k">del</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">last_activities</span><span class="p">[</span><span class="n">terminal</span><span class="p">])</span>
 
326
            <span class="n">note</span> <span class="o">=</span> <span class="n">pynotify</span><span class="o">.</span><span class="n">Notification</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">&#39;Terminator&#39;</span><span class="p">),</span> <span class="n">_</span><span class="p">(</span><span class="s">&#39;Silence in: </span><span class="si">%s</span><span class="s">&#39;</span><span class="p">)</span> <span class="o">%</span> 
 
327
                                         <span class="n">terminal</span><span class="o">.</span><span class="n">get_window_title</span><span class="p">(),</span> <span class="s">&#39;terminator&#39;</span><span class="p">)</span>
 
328
            <span class="n">note</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 
329
 
 
330
        <span class="k">return</span> <span class="bp">True</span></div></div>
 
331
</pre></div>
 
332
 
 
333
          </div>
 
334
          <footer>
 
335
  
 
336
 
 
337
  <hr/>
 
338
 
 
339
  <div role="contentinfo">
 
340
    <p>
 
341
        &copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
 
342
    </p>
 
343
  </div>
 
344
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 
345
 
 
346
</footer>
 
347
 
 
348
        </div>
 
349
      </div>
 
350
 
 
351
    </section>
 
352
 
 
353
  </div>
 
354
  
 
355
 
 
356
 
 
357
  
 
358
 
 
359
    <script type="text/javascript">
 
360
        var DOCUMENTATION_OPTIONS = {
 
361
            URL_ROOT:'../../../',
 
362
            VERSION:'0.98',
 
363
            COLLAPSE_INDEX:false,
 
364
            FILE_SUFFIX:'.html',
 
365
            HAS_SOURCE:  true
 
366
        };
 
367
    </script>
 
368
      <script type="text/javascript" src="../../../_static/jquery.js"></script>
 
369
      <script type="text/javascript" src="../../../_static/underscore.js"></script>
 
370
      <script type="text/javascript" src="../../../_static/doctools.js"></script>
 
371
 
 
372
  
 
373
 
 
374
  
 
375
  
 
376
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>
 
377
  
 
378
 
 
379
  
 
380
  
 
381
  <script type="text/javascript">
 
382
      jQuery(function () {
 
383
          SphinxRtdTheme.StickyNav.enable();
 
384
      });
 
385
  </script>
 
386
   
 
387
 
 
388
</body>
 
389
</html>
 
 
b'\\ No newline at end of file'