python-gtkmvc-doc 1.99.1-1 / usr / share / doc / python-gtkmvc-doc / reference / model.html

This file is indexed.

/usr/share/doc/python-gtkmvc-doc/reference/model.html is in python-gtkmvc-doc 1.99.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Model Classes &mdash; GTK MVC v1.99.1 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1.99.1',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="GTK MVC v1.99.1 documentation" href="index.html" />
    <link rel="next" title="The View" href="view.html" />
    <link rel="prev" title="GTK MVC 1.99 Library Reference" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="view.html" title="The View"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="GTK MVC 1.99 Library Reference"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">GTK MVC v1.99.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-gtkmvc.model">
<h1>Model Classes<a class="headerlink" href="#module-gtkmvc.model" title="Permalink to this headline"></a></h1>
<p>There are several possible ways to derive your model. All look the same
to a <tt class="xref docutils literal"><span class="pre">Controller</span></tt>.</p>
<dl class="class">
<dt id="gtkmvc.model.Model">
<em class="property">class </em><tt class="descclassname">gtkmvc.model.</tt><tt class="descname">Model</tt><a class="headerlink" href="#gtkmvc.model.Model" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a title="gtkmvc.observer.Observer" class="reference external" href="observer.html#gtkmvc.observer.Observer"><tt class="xref docutils literal"><span class="pre">gtkmvc.observer.Observer</span></tt></a></p>
<dl class="attribute">
<dt id="gtkmvc.model.Model.__observables__">
<tt class="descname">__observables__</tt><a class="headerlink" href="#gtkmvc.model.Model.__observables__" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute. A list or tuple of name strings. The metaclass
<a title="gtkmvc.support.metaclasses.ObservablePropertyMeta" class="reference external" href="metaclasses.html#gtkmvc.support.metaclasses.ObservablePropertyMeta"><tt class="xref docutils literal"><span class="pre">ObservablePropertyMeta</span></tt></a>
uses it to create properties.</p>
<p><em>Value properties</em> have to exist as an attribute with an
initial value, which may be <tt class="xref docutils literal"><span class="pre">None</span></tt>.</p>
<p><em>Logical properties</em> require a getter and may have a setter method in
the class.</p>
</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.get_properties">
<tt class="descname">get_properties</tt><big>(</big><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.get_properties" title="Permalink to this definition"></a></dt>
<dd><p>All observable properties accessible from this instance.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">frozenset of strings</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="classmethod">
<dt id="gtkmvc.model.Model.getter">
<em class="property">classmethod </em><tt class="descname">getter</tt><big>(</big><em>*f</em>, <em>**k</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.getter" title="Permalink to this definition"></a></dt>
<dd><p>Decorate a method as a logical property getter. Comes in two flavours:</p>
<dl class="method">
<dt>
<tt class="descname">getter</tt><big>(</big><big>)</big></dt>
<dd>Uses the name of the method as the property name.
The method must not require arguments.</dd></dl>

<dl class="method">
<dt>
<tt class="descname">getter</tt><big>(</big><em>one</em>, <em>two</em>, <em>...</em><big>)</big></dt>
<dd>Takes a variable number of strings as the property
name(s). The name of the method does not matter.
The method must take a property name as its sole argument.</dd></dl>

</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.has_property">
<tt class="descname">has_property</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.has_property" title="Permalink to this definition"></a></dt>
<dd>Returns true if given property name refers an observable
property inside self or inside derived classes.</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.notify_method_after_change">
<tt class="descname">notify_method_after_change</tt><big>(</big><em>prop_name</em>, <em>instance</em>, <em>meth_name</em>, <em>res</em>, <em>args</em>, <em>kwargs</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.notify_method_after_change" title="Permalink to this definition"></a></dt>
<dd><p>Send a notification to all registered observers.</p>
<p><em>args</em> the arguments we just passed to <em>meth_name</em>.</p>
<p><em>res</em> the return value of the method call.</p>
</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.notify_method_before_change">
<tt class="descname">notify_method_before_change</tt><big>(</big><em>prop_name</em>, <em>instance</em>, <em>meth_name</em>, <em>args</em>, <em>kwargs</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.notify_method_before_change" title="Permalink to this definition"></a></dt>
<dd><p>Send a notification to all registered observers.</p>
<p><em>instance</em> the object stored in the property.</p>
<p><em>meth_name</em> name of the method we are about to call on <em>instance</em>.</p>
</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.notify_property_value_change">
<tt class="descname">notify_property_value_change</tt><big>(</big><em>prop_name</em>, <em>old</em>, <em>new</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.notify_property_value_change" title="Permalink to this definition"></a></dt>
<dd><p>Send a notification to all registered observers.</p>
<p><em>old</em> the value before the change occured.</p>
</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.notify_signal_emit">
<tt class="descname">notify_signal_emit</tt><big>(</big><em>prop_name</em>, <em>arg</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.notify_signal_emit" title="Permalink to this definition"></a></dt>
<dd><p>Emit a signal to all registered observers.</p>
<p><em>prop_name</em> the property storing the <a title="gtkmvc.observable.Signal" class="reference external" href="observable.html#gtkmvc.observable.Signal"><tt class="xref docutils literal"><span class="pre">Signal</span></tt></a>
instance.</p>
<p><em>arg</em> one arbitrary argument passed to observing methods.</p>
</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.register_observer">
<tt class="descname">register_observer</tt><big>(</big><em>observer</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.register_observer" title="Permalink to this definition"></a></dt>
<dd>Register given observer among those observers which are
interested in observing the model.</dd></dl>

<dl class="classmethod">
<dt id="gtkmvc.model.Model.setter">
<em class="property">classmethod </em><tt class="descname">setter</tt><big>(</big><em>*f</em>, <em>**k</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.setter" title="Permalink to this definition"></a></dt>
<dd><p>Decorate a method as a logical property setter. The counterpart to
<a title="gtkmvc.model.Model.getter" class="reference internal" href="#gtkmvc.model.Model.getter"><tt class="xref docutils literal"><span class="pre">getter()</span></tt></a>. Also comes in two flavours:</p>
<dl class="method">
<dt>
<tt class="descname">setter</tt><big>(</big><big>)</big></dt>
<dd>Uses the name of the method as the property name.
The method must take one argument, the new value.</dd></dl>

<dl class="method">
<dt>
<tt class="descname">getter</tt><big>(</big><em>one</em>, <em>two</em>, <em>...</em><big>)</big></dt>
<dd>Takes a variable number of strings as the property
name(s). The name of the method does not matter.
The method must take two arguments, the property name and new value.</dd></dl>

</dd></dl>

<dl class="method">
<dt id="gtkmvc.model.Model.unregister_observer">
<tt class="descname">unregister_observer</tt><big>(</big><em>observer</em><big>)</big><a class="headerlink" href="#gtkmvc.model.Model.unregister_observer" title="Permalink to this definition"></a></dt>
<dd>Unregister the given observer that is no longer interested
in observing the model.</dd></dl>

</dd></dl>

<div class="section" id="persistence">
<h2>Persistence<a class="headerlink" href="#persistence" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="specific-widgets">
<h2>Specific widgets<a class="headerlink" href="#specific-widgets" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="gtkmvc.model.TextBufferModel">
<em class="property">class </em><tt class="descclassname">gtkmvc.model.</tt><tt class="descname">TextBufferModel</tt><big>(</big><em>table=None</em><big>)</big><a class="headerlink" href="#gtkmvc.model.TextBufferModel" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a title="gtkmvc.model.Model" class="reference internal" href="#gtkmvc.model.Model"><tt class="xref docutils literal"><span class="pre">gtkmvc.model.Model</span></tt></a>, <tt class="xref docutils literal"><span class="pre">gtk.TextBuffer</span></tt></p>
<p>Use this class as base class for your model derived by
gtk.TextBuffer</p>
</dd></dl>

<dl class="class">
<dt id="gtkmvc.model.ListStoreModel">
<em class="property">class </em><tt class="descclassname">gtkmvc.model.</tt><tt class="descname">ListStoreModel</tt><big>(</big><em>column_type</em>, <em>*args</em><big>)</big><a class="headerlink" href="#gtkmvc.model.ListStoreModel" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a title="gtkmvc.model.Model" class="reference internal" href="#gtkmvc.model.Model"><tt class="xref docutils literal"><span class="pre">gtkmvc.model.Model</span></tt></a>, <tt class="xref docutils literal"><span class="pre">gtk.ListStore</span></tt></p>
<p>Use this class as base class for your model derived by
gtk.ListStore</p>
</dd></dl>

<dl class="class">
<dt id="gtkmvc.model.TreeStoreModel">
<em class="property">class </em><tt class="descclassname">gtkmvc.model.</tt><tt class="descname">TreeStoreModel</tt><big>(</big><em>column_type</em>, <em>*args</em><big>)</big><a class="headerlink" href="#gtkmvc.model.TreeStoreModel" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a title="gtkmvc.model.Model" class="reference internal" href="#gtkmvc.model.Model"><tt class="xref docutils literal"><span class="pre">gtkmvc.model.Model</span></tt></a>, <tt class="xref docutils literal"><span class="pre">gtk.TreeStore</span></tt></p>
<p>Use this class as base class for your model derived by
gtk.TreeStore</p>
</dd></dl>

</div>
<div class="section" id="module-gtkmvc.model_mt">
<h2>Threading<a class="headerlink" href="#module-gtkmvc.model_mt" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="gtkmvc.model_mt.ModelMT">
<em class="property">class </em><tt class="descclassname">gtkmvc.model_mt.</tt><tt class="descname">ModelMT</tt><a class="headerlink" href="#gtkmvc.model_mt.ModelMT" title="Permalink to this definition"></a></dt>
<dd>A base class for models whose observable properties can be
changed by threads different than gtk main thread. Notification is
performed by exploiting the gtk idle loop only if needed,
otherwise the standard notification system (direct method call) is
used. In this model, the observer is expected to run in the gtk
main loop thread.</dd></dl>

<dl class="class">
<dt id="gtkmvc.model_mt.TextBufferModelMT">
<em class="property">class </em><tt class="descclassname">gtkmvc.model_mt.</tt><tt class="descname">TextBufferModelMT</tt><big>(</big><em>table=None</em><big>)</big><a class="headerlink" href="#gtkmvc.model_mt.TextBufferModelMT" title="Permalink to this definition"></a></dt>
<dd>Use this class as base class for your model derived by
gtk.TextBuffer</dd></dl>

<dl class="class">
<dt id="gtkmvc.model_mt.ListStoreModelMT">
<em class="property">class </em><tt class="descclassname">gtkmvc.model_mt.</tt><tt class="descname">ListStoreModelMT</tt><big>(</big><em>column_type</em>, <em>*args</em><big>)</big><a class="headerlink" href="#gtkmvc.model_mt.ListStoreModelMT" title="Permalink to this definition"></a></dt>
<dd>Use this class as base class for your model derived by
gtk.ListStore</dd></dl>

<dl class="class">
<dt id="gtkmvc.model_mt.TreeStoreModelMT">
<em class="property">class </em><tt class="descclassname">gtkmvc.model_mt.</tt><tt class="descname">TreeStoreModelMT</tt><big>(</big><em>column_type</em>, <em>*args</em><big>)</big><a class="headerlink" href="#gtkmvc.model_mt.TreeStoreModelMT" title="Permalink to this definition"></a></dt>
<dd>Use this class as base class for your model derived by
gtk.TreeStore</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="index.html">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="#">Model Classes</a><ul>
<li><a class="reference external" href="#persistence">Persistence</a></li>
<li><a class="reference external" href="#specific-widgets">Specific widgets</a></li>
<li><a class="reference external" href="#module-gtkmvc.model_mt">Threading</a></li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="index.html"
                                  title="previous chapter">GTK MVC 1.99 Library Reference</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="view.html"
                                  title="next chapter">The View</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/model.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="view.html" title="The View"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="GTK MVC 1.99 Library Reference"
             >previous</a> |</li>
        <li><a href="index.html">GTK MVC v1.99.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2010, Roberto Cavada.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.