Inherits from
- HasPrivateTraits: enthought.traits.has_traits.HasPrivateTraits
Attributes
- allowed
A callable function that returns whether the passed object is allowed by the filter
allowed = Callable(lambda object: True, transient = True)
- desc
A user-readable description of what kind of object satisfies the filter
desc = Str('All items')
- filter_view
filter_view = Group()
- ignored_traits
Traits that are ignored by the _anytrait_changed() handler
ignored_traits = [ '_name', 'template', 'desc' ]
- name
UI name of this filter (so the user can identify it in the UI)
name = Str('Default filter')
- search_view
search_view = Group(Include('filter_view'))
- searchable_view
searchable_view = View([ [ Include('search_view'), '|[]' ], [ 'handler.status~', '|[]<>' ], [ 'handler.find_next`Find the next matching item`', 'handler.find_previous`Find the previous matching item`', 'handler.select`Select all matching items`', 'handler.OK`Exit search`', '-<>' ], '|<>' ], title = 'Search for', kind = 'livemodal', width = 0.25)
- template
Is the filter a template (i.e., non-deletable, non-editable)?
template = Bool(False)
- traits_view
traits_view = View('name{Filter name}', '_', Include('filter_view'), title = 'Edit Filter', width = 0.20000000000000001, buttons = [ 'OK', 'Cancel', Action(name = 'Help', action = 'show_help', defined_when = "ui.view_elements.content['filter_view'].help_id != ''") ])
Inherited from base classes
Method summary
- __str__(self)
- description(self)
- edit(self, object)
- filter(self, object)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __str__(self)
- description(self)
Returns a user-readable description of what kind of object satisfies the filter.
- edit(self, object)
Edits the contents of the filter.
The ''object'' parameter is a sample object for the table that the filter will be applied to. It is supplied in case the filter needs to extract data or metadata from the object. If the table is empty, the ''object'' argument is None.
- filter(self, object)
Returns whether a specified object meets the filter or search criteria.