kiwi.ui.search.SearchContainer(gtk.VBox)
class documentationkiwi.ui.search
(View In Hierarchy)
A search container is a widget which consists of: - search entry (w/ a label) (L{StringSearchFilter}) - search button - objectlist result (L{SearchResult}) - a query executer (L{kiwi.db.query.QueryExecuter}) Additionally you can add a number of search filters to the SearchContainer. You can chose if you want to add the filter in the top-left corner of bottom, see L{SearchFilterPosition}
Method | __init__ | Create a new SearchContainer object. @param columns: a list of L{kiwi.ui.objectlist.Column} @param chars: maximum number of chars used by the search entry |
Method | do_set_property | Undocumented |
Method | do_get_property | Undocumented |
Method | do_set_child_property | Undocumented |
Method | do_get_child_property | Undocumented |
Method | add_filter | No summary |
Method | set_filter_position | Set the the filter position. @param search_filter: @param position: |
Method | get_filter_position | Get filter by position. @param search_filter: |
Method | set_query_executer | Ties a QueryExecuter instance to the SearchContainer class @param querty_executer: a querty executer @type querty_executer: a L{QueryExecuter} subclass |
Method | get_query_executer | Fetchs the QueryExecuter for the SearchContainer @returns: a querty executer @rtype: a L{QueryExecuter} subclass |
Method | get_primary_filter | No summary |
Method | search | Starts a search. Fetches the states of all filters and send it to a query executer and finally puts the result in the result class |
Method | set_auto_search | Enables/Disables auto search which means that the search result box is automatically populated when a filter changes @param auto_search: True to enable, False to disable |
Method | set_text_field_columns | Undocumented |
Method | disable_search_entry | Disables the search entry |
Method | set_summary_label | No summary |
Method | _on_search_button__clicked | Undocumented |
Method | _on_search_entry__activate | Undocumented |
Method | _on_search_filter__changed | Undocumented |
Method | _create_ui | Undocumented |
Create a new SearchContainer object. @param columns: a list of L{kiwi.ui.objectlist.Column} @param chars: maximum number of chars used by the search entry
Adds a search filter @param search_filter: the search filter @param postition: a L{SearchFilterPosition} enum @param columns: @param callback:
Set the the filter position. @param search_filter: @param position:
Ties a QueryExecuter instance to the SearchContainer class @param querty_executer: a querty executer @type querty_executer: a L{QueryExecuter} subclass
Fetchs the QueryExecuter for the SearchContainer @returns: a querty executer @rtype: a L{QueryExecuter} subclass
Fetches the primary filter for the SearchContainer. The primary filter is the filter attached to the standard entry normally used to do free text searching @returns: the primary filter
Starts a search. Fetches the states of all filters and send it to a query executer and finally puts the result in the result class
Enables/Disables auto search which means that the search result box is automatically populated when a filter changes @param auto_search: True to enable, False to disable