Package kiwi :: Package ui :: Package widgets :: Module entry :: Class ProxyEntry
[frames | no frames]

Type ProxyEntry

             object --+        
                      |        
         PropertyObject --+    
                          |    
             object --+   |    
                      |   |    
               _GObject --+    
                          |    
                  KiwiEntry --+
                              |
             object --+       |
                      |       |
       ProxyWidgetMixin --+   |
                          |   |
ValidatableProxyWidgetMixin --+
                              |
                             ProxyEntry

Known Subclasses:
Entry

The Kiwi Entry widget has many special features that extend the basic gtk entry.

First of all, as every Kiwi Widget, it implements the Proxy protocol. As the users types the entry can interact with the application model automatically. Kiwi Entry also implements interesting UI additions. If the input data does not match the data type of the entry the background nicely fades to a light red color. As the background changes an information icon appears. When the user passes the mouse over the information icon a tooltip is displayed informing the user how to correctly fill the entry. When dealing with date and float data-type the information on how to fill these entries is displayed according to the current locale.
Method Summary
  do_changed(self)
  prop_set_data_type(self, data_type)
Set the data type for the widget
Must matche the data-type property. read(self)
Get the content of the widget.
  set_completion_strings(*args, **kwargs)
  set_mask_for_data_type(self, data_type)
  set_text(self, text)
Sets the text of the entry
  update(self, data)
    Inherited from KiwiEntry
  do_expose_event(self, event)
  do_realize(self)
  do_size_allocate(self, allocation)
  do_unrealize(self)
  get_background(self)
  get_completion(self)
string get_empty_mask(self, start, end)
Gets the empty mask between start and end
  get_field(self)
  get_field_length(self, field)
  get_field_pos(self, field)
Get the position at the specified field.
  get_field_text(self, field)
list of strings get_fields(self)
Get the fields assosiated with the entry.
  get_icon_window(self)
  get_iter_by_data(self, data)
  get_iter_by_label(self, label)
  get_iter_from_obj(self, obj)
  get_mask(self)
Return the mask
  get_mode(self)
  get_selected_by_iter(self, treeiter)
  get_selected_data(self, treeiter)
  get_selected_label(self, treeiter)
  is_empty(self)
  prefill(self, itemdata, sort)
See kiwi.interfaces.IEasyCombo.prefill
  prop_set_completion(self, value)
  prop_set_exact_completion(self, value)
  prop_set_mask(self, value)
  set_completion(self, completion)
  set_exact_completion(self, value)
Enable exact entry completion.
  set_field(self, field, select)
  set_mask(self, mask)
Sets the mask of the Entry.
  set_pixbuf(self, pixbuf)
  set_tooltip(self, text)
  update_background(self, color)
    Inherited from PropertyObject
  do_get_property(self, pspec)
  do_set_property(self, pspec, value)
  get_attribute_names(self)
  is_default_value(self, attr, value)
    Inherited from ValidatableProxyWidgetMixin
  is_valid(self)
Return true if the widget is in validated state
  set_blank(self)
Changes the validation state to blank state, this only applies for mandatory widgets, draw an icon and set a tooltip
  set_invalid(self, text, fade)
Changes the validation state to invalid.
  set_valid(self)
Changes the validation state to valid, which will remove icons and reset the background color
  validate(self, force)
Checks if the data is valid.
    Inherited from ProxyWidgetMixin
  set_data_format(self, format)

Class Variable Summary
tuple allowed_data_types: A list of types which we are allowed to use in this class.

Instance Method Details

prop_set_data_type(self, data_type)

Set the data type for the widget
Parameters:
data_type - can be None, a type object or a string with the name of the type object, so None, "<type 'str'>" or 'str'
Overrides:
kiwi.ui.proxywidget.ProxyWidgetMixin.prop_set_data_type (inherited documentation)

read(self)

Get the content of the widget. The type of the return value
Returns:
None if the user input a invalid value
           (type=Must matche the data-type property.)
Overrides:
kiwi.ui.proxywidget.ProxyWidgetMixin.read (inherited documentation)

set_mask_for_data_type(self, data_type)

Parameters:
data_type -

set_text(self, text)

Sets the text of the entry
Parameters:
text -
Overrides:
kiwi.ui.entry.KiwiEntry.set_text

Class Variable Details

allowed_data_types

A list of types which we are allowed to use in this class.
Type:
tuple
Value:
(<type 'basestring'>,
 <type 'datetime.date'>,
 <type 'datetime.time'>,
 <type 'datetime.datetime'>,
 <type 'object'>,
 <type 'int'>,
 <type 'float'>,
 <type 'long'>,
...                                                                    

Generated by Epydoc 2.1 on Fri Mar 23 15:56:53 2007 http://epydoc.sf.net