traitsui.editors.list_str_editor module

Traits UI editor factory for editing lists of strings.

class traitsui.editors.list_str_editor.ListStrEditor(*args, **traits)[source]

Bases: BasicEditorFactory

Editor factory for list of string editors.

activated = Str()

The optional extended name of the trait to synchronize the activated value with:

activated_index = Str()

The optional extended name of the trait to synchronize the activated value’s index with:

adapter = Instance("traitsui.list_str_adapter.ListStrAdapter", ())

The adapter from list items to editor values:

adapter_name = Str()

The optional extended name of the trait containing the adapter:

auto_add = Bool(False)

Should a new item automatically be added to the end of the list to allow the user to create new entries?

drag_move = Bool(False)

Are ‘drag_move’ operations allowed (i.e. True), or should they always be treated as ‘drag_copy’ operations (i.e. False):

editable = Bool(True)

Can the user edit the values?

horizontal_lines = Bool(False)

Should horizontal lines be drawn between items?

images = List(ImageResource)

The set of images that can be used:

klass = Property()

The editor class to be created:

menu = Any()

Right-click context menu (Qt4 only). The value can be one of:

  • Instance( Menu ): Use this menu as the context menu

  • string: Name of traits that will provide menu

  • None: Use the default context menu

  • False: Do not display a context menu

multi_select = Bool(False)

Are multiple selected items allowed?

operations = List(

What type of operations are allowed on the list:

right_clicked = Str()

The optional extended name of the trait to synchronize the right clicked value with:

right_clicked_index = Str()

The optional extended name of the trait to synchronize the right clicked value’s index with:

selected = Str()

The optional extended name of the trait to synchronize the selection values with:

selected_index = Str()

The optional extended name of the trait to synchronize the selection indices with:

title = Str()

The title for the editor:

title_name = Str()

The optional extended name of the trait containing the editor title: