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]-->
9
<meta name="viewport" content="width=device-width, initial-scale=1.0">
11
<title>terminatorlib.signalman — terminatorlib 0.98 documentation</title>
27
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
33
<link rel="top" title="terminatorlib 0.98 documentation" href="../../index.html"/>
34
<link rel="up" title="Module code" href="../index.html"/>
37
<script src="_static/js/modernizr.min.js"></script>
41
<body class="wy-body-for-nav" role="document">
43
<div class="wy-grid-for-nav">
46
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
47
<div class="wy-side-nav-search">
51
<a href="../../index.html" class="icon icon-home"> terminatorlib
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" />
69
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
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>
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>
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>
136
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
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>
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> »</li>
152
<li><a href="../index.html">Module code</a> »</li>
154
<li>terminatorlib.signalman</li>
155
<li class="wy-breadcrumbs-aside">
163
<div role="main" class="document">
165
<h1>Source code for terminatorlib.signalman</h1><div class="highlight"><pre>
166
<span class="c">#!/usr/bin/python</span>
167
<span class="c"># Terminator by Chris Jones <cmsj@tenshu.net></span>
168
<span class="c"># GPL v2 only</span>
169
<span class="sd">"""Simple management of Gtk Widget signal handlers"""</span>
171
<span class="kn">from</span> <span class="nn">util</span> <span class="kn">import</span> <span class="n">dbg</span><span class="p">,</span> <span class="n">err</span>
173
<div class="viewcode-block" id="Signalman"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman">[docs]</a><span class="k">class</span> <span class="nc">Signalman</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
174
<span class="sd">"""Class providing glib signal tracking and management"""</span>
176
<span class="n">cnxids</span> <span class="o">=</span> <span class="bp">None</span>
178
<div class="viewcode-block" id="Signalman.__init__"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman.__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>
179
<span class="sd">"""Class initialiser"""</span>
180
<span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span> <span class="o">=</span> <span class="p">{}</span>
182
<div class="viewcode-block" id="Signalman.__del__"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman.__del__">[docs]</a> <span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
183
<span class="sd">"""Class destructor. This is only used to check for stray signals"""</span>
184
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
185
<span class="n">dbg</span><span class="p">(</span><span class="s">'Remaining signals: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">)</span>
187
<div class="viewcode-block" id="Signalman.new"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman.new">[docs]</a> <span class="k">def</span> <span class="nf">new</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">signal</span><span class="p">,</span> <span class="n">handler</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
188
<span class="sd">"""Register a new signal on a widget"""</span>
189
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">widget</span><span class="p">):</span>
190
<span class="n">dbg</span><span class="p">(</span><span class="s">'creating new bucket for </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="nb">type</span><span class="p">(</span><span class="n">widget</span><span class="p">))</span>
191
<span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
193
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">]</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">signal</span><span class="p">):</span>
194
<span class="n">err</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> already has a handler for </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">id</span><span class="p">(</span><span class="n">widget</span><span class="p">),</span> <span class="n">signal</span><span class="p">))</span>
196
<span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">][</span><span class="n">signal</span><span class="p">]</span> <span class="o">=</span> <span class="n">widget</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">signal</span><span class="p">,</span> <span class="n">handler</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
197
<span class="n">dbg</span><span class="p">(</span><span class="s">'connected </span><span class="si">%s</span><span class="s">::</span><span class="si">%s</span><span class="s"> to </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">widget</span><span class="p">),</span> <span class="n">signal</span><span class="p">,</span> <span class="n">handler</span><span class="p">))</span>
198
<span class="k">return</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">][</span><span class="n">signal</span><span class="p">])</span>
200
<div class="viewcode-block" id="Signalman.remove_signal"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman.remove_signal">[docs]</a> <span class="k">def</span> <span class="nf">remove_signal</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">signal</span><span class="p">):</span>
201
<span class="sd">"""Remove a signal handler"""</span>
202
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">widget</span><span class="p">):</span>
203
<span class="n">dbg</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> is not registered'</span> <span class="o">%</span> <span class="n">widget</span><span class="p">)</span>
204
<span class="k">return</span>
205
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">]</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">signal</span><span class="p">):</span>
206
<span class="n">dbg</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> not registered for </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">signal</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">widget</span><span class="p">)))</span>
207
<span class="k">return</span>
208
<span class="n">dbg</span><span class="p">(</span><span class="s">'removing </span><span class="si">%s</span><span class="s">::</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">widget</span><span class="p">),</span> <span class="n">signal</span><span class="p">))</span>
209
<span class="n">widget</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">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">][</span><span class="n">signal</span><span class="p">])</span>
210
<span class="k">del</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">][</span><span class="n">signal</span><span class="p">])</span>
211
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
212
<span class="n">dbg</span><span class="p">(</span><span class="s">'no more signals for widget'</span><span class="p">)</span>
213
<span class="k">del</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">])</span>
215
<div class="viewcode-block" id="Signalman.remove_widget"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman.remove_widget">[docs]</a> <span class="k">def</span> <span class="nf">remove_widget</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">widget</span><span class="p">):</span>
216
<span class="sd">"""Remove all signal handlers for a widget"""</span>
217
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">widget</span><span class="p">):</span>
218
<span class="n">dbg</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> not registered'</span> <span class="o">%</span> <span class="n">widget</span><span class="p">)</span>
219
<span class="k">return</span>
220
<span class="n">signals</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="p">[</span><span class="n">widget</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
221
<span class="k">for</span> <span class="n">signal</span> <span class="ow">in</span> <span class="n">signals</span><span class="p">:</span>
222
<span class="bp">self</span><span class="o">.</span><span class="n">remove_signal</span><span class="p">(</span><span class="n">widget</span><span class="p">,</span> <span class="n">signal</span><span class="p">)</span>
224
<div class="viewcode-block" id="Signalman.remove_all"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.signalman.Signalman.remove_all">[docs]</a> <span class="k">def</span> <span class="nf">remove_all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
225
<span class="sd">"""Remove all signal handlers for all widgets"""</span>
226
<span class="n">widgets</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cnxids</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
227
<span class="k">for</span> <span class="n">widget</span> <span class="ow">in</span> <span class="n">widgets</span><span class="p">:</span>
228
<span class="bp">self</span><span class="o">.</span><span class="n">remove_widget</span><span class="p">(</span><span class="n">widget</span><span class="p">)</span>
229
</pre></div></div></div>
237
<div role="contentinfo">
239
© Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
242
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>.
257
<script type="text/javascript">
258
var DOCUMENTATION_OPTIONS = {
261
COLLAPSE_INDEX:false,
266
<script type="text/javascript" src="../../_static/jquery.js"></script>
267
<script type="text/javascript" src="../../_static/underscore.js"></script>
268
<script type="text/javascript" src="../../_static/doctools.js"></script>
274
<script type="text/javascript" src="../../_static/js/theme.js"></script>
279
<script type="text/javascript">
281
SphinxRtdTheme.StickyNav.enable();
b'\\ No newline at end of file'