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

Type KiwiEntry

    object --+    
             |    
PropertyObject --+
                 |
    object --+   |
             |   |
      _GObject --+
                 |
                KiwiEntry

Known Subclasses:
ProxyEntry

The KiwiEntry is a Entry subclass with the following additions:
Method Summary
  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
list of strings get_field_text(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_mask(self, mask)
Sets the mask of the Entry.
  set_pixbuf(self, pixbuf)
  set_text(self, text)
  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)

Instance Method Details

get_empty_mask(self, start=None, end=None)

Gets the empty mask between start and end
Parameters:
start -
end -
Returns:
mask
           (type=string)

get_field_text(self)

Get the fields assosiated with the entry. A field is dynamic content separated by static. For example, the format string 000-000 has two fields separated by a dash. if a field is empty it'll return an empty string otherwise it'll include the content
Returns:
fields
           (type=list of strings)

get_mask(self)

Returns:
the mask

prefill(self, itemdata, sort=False)

See kiwi.interfaces.IEasyCombo.prefill

set_exact_completion(self, value)

Enable exact entry completion. Exact means it needs to start with the value typed and the case needs to be correct.
Parameters:
value - enable exact completion
           (type=boolean)

set_mask(self, mask)

Sets the mask of the Entry. Supported format characters are:
  • '0' digit
  • 'L' ascii letter (a-z and A-Z)
  • '&' alphabet, honors the locale
  • 'a' alphanumeric, honors the locale
  • 'A' alphanumeric, honors the locale

This is similar to MaskedTextBox: http://msdn2.microsoft.com/en-us/library/system.windows.forms.maskedtextbox.mask(VS.80).aspx

Example mask for a ISO-8601 date >>> entry.set_mask('0000-00-00')
Parameters:
mask - the mask to set

Generated by Epydoc 2.1 on Fri Sep 15 11:53:22 2006 http://epydoc.sf.net