Known subclasses: kiwi.ui.widgets.entry.ProxyEntry

The KiwiEntry is a Entry subclass with the following additions:

  - IconEntry, allows you to have an icon inside the entry
  - Mask, force the input to meet certain requirements
  - IComboMixin: Allows you work with objects instead of strings
    Adds a number of convenience methods such as L{prefill}().
Method __init__ Undocumented
Method do_size_allocate 0 Undocumented
Method do_size_allocate Undocumented
Method do_expose_event Undocumented
Method do_realize Undocumented
Method do_unrealize Undocumented
Method prop_set_exact_completion Undocumented
Method prop_set_completion Undocumented
Method prop_set_mask Undocumented
Method set_text Undocumented
Method set_mask No summary
Method get_mask Get the mask. @returns: the mask
Method get_field_text Undocumented
Method get_fields No summary
Method get_empty_mask Gets the empty mask between start and end
Method get_field_pos Get the position at the specified field.
Method get_field Undocumented
Method set_field Undocumented
Method get_field_length Undocumented
Method set_exact_completion Enable exact entry completion. Exact means it needs to start with the value typed and the case needs to be correct.
Method is_empty Undocumented
Method get_completion Undocumented
Method set_completion Undocumented
Method set_tooltip Undocumented
Method set_pixbuf Undocumented
Method update_background Undocumented
Method get_background Undocumented
Method get_icon_window Undocumented
Method prefill See L{kiwi.interfaces.IEasyCombo.prefill}
Method get_iter_by_data Undocumented
Method get_iter_by_label Undocumented
Method get_selected_by_iter Undocumented
Method get_selected_label Undocumented
Method get_selected_data Undocumented
Method get_iter_from_obj Undocumented
Method get_mode Undocumented
Method _get_field_ideal_pos Undocumented
Method _shift_text Shift the text, to the right or left, n positions. Note that this does not change the entry text. It returns the shifted text.
Method _get_next_non_static_char_pos Get next non-static char position, skiping some chars, if necessary. @param skip: skip first n chars @param direction: direction of the search.
Method _get_field_at_pos Return the field index at position pos.
Method _really_delete_text Undocumented
Method _really_insert_text Undocumented
Method _insert_mask Undocumented
Method _confirms_to_mask Undocumented
Method _update_current_object Undocumented
Method _get_text_from_object Undocumented
Method _get_completion Undocumented
Method _completion_exact_match_func Undocumented
Method _completion_normal_match_func Undocumented
Method _on_completion__match_selected Undocumented
Method _appers_later Check if a char appers later on the mask. If it does, return the field it appers at. returns False otherwise.
Method _can_insert_at_pos Check if a chararcter can be inserted at some position
Method _insert_at_pos Inserts the character at the give position in text. Note that the insertion won't be applied to the entry, but to the text provided.
Method _on_insert_text Undocumented
Method _on_delete_text Undocumented
Method _after_grab_focus Undocumented
Method _on_focus Undocumented
Method _on_notify_selection_bound Undocumented
Method _handle_position_change Undocumented
Method _on_changed Undocumented
Method _on_focus_out_event Undocumented
Method _on_move_cursor Undocumented

Inherited from PropertyObject:

Class Method __class_init__ Undocumented
Method __post_init__ No summary
Method get_attribute_names Undocumented
Method is_default_value Undocumented
Method do_set_property Undocumented
Method do_get_property Undocumented
Method _set Undocumented
Method _get Undocumented
def __init__(self):
def do_size_allocate 0(self, allocation):
Undocumented
def do_size_allocate(self, allocation):
Undocumented
def do_expose_event(self, event):
Undocumented
def do_realize(self):
Undocumented
def do_unrealize(self):
Undocumented
def prop_set_exact_completion(self, value):
Undocumented
def prop_set_completion(self, value):
Undocumented
def prop_set_mask(self, value):
Undocumented
def set_text(self, text):
Undocumented
def 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:
U{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')

@param mask: the mask to set
def get_mask(self):
Get the mask.
@returns: the mask
def get_field_text(self, field):
Undocumented
def get_fields(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
@rtype: list of strings
def get_empty_mask(self, start=None, end=None):
Gets the empty mask between start and end

@param start:
@param end:
@returns: mask
@rtype: string
def get_field_pos(self, field):
Get the position at the specified field.
def _get_field_ideal_pos(self, field):
Undocumented
def get_field(self):
Undocumented
def set_field(self, field, select=False):
Undocumented
def get_field_length(self, field):
Undocumented
def _shift_text(self, start, end, direction=Direction.LEFT, positions=1):
Shift the text, to the right or left, n positions. Note that this
does not change the entry text. It returns the shifted text.

@param start:
@param end:
@param direction:   see L{kiwi.enums.Direction}
@param positions:   the number of positions to shift.

@return:        returns the text between start and end, shifted to
                the direction provided.
def _get_next_non_static_char_pos(self, pos, direction=Direction.LEFT, skip=0):
Get next non-static char position, skiping some chars, if necessary.
@param skip:        skip first n chars
@param direction:   direction of the search.
def _get_field_at_pos(self, pos, dir=None):
Return the field index at position pos.
def 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.

@param value: enable exact completion
@type value:  boolean
def is_empty(self):
Undocumented
def _really_delete_text(self, start, end):
Undocumented
def _really_insert_text(self, text, position):
Undocumented
def _insert_mask(self, start, end):
Undocumented
def _confirms_to_mask(self, position, text):
Undocumented
def _update_current_object(self, text):
Undocumented
def _get_text_from_object(self, obj):
Undocumented
def _get_completion(self):
Undocumented
def get_completion(self):
Undocumented
def set_completion(self, completion):
Undocumented
def _completion_exact_match_func(self, completion, key, iter):
Undocumented
def _completion_normal_match_func(self, completion, key, iter):
Undocumented
def _on_completion__match_selected(self, completion, model, iter):
Undocumented
def _appers_later(self, char, start):
Check if a char appers later on the mask. If it does, return
the field it appers at. returns False otherwise.
def _can_insert_at_pos(self, new, pos):
Check if a chararcter can be inserted at some position

@param new: The char that wants to be inserted.
@param pos: The position where it wants to be inserted.

@return: Returns None if it can be inserted. If it cannot be,
         return the next position where it can be successfuly
         inserted.
def _insert_at_pos(self, text, new, pos):
Inserts the character at the give position in text. Note that the
insertion won't be applied to the entry, but to the text provided.

@param text:    Text that it will be inserted into.
@param new:     New text to insert.
@param pos:     Positon to insert at

@return:    Returns a tuple, with the position after the insetion
            and the new text.
def _on_insert_text(self, editable, new, length, position):
Undocumented
def _on_delete_text(self, editable, start, end):
Undocumented
def _after_grab_focus(self, widget):
Undocumented
def _on_focus(self, widget, direction):
Undocumented
def _on_notify_selection_bound(self, widget, pspec):
Undocumented
def _handle_position_change(self):
Undocumented
def _on_changed(self, widget):
Undocumented
def _on_focus_out_event(self, widget, event):
Undocumented
def _on_move_cursor(self, entry, step, count, extend_selection):
Undocumented
def set_tooltip(self, text):
Undocumented
def set_pixbuf(self, pixbuf):
Undocumented
def update_background(self, color):
Undocumented
def get_background(self):
Undocumented
def get_icon_window(self):
Undocumented
def prefill(self, itemdata, sort=False):
See L{kiwi.interfaces.IEasyCombo.prefill}
def get_iter_by_data(self, data):
Undocumented
def get_iter_by_label(self, label):
Undocumented
def get_selected_by_iter(self, treeiter):
Undocumented
def get_selected_label(self, treeiter):
Undocumented
def get_selected_data(self, treeiter):
Undocumented
def get_iter_from_obj(self, obj):
Undocumented
def get_mode(self):
Undocumented
API Documentation for Kiwi, generated by pydoctor at 2019-08-08 02:24:42.