k.u.w.e.ProxyEntry(KiwiEntry, ValidatableProxyWidgetMixin) : class documentation

Part of kiwi.ui.widgets.entry View In Hierarchy

Known subclasses: kiwi.ui.widgets.entry.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 __init__ Undocumented
Method __post_init__ A hook which is called after the constructor is called.
Method do_changed Undocumented
Method prop_set_data_type Set the data type for the widget
Method set_mask_for_data_type Set a mask for the parameter data_type.
Method set_completion_strings Set strings used for entry completion.
Method set_text Sets the text of the entry
Method read Get the content of the widget.
Method update Update the content value of the widget.

Inherited from KiwiEntry:

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_mask Sets the mask of the Entry.
Method get_mask Get the mask.
Method get_field_text Undocumented
Method get_fields Get the fields assosiated with the entry.
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.
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 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
Method _get_next_non_static_char_pos Get next non-static char position, skiping some chars, if necessary.
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
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
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 (via KiwiEntry):

Class Method __class_init__ Undocumented
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

Inherited from ValidatableProxyWidgetMixin:

Method update_background Implement in subclass
Method get_background Implement in subclass
Method set_pixbuf Implement in subclass
Method get_icon_window Implement in subclass
Method set_tooltip Implement in subclass
Method is_valid Verify the widget state.
Method validate Checks if the data is valid.
Method set_valid Changes the validation state to valid, which will remove icons and
Method set_invalid Changes the validation state to invalid.
Method set_blank Changes the validation state to blank state, this only applies
Method _set_valid_state Updates the validation state and emits a signal iff it changed
Method _draw_stock_icon Undocumented
Method _on_fadeout__color_changed Undocumented

Inherited from ProxyWidgetMixin (via ValidatableProxyWidgetMixin):

Method set_data_format Undocumented
Method set_options_for_datatype Set some options to be passed to the datatype converter.
Method _as_string Convert a value to a string
Method _from_string Convert a string to the data type of the widget
def __init__(self, data_type=None):
Undocumented
def __post_init__(self):
A hook which is called after the constructor is called. It's mainly here to workaround http://bugzilla.gnome.org/show_bug.cgi?id=425501 so you can set properties at construction time
def do_changed(self):
Undocumented
def prop_set_data_type(self, data_type):
Set the data type for the widget
Parametersdata_typecan be None, a type object or a string with the name of the type object, so None, "<type 'str'>" or 'str'
def set_mask_for_data_type(self, data_type):
Set a mask for the parameter data_type.
Parametersdata_type
def set_completion_strings(self, strings=, values=):
Set strings used for entry completion. If values are provided, each string will have an additional data type.
Parametersstrings (type: list of strings )
values (type: list of values )
def set_text(self, text):
Sets the text of the entry
Parameterstext
def read(self):
Get the content of the widget. The type of the return value
ReturnsNone if the user input a invalid value (type: Must matche the data-type property. )
def update(self, data):
Update the content value of the widget.
Parametersvalue
API Documentation for Kiwi, generated by pydoctor at 2010-05-20 02:10:57.