python-kiwi 1.9.22-2 / usr / share / doc / python-kiwi / api / kiwi.ui.proxywidget.ProxyWidgetMixin.html

This file is indexed.

/usr/share/doc/python-kiwi/api/kiwi.ui.proxywidget.ProxyWidgetMixin.html is in python-kiwi 1.9.22-2.

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
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>kiwi.ui.proxywidget.ProxyWidgetMixin : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">k.u.p.ProxyWidgetMixin(<span title="object">object</span>) : class documentation</h1>
    <p>
      <span id="part">Part of <a href="kiwi.html">kiwi</a>.<a href="kiwi.ui.html">ui</a>.<a href="kiwi.ui.proxywidget.html">proxywidget</a></span>
      
      <a href="classIndex.html#kiwi.ui.proxywidget.ProxyWidgetMixin">View In Hierarchy</a>
    </p>
    <div>
      <p>Known subclasses: <a href="kiwi.ui.proxywidget.ValidatableProxyWidgetMixin.html">kiwi.ui.proxywidget.ValidatableProxyWidgetMixin</a>, <a href="kiwi.ui.widgets.button.ProxyButton.html">kiwi.ui.widgets.button.ProxyButton</a>, <a href="kiwi.ui.widgets.checkbutton.ProxyCheckButton.html">kiwi.ui.widgets.checkbutton.ProxyCheckButton</a>, <a href="kiwi.ui.widgets.colorbutton.ProxyColorButton.html">kiwi.ui.widgets.colorbutton.ProxyColorButton</a>, <a href="kiwi.ui.widgets.combo.ProxyComboBox.html">kiwi.ui.widgets.combo.ProxyComboBox</a>, <a href="kiwi.ui.widgets.filechooser.ProxyFileChooserButton.html">kiwi.ui.widgets.filechooser.ProxyFileChooserButton</a>, <a href="kiwi.ui.widgets.filechooser.ProxyFileChooserWidget.html">kiwi.ui.widgets.filechooser.ProxyFileChooserWidget</a>, <a href="kiwi.ui.widgets.fontbutton.ProxyFontButton.html">kiwi.ui.widgets.fontbutton.ProxyFontButton</a>, <a href="kiwi.ui.widgets.label.ProxyLabel.html">kiwi.ui.widgets.label.ProxyLabel</a>, <a href="kiwi.ui.widgets.radiobutton.ProxyRadioButton.html">kiwi.ui.widgets.radiobutton.ProxyRadioButton</a>, <a href="kiwi.ui.widgets.scale.ProxyHScale.html">kiwi.ui.widgets.scale.ProxyHScale</a>, <a href="kiwi.ui.widgets.scale.ProxyVScale.html">kiwi.ui.widgets.scale.ProxyVScale</a></p>
    </div>
    <div>This class is a mixin that provide a common interface for 
KiwiWidgets.</p>
<p>Usually the Proxy class need to set and get data from the widgets. It 
also need a validation framework.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Class Variables</td><td class="fieldArg">allowed_data_types</td><td>A list of types which we are allowed to use in this class.
</td></tr></table></div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id290">
  
  
<tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#__init__">__init__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#prop_set_data_type">prop_set_data_type</a></td>
    <td><span>Set the data type for the widget</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#set_data_format">set_data_format</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#set_options_for_datatype">set_options_for_datatype</a></td>
    <td><span>Set some options to be passed to the datatype converter.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#read">read</a></td>
    <td><span>Get the content of the widget.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#update">update</a></td>
    <td><span>Update the content value of the widget.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#_as_string">_as_string</a></td>
    <td><span>Convert a value to a string</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.proxywidget.ProxyWidgetMixin.html#_from_string">_from_string</a></td>
    <td><span>Convert a string to the data type of the widget</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.ui.proxywidget.ValidatableProxyWidgetMixin.html">kiwi.ui.proxywidget.ValidatableProxyWidgetMixin</a>, <a href="kiwi.ui.widgets.button.ProxyButton.html">kiwi.ui.widgets.button.ProxyButton</a>, <a href="kiwi.ui.widgets.checkbutton.ProxyCheckButton.html">kiwi.ui.widgets.checkbutton.ProxyCheckButton</a>, <a href="kiwi.ui.widgets.colorbutton.ProxyColorButton.html">kiwi.ui.widgets.colorbutton.ProxyColorButton</a>, <a href="kiwi.ui.widgets.combo.ProxyComboBox.html">kiwi.ui.widgets.combo.ProxyComboBox</a>, <a href="kiwi.ui.widgets.filechooser.ProxyFileChooserButton.html">kiwi.ui.widgets.filechooser.ProxyFileChooserButton</a>, <a href="kiwi.ui.widgets.filechooser.ProxyFileChooserWidget.html">kiwi.ui.widgets.filechooser.ProxyFileChooserWidget</a>, <a href="kiwi.ui.widgets.fontbutton.ProxyFontButton.html">kiwi.ui.widgets.fontbutton.ProxyFontButton</a>, <a href="kiwi.ui.widgets.label.ProxyLabel.html">kiwi.ui.widgets.label.ProxyLabel</a>, <a href="kiwi.ui.widgets.radiobutton.ProxyRadioButton.html">kiwi.ui.widgets.radiobutton.ProxyRadioButton</a>, <a href="kiwi.ui.widgets.scale.ProxyHScale.html">kiwi.ui.widgets.scale.ProxyHScale</a>, <a href="kiwi.ui.widgets.scale.ProxyVScale.html">kiwi.ui.widgets.scale.ProxyVScale</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin.prop_set_data_type">
    
  </a>
  <a name="prop_set_data_type">
    
  </a>
  <div class="functionHeader">
    
    def
    prop_set_data_type(self, data_type):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.ui.widgets.entry.ProxyEntry.html">kiwi.ui.widgets.entry.ProxyEntry</a>, <a href="kiwi.ui.widgets.label.ProxyLabel.html">kiwi.ui.widgets.label.ProxyLabel</a></div>
    <div>Set the data type for the widget<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">data_type</td><td>can be None, a type object or a string with the name of the type object, so
None, &quot;&lt;type 'str'&gt;&quot; or 'str'
</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin.set_data_format">
    
  </a>
  <a name="set_data_format">
    
  </a>
  <div class="functionHeader">
    
    def
    set_data_format(self, format):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin.set_options_for_datatype">
    
  </a>
  <a name="set_options_for_datatype">
    
  </a>
  <div class="functionHeader">
    
    def
    set_options_for_datatype(self, datatype, **options):
    
  </div>
  <div class="functionBody">
    
    <div>Set some options to be passed to the datatype converter. Any additional 
parameter will be passed the the converter when converting an object to a 
string, for displaying in the widget. Note that the converter.as_string 
method should be able to handle such parameters.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">datatype</td><td>the datatype.
</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin.read">
    
  </a>
  <a name="read">
    
  </a>
  <div class="functionHeader">
    
    def
    read(self):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.ui.widgets.button.ProxyButton.html">kiwi.ui.widgets.button.ProxyButton</a>, <a href="kiwi.ui.widgets.checkbutton.ProxyCheckButton.html">kiwi.ui.widgets.checkbutton.ProxyCheckButton</a>, <a href="kiwi.ui.widgets.colorbutton.ProxyColorButton.html">kiwi.ui.widgets.colorbutton.ProxyColorButton</a>, <a href="kiwi.ui.widgets.combo.ProxyComboBox.html">kiwi.ui.widgets.combo.ProxyComboBox</a>, <a href="kiwi.ui.widgets.combo.ProxyComboBoxEntry.html">kiwi.ui.widgets.combo.ProxyComboBoxEntry</a>, <a href="kiwi.ui.widgets.combo.ProxyComboEntry.html">kiwi.ui.widgets.combo.ProxyComboEntry</a>, <a href="kiwi.ui.widgets.entry.ProxyDateEntry.html">kiwi.ui.widgets.entry.ProxyDateEntry</a>, <a href="kiwi.ui.widgets.entry.ProxyEntry.html">kiwi.ui.widgets.entry.ProxyEntry</a>, <a href="kiwi.ui.widgets.fontbutton.ProxyFontButton.html">kiwi.ui.widgets.fontbutton.ProxyFontButton</a>, <a href="kiwi.ui.widgets.label.ProxyLabel.html">kiwi.ui.widgets.label.ProxyLabel</a>, <a href="kiwi.ui.widgets.radiobutton.ProxyRadioButton.html">kiwi.ui.widgets.radiobutton.ProxyRadioButton</a>, <a href="kiwi.ui.widgets.spinbutton.ProxySpinButton.html">kiwi.ui.widgets.spinbutton.ProxySpinButton</a>, <a href="kiwi.ui.widgets.textview.ProxyTextView.html">kiwi.ui.widgets.textview.ProxyTextView</a></div>
    <div>Get the content of the widget. The type of the return value<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">None if the user input a invalid value
 (type: Must matche the data-type property.
)</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin.update">
    
  </a>
  <a name="update">
    
  </a>
  <div class="functionHeader">
    
    def
    update(self, value):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.ui.widgets.button.ProxyButton.html">kiwi.ui.widgets.button.ProxyButton</a>, <a href="kiwi.ui.widgets.checkbutton.ProxyCheckButton.html">kiwi.ui.widgets.checkbutton.ProxyCheckButton</a>, <a href="kiwi.ui.widgets.colorbutton.ProxyColorButton.html">kiwi.ui.widgets.colorbutton.ProxyColorButton</a>, <a href="kiwi.ui.widgets.combo.ProxyComboBox.html">kiwi.ui.widgets.combo.ProxyComboBox</a>, <a href="kiwi.ui.widgets.combo.ProxyComboBoxEntry.html">kiwi.ui.widgets.combo.ProxyComboBoxEntry</a>, <a href="kiwi.ui.widgets.combo.ProxyComboEntry.html">kiwi.ui.widgets.combo.ProxyComboEntry</a>, <a href="kiwi.ui.widgets.entry.ProxyDateEntry.html">kiwi.ui.widgets.entry.ProxyDateEntry</a>, <a href="kiwi.ui.widgets.entry.ProxyEntry.html">kiwi.ui.widgets.entry.ProxyEntry</a>, <a href="kiwi.ui.widgets.fontbutton.ProxyFontButton.html">kiwi.ui.widgets.fontbutton.ProxyFontButton</a>, <a href="kiwi.ui.widgets.label.ProxyLabel.html">kiwi.ui.widgets.label.ProxyLabel</a>, <a href="kiwi.ui.widgets.radiobutton.ProxyRadioButton.html">kiwi.ui.widgets.radiobutton.ProxyRadioButton</a>, <a href="kiwi.ui.widgets.spinbutton.ProxySpinButton.html">kiwi.ui.widgets.spinbutton.ProxySpinButton</a>, <a href="kiwi.ui.widgets.textview.ProxyTextView.html">kiwi.ui.widgets.textview.ProxyTextView</a></div>
    <div>Update the content value of the widget.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">value</td><td></td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin._as_string">
    
  </a>
  <a name="_as_string">
    
  </a>
  <div class="functionHeader">
    
    def
    _as_string(self, data):
    
  </div>
  <div class="functionBody">
    
    <div>Convert a value to a string<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">data</td><td>data to convert
</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.proxywidget.ProxyWidgetMixin._from_string">
    
  </a>
  <a name="_from_string">
    
  </a>
  <div class="functionHeader">
    
    def
    _from_string(self, data):
    
  </div>
  <div class="functionBody">
    
    <div>Convert a string to the data type of the widget This may raise a <a 
href="kiwi.datatypes.ValidationError.html"><code>kiwi.datatypes.ValidationError</code></a>
if conversion failed<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">data</td><td>data to convert
</td></tr></table></div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for Kiwi, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2010-05-20 02:10:57.
    </address>
  </body>
</html>

APT Browse - Built by Thomas Orozco.