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

« back to all changes in this revision

Viewing changes to doc/apidoc/_build/html/_modules/terminatorlib/editablelabel.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:
 
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.editablelabel &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.editablelabel</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.editablelabel</h1><div class="highlight"><pre>
 
166
<span class="c">#!/usr/bin/env python</span>
 
167
<span class="c"># vim: tabstop=4 softtabstop=4 shiftwidth=4 expandtab</span>
 
168
<span class="c">#</span>
 
169
<span class="c"># Copyright (c) 2009, Emmanuel Bretelle &lt;chantra@debuntu.org&gt;</span>
 
170
<span class="c">#</span>
 
171
<span class="c">#    This program is free software; you can redistribute it and/or modify</span>
 
172
<span class="c">#    it under the terms of the GNU General Public License as published by</span>
 
173
<span class="c">#    the Free Software Foundation, version 2 only.</span>
 
174
<span class="c">#</span>
 
175
<span class="c">#    This program is distributed in the hope that it will be useful,</span>
 
176
<span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
 
177
<span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
 
178
<span class="c">#    GNU General Public License for more details.</span>
 
179
<span class="c">#</span>
 
180
<span class="c">#    You should have received a copy of the GNU General Public License</span>
 
181
<span class="c">#    along with this program; if not, write to the Free Software</span>
 
182
<span class="c">#    Foundation, Inc., 51 Franklin Street, Fifth Floor</span>
 
183
<span class="c">#    , Boston, MA  02110-1301  USA</span>
 
184
 
 
185
<span class="sd">&quot;&quot;&quot; Editable Label class&quot;&quot;&quot;</span>
 
186
<span class="kn">import</span> <span class="nn">gtk</span>
 
187
<span class="kn">import</span> <span class="nn">gobject</span>
 
188
 
 
189
<div class="viewcode-block" id="EditableLabel"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel">[docs]</a><span class="k">class</span> <span class="nc">EditableLabel</span><span class="p">(</span><span class="n">gtk</span><span class="o">.</span><span class="n">EventBox</span><span class="p">):</span>
 
190
    <span class="c"># pylint: disable-msg=W0212</span>
 
191
    <span class="c"># pylint: disable-msg=R0904</span>
 
192
    <span class="sd">&quot;&quot;&quot;</span>
 
193
<span class="sd">    An eventbox that partialy emulate a gtk.Label</span>
 
194
<span class="sd">    On double-click, the label is editable, entering an empty will revert back to automatic text</span>
 
195
<span class="sd">    &quot;&quot;&quot;</span>
 
196
    <span class="n">_label</span> <span class="o">=</span> <span class="bp">None</span>
 
197
    <span class="n">_ebox</span> <span class="o">=</span> <span class="bp">None</span>
 
198
    <span class="n">_autotext</span> <span class="o">=</span> <span class="bp">None</span>
 
199
    <span class="n">_custom</span> <span class="o">=</span> <span class="bp">None</span>
 
200
    <span class="n">_entry</span> <span class="o">=</span> <span class="bp">None</span>
 
201
    <span class="n">_entry_handler_id</span> <span class="o">=</span> <span class="bp">None</span>
 
202
 
 
203
    <span class="n">__gsignals__</span> <span class="o">=</span> <span class="p">{</span>
 
204
            <span class="s">&#39;edit-done&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">gobject</span><span class="o">.</span><span class="n">SIGNAL_RUN_LAST</span><span class="p">,</span> <span class="n">gobject</span><span class="o">.</span><span class="n">TYPE_NONE</span><span class="p">,</span> <span class="p">()),</span>
 
205
    <span class="p">}</span>
 
206
 
 
207
<div class="viewcode-block" id="EditableLabel.__init__"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.__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> <span class="n">text</span> <span class="o">=</span> <span class="s">&quot;&quot;</span><span class="p">):</span>
 
208
        <span class="sd">&quot;&quot;&quot; Class initialiser&quot;&quot;&quot;</span>
 
209
        <span class="n">gtk</span><span class="o">.</span><span class="n">EventBox</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> 
 
210
        <span class="bp">self</span><span class="o">.</span><span class="n">__gobject_init__</span><span class="p">()</span>
 
211
 
 
212
        <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span> <span class="o">=</span> <span class="p">[]</span>
 
213
        <span class="bp">self</span><span class="o">.</span><span class="n">_label</span> <span class="o">=</span> <span class="n">gtk</span><span class="o">.</span><span class="n">Label</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
 
214
        <span class="bp">self</span><span class="o">.</span><span class="n">_custom</span> <span class="o">=</span> <span class="bp">False</span>
 
215
        <span class="bp">self</span><span class="o">.</span><span class="n">set_visible_window</span> <span class="p">(</span><span class="bp">False</span><span class="p">)</span>
 
216
        <span class="bp">self</span><span class="o">.</span><span class="n">add</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="p">)</span>  
 
217
        <span class="bp">self</span><span class="o">.</span><span class="n">connect</span> <span class="p">(</span><span class="s">&quot;button-press-event&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_on_click_text</span><span class="p">)</span>
 
218
</div>
 
219
<div class="viewcode-block" id="EditableLabel.set_angle"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.set_angle">[docs]</a>    <span class="k">def</span> <span class="nf">set_angle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">angle</span> <span class="p">):</span>
 
220
        <span class="sd">&quot;&quot;&quot;set angle of the label&quot;&quot;&quot;</span>
 
221
        <span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">set_angle</span><span class="p">(</span> <span class="n">angle</span> <span class="p">)</span>
 
222
</div>
 
223
<div class="viewcode-block" id="EditableLabel.editing"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.editing">[docs]</a>    <span class="k">def</span> <span class="nf">editing</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
224
        <span class="sd">&quot;&quot;&quot;Return if we are currently editing&quot;&quot;&quot;</span>
 
225
        <span class="k">return</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_entry</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">)</span>
 
226
</div>
 
227
<div class="viewcode-block" id="EditableLabel.set_text"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.set_text">[docs]</a>    <span class="k">def</span> <span class="nf">set_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
 
228
        <span class="sd">&quot;&quot;&quot;set the text of the label&quot;&quot;&quot;</span>
 
229
        <span class="bp">self</span><span class="o">.</span><span class="n">_autotext</span> <span class="o">=</span> <span class="n">text</span>
 
230
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_custom</span> <span class="ow">or</span> <span class="n">force</span><span class="p">:</span>
 
231
            <span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="n">text</span><span class="p">)</span> 
 
232
</div>
 
233
<div class="viewcode-block" id="EditableLabel.get_text"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.get_text">[docs]</a>    <span class="k">def</span> <span class="nf">get_text</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
234
        <span class="sd">&quot;&quot;&quot;get the text from the label&quot;&quot;&quot;</span>
 
235
        <span class="k">return</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">get_text</span><span class="p">())</span>
 
236
</div>
 
237
<div class="viewcode-block" id="EditableLabel._on_click_text"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel._on_click_text">[docs]</a>    <span class="k">def</span> <span class="nf">_on_click_text</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">event</span><span class="p">):</span>
 
238
        <span class="c"># pylint: disable-msg=W0613</span>
 
239
        <span class="sd">&quot;&quot;&quot;event handling text edition&quot;&quot;&quot;</span>
 
240
        <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">button</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
 
241
            <span class="k">return</span> <span class="bp">False</span>
 
242
        <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">gtk</span><span class="o">.</span><span class="n">gdk</span><span class="o">.</span><span class="n">_2BUTTON_PRESS</span><span class="p">:</span>
 
243
            <span class="bp">self</span><span class="o">.</span><span class="n">remove</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="p">)</span>
 
244
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span> <span class="o">=</span> <span class="n">gtk</span><span class="o">.</span><span class="n">Entry</span> <span class="p">()</span>
 
245
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">set_text</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">get_text</span> <span class="p">())</span>
 
246
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">show</span> <span class="p">()</span>
 
247
            <span class="bp">self</span><span class="o">.</span><span class="n">add</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="p">)</span>
 
248
            <span class="n">sig</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">connect</span> <span class="p">(</span><span class="s">&quot;focus-out-event&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry_to_label</span><span class="p">)</span>
 
249
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sig</span><span class="p">)</span>
 
250
            <span class="n">sig</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</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">_on_entry_activated</span><span class="p">)</span>
 
251
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sig</span><span class="p">)</span>
 
252
            <span class="n">sig</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">connect</span> <span class="p">(</span><span class="s">&quot;key-press-event&quot;</span><span class="p">,</span>
 
253
                                         <span class="bp">self</span><span class="o">.</span><span class="n">_on_entry_keypress</span><span class="p">)</span>
 
254
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sig</span><span class="p">)</span>
 
255
            <span class="n">sig</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&quot;button-press-event&quot;</span><span class="p">,</span>
 
256
                                      <span class="bp">self</span><span class="o">.</span><span class="n">_on_entry_buttonpress</span><span class="p">)</span>
 
257
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sig</span><span class="p">)</span>
 
258
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">grab_focus</span> <span class="p">()</span>
 
259
            <span class="k">return</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
 
260
        <span class="k">return</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span>
 
261
</div>
 
262
<div class="viewcode-block" id="EditableLabel._entry_to_label"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel._entry_to_label">[docs]</a>    <span class="k">def</span> <span class="nf">_entry_to_label</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">event</span><span class="p">):</span>
 
263
        <span class="c"># pylint: disable-msg=W0613</span>
 
264
        <span class="sd">&quot;&quot;&quot;replace gtk.Entry by the gtk.Label&quot;&quot;&quot;</span>
 
265
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_children</span><span class="p">():</span>
 
266
            <span class="c">#disconnect signals to avoid segfault :s</span>
 
267
            <span class="k">for</span> <span class="n">sig</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span><span class="p">:</span>
 
268
                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">handler_is_connected</span><span class="p">(</span><span class="n">sig</span><span class="p">):</span>
 
269
                    <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="n">sig</span><span class="p">)</span>
 
270
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry_handler_id</span> <span class="o">=</span> <span class="p">[]</span>
 
271
            <span class="bp">self</span><span class="o">.</span><span class="n">remove</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="p">)</span>
 
272
            <span class="bp">self</span><span class="o">.</span><span class="n">add</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="p">)</span>
 
273
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span> <span class="o">=</span> <span class="bp">None</span>
 
274
            <span class="bp">self</span><span class="o">.</span><span class="n">show_all</span> <span class="p">()</span>
 
275
            <span class="bp">self</span><span class="o">.</span><span class="n">emit</span><span class="p">(</span><span class="s">&#39;edit-done&#39;</span><span class="p">)</span>
 
276
            <span class="c"># Returning False will ensure that focus out event will be sent to</span>
 
277
            <span class="c"># GtkEntry so it will disconnect &#39;state-changed&#39; handler</span>
 
278
            <span class="k">return</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span>
 
279
        <span class="k">return</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span>
 
280
</div>
 
281
<div class="viewcode-block" id="EditableLabel._on_entry_activated"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel._on_entry_activated">[docs]</a>    <span class="k">def</span> <span class="nf">_on_entry_activated</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">widget</span><span class="p">):</span>
 
282
        <span class="c"># pylint: disable-msg=W0613</span>
 
283
        <span class="sd">&quot;&quot;&quot;get the text entered in gtk.Entry&quot;&quot;&quot;</span>
 
284
        <span class="n">entry</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_entry</span><span class="o">.</span><span class="n">get_text</span> <span class="p">()</span>
 
285
        <span class="n">label</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">get_text</span> <span class="p">()</span>
 
286
        <span class="k">if</span> <span class="n">entry</span> <span class="o">==</span> <span class="s">&#39;&#39;</span><span class="p">:</span>
 
287
            <span class="bp">self</span><span class="o">.</span><span class="n">_custom</span> <span class="o">=</span> <span class="bp">False</span>
 
288
            <span class="bp">self</span><span class="o">.</span><span class="n">set_text</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_autotext</span><span class="p">)</span>
 
289
        <span class="k">elif</span> <span class="n">entry</span> <span class="o">!=</span> <span class="n">label</span><span class="p">:</span>
 
290
            <span class="bp">self</span><span class="o">.</span><span class="n">_custom</span> <span class="o">=</span> <span class="bp">True</span>
 
291
            <span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">set_text</span> <span class="p">(</span><span class="n">entry</span><span class="p">)</span>
 
292
        <span class="bp">self</span><span class="o">.</span><span class="n">_entry_to_label</span> <span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
 
293
</div>
 
294
<div class="viewcode-block" id="EditableLabel._on_entry_keypress"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel._on_entry_keypress">[docs]</a>    <span class="k">def</span> <span class="nf">_on_entry_keypress</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">event</span><span class="p">):</span>
 
295
        <span class="c"># pylint: disable-msg=W0613</span>
 
296
        <span class="sd">&quot;&quot;&quot;handle keypressed in gtk.Entry&quot;&quot;&quot;</span>
 
297
        <span class="n">key</span> <span class="o">=</span> <span class="n">gtk</span><span class="o">.</span><span class="n">gdk</span><span class="o">.</span><span class="n">keyval_name</span> <span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">keyval</span><span class="p">)</span>
 
298
        <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="s">&#39;Escape&#39;</span><span class="p">:</span>
 
299
            <span class="bp">self</span><span class="o">.</span><span class="n">_entry_to_label</span> <span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
 
300
</div>
 
301
<div class="viewcode-block" id="EditableLabel._on_entry_buttonpress"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel._on_entry_buttonpress">[docs]</a>    <span class="k">def</span> <span class="nf">_on_entry_buttonpress</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">event</span><span class="p">):</span>
 
302
        <span class="sd">&quot;&quot;&quot;handle button events in gtk.Entry.&quot;&quot;&quot;</span>
 
303
        <span class="c"># Block right clicks to avoid a deadlock.</span>
 
304
        <span class="c"># The correct solution here would be for _entry_to_label to trigger a</span>
 
305
        <span class="c"># deferred execution handler and for that handler to check if focus is</span>
 
306
        <span class="c"># in a GtkMenu. The problem being that we are unable to get a context</span>
 
307
        <span class="c"># menu for the GtkEntry.</span>
 
308
        <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">button</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
 
309
            <span class="k">return</span> <span class="bp">True</span>
 
310
</div>
 
311
<div class="viewcode-block" id="EditableLabel.modify_fg"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.modify_fg">[docs]</a>    <span class="k">def</span> <span class="nf">modify_fg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">,</span> <span class="n">color</span><span class="p">):</span>
 
312
        <span class="sd">&quot;&quot;&quot;Set the label foreground&quot;&quot;&quot;</span>
 
313
        <span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">modify_fg</span><span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="n">color</span><span class="p">)</span>
 
314
</div>
 
315
<div class="viewcode-block" id="EditableLabel.is_custom"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.is_custom">[docs]</a>    <span class="k">def</span> <span class="nf">is_custom</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
316
        <span class="sd">&quot;&quot;&quot;Return whether or not we have a custom string set&quot;&quot;&quot;</span>
 
317
        <span class="k">return</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_custom</span><span class="p">)</span>
 
318
</div>
 
319
<div class="viewcode-block" id="EditableLabel.set_custom"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.set_custom">[docs]</a>    <span class="k">def</span> <span class="nf">set_custom</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
320
        <span class="sd">&quot;&quot;&quot;Set the customness of the string to True&quot;&quot;&quot;</span>
 
321
        <span class="bp">self</span><span class="o">.</span><span class="n">_custom</span> <span class="o">=</span> <span class="bp">True</span>
 
322
</div>
 
323
<div class="viewcode-block" id="EditableLabel.modify_font"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.editablelabel.EditableLabel.modify_font">[docs]</a>    <span class="k">def</span> <span class="nf">modify_font</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fontdesc</span><span class="p">):</span>
 
324
        <span class="sd">&quot;&quot;&quot;Set the label font using a pango.FontDescription&quot;&quot;&quot;</span>
 
325
        <span class="bp">self</span><span class="o">.</span><span class="n">_label</span><span class="o">.</span><span class="n">modify_font</span><span class="p">(</span><span class="n">fontdesc</span><span class="p">)</span>
 
326
</div></div>
 
327
<span class="n">gobject</span><span class="o">.</span><span class="n">type_register</span><span class="p">(</span><span class="n">EditableLabel</span><span class="p">)</span>
 
328
</pre></div>
 
329
 
 
330
          </div>
 
331
          <footer>
 
332
  
 
333
 
 
334
  <hr/>
 
335
 
 
336
  <div role="contentinfo">
 
337
    <p>
 
338
        &copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
 
339
    </p>
 
340
  </div>
 
341
  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>.
 
342
 
 
343
</footer>
 
344
 
 
345
        </div>
 
346
      </div>
 
347
 
 
348
    </section>
 
349
 
 
350
  </div>
 
351
  
 
352
 
 
353
 
 
354
  
 
355
 
 
356
    <script type="text/javascript">
 
357
        var DOCUMENTATION_OPTIONS = {
 
358
            URL_ROOT:'../../',
 
359
            VERSION:'0.98',
 
360
            COLLAPSE_INDEX:false,
 
361
            FILE_SUFFIX:'.html',
 
362
            HAS_SOURCE:  true
 
363
        };
 
364
    </script>
 
365
      <script type="text/javascript" src="../../_static/jquery.js"></script>
 
366
      <script type="text/javascript" src="../../_static/underscore.js"></script>
 
367
      <script type="text/javascript" src="../../_static/doctools.js"></script>
 
368
 
 
369
  
 
370
 
 
371
  
 
372
  
 
373
    <script type="text/javascript" src="../../_static/js/theme.js"></script>
 
374
  
 
375
 
 
376
  
 
377
  
 
378
  <script type="text/javascript">
 
379
      jQuery(function () {
 
380
          SphinxRtdTheme.StickyNav.enable();
 
381
      });
 
382
  </script>
 
383
   
 
384
 
 
385
</body>
 
386
</html>
 
 
b'\\ No newline at end of file'