### Navigation

- index
- modules |
- next |
- previous |
- Camelot documentation »
- Camelot API »
- view »
- controls »

# delegates

Camelot includes a number of Qt delegates, most of them are used as default delegates for the various sqlalchemy and camelot field types.

Some delegates take specific arguments into account for their construction. All `field_attributes` specified for a certain field will be propagated towards the constructor of the delegate. Some of them will be used by the delegate itself, others will be used by the editor, created by the delegate.

## BoolDelegate

Custom delegate for boolean values

By default, creates a BoolEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - minimum
> - maximum
> - nullable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## ChartDelegate

Custom delegate for Matplotlib charts

## CodeDelegate

Field attributes supported by the delegate :

> - parts
> - separator

By default, creates a CodeEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - parts
> - editable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## ColorDelegate

By default, creates a ColorEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## ColoredFloatDelegate

Custom delegate for float values.

> The class attribute icons is used to customize the icons displayed.

Field attributes supported by the delegate :

> - minimum
> - maximum
> - precision
> - reverse
> - neutral
> - unicode_format

By default, creates a ColoredFloatEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - precision
> - reverse
> - neutral
> - option
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip
> - prefix
> - suffix
> - minimum
> - maximum
> - single_step

## ComboBoxDelegate

By default, creates a ChoicesEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - nullable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - choices

## CurrencyDelegate

Custom delegate for currency values

## DateDelegate

Custom delegate for date values

Field attributes supported by the delegate :

By default, creates a DateEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - nullable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## DateTimeDelegate

Field attributes supported by the delegate :

> - editable

By default, creates a DateTimeEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - nullable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## EnumerationDelegate

Contrary to the comboboxdelegate, the enumeration delegate does not support dynamic
  choices

Field attributes supported by the delegate :

> - choices
> - editable

By default, creates a ChoicesEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - nullable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - choices

## FileDelegate

Delegate for camelot.types.file fields. Expects values of type camelot.core.files.storage.StoredFile.

By default, creates a FileEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - storage
> - field_name
> - remove_original

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip
> - remove_original

## FloatDelegate

Custom delegate for float values

Field attributes supported by the delegate :

> - minimum
> - maximum
> - unicode_format

By default, creates a FloatEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - minimum
> - maximum
> - calculator
> - decimal
> - option
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip
> - prefix
> - suffix
> - precision
> - single_step

## ImageDelegate

## IntegerDelegate

Custom delegate for integer values

Field attributes supported by the delegate :

> - minimum
> - maximum
> - unicode_format

By default, creates a IntegerEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - minimum
> - maximum
> - calculator
> - option
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip
> - prefix
> - suffix
> - nullable
> - single_step

## IntervalsDelegate

Custom delegate for visualizing camelot.container.IntervalsContainer
  data:

## LabelDelegate

Delegate to display an attribute as a label

By default, creates a LabelEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - text
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## LanguageDelegate

## LocalFileDelegate

Delegate for displaying a path on the local file system. This path can
  either point to a file or a directory

Field attributes supported by the delegate :

By default, creates a LocalFileEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - field_name
> - directory
> - save_as
> - file_filter

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## Many2OneDelegate

Custom delegate for many 2 one relations

> Once an item has been selected, it is represented by its unicode representation in the editor or the table. So the related classes need an implementation of their __unicode__ method.

Field attributes supported by the delegate :

> - admin
> - embedded
> - editable

By default, creates a Many2OneEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - admin
> - editable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## ManyToManyDelegate

## ManyToOneChoicesDelegate

Display a ManyToOne field as a ComboBox, filling the list of choices with

  the objects of the target class.

  The items in the ComboBox are the unicode representation of the related objects. So these classes need an implementation of their __unicode__ method to show up in a human readable way in the ComboBox.

## MonthsDelegate

MonthsDelegate

> custom delegate for showing and editing months and years

Field attributes supported by the delegate :

> - forever

By default, creates a MonthsEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## NoteDelegate

By default, creates a NoteEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## One2ManyDelegate

Custom delegate for many 2 one relations

Field attributes supported by the delegate :

## PlainTextDelegate

Custom delegate for simple string values

Field attributes supported by the delegate :

> - length
> - editable
> - translate_content

By default, creates a TextLineEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - length
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## RichTextDelegate

Custom delegate for rich text (HTML) string values

Field attributes supported by the delegate :

> - editable

By default, creates a RichTextEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color

## SmileyDelegate

Delegate for Smiley’s

Field attributes supported by the delegate :

> - editable
> - icons

By default, creates a SmileyEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - icons
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## StarDelegate

Delegate for integer values from (1 to 5)(Rating Delegate)

Field attributes supported by the delegate :

> - editable
> - maximum

By default, creates a StarEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - maximum
> - editable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## TextBoolDelegate

## TextEditDelegate

Custom delegate for simple string values

Field attributes supported by the delegate :

By default, creates a TextEditEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - length
> - editable
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## TimeDelegate

Field attributes supported by the delegate :

> - editable

By default, creates a TimeEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - field_name
> - format

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

## VirtualAddressDelegate

Field attributes supported by the delegate :

> - editable
> - address_type

By default, creates a VirtualAddressEditor as its editor.

Field Attributes | Editor
editable=False tooltip=’tooltip’ |
editable=True |
editable=True tooltip=’tooltip’ |
editable=False |
editable=False background_color=ColorScheme.green |
editable=True background_color=ColorScheme.green |

Static attributes supported by this editor :

> - editable
> - address_type
> - address_validator
> - field_name

Dynamic field attributes supported by the editor :

> - editable
> - background_color
> - tooltip

class `camelot.view.controls.delegates.``DelegateManager`(parent=None, **kwargs)

  Manages custom delegates, should not be used by the application developer

  `createEditor`(parent, option, index)

    Use a custom delegate createEditor method if it exists

  `insertColumnDelegate`(column, delegate)

    Inserts a custom column delegate

  `paint`(painter, option, index)

    Use a custom delegate paint method if it exists

  `removeColumnDelegate`(column)

    Removes custom column delegate

  `setEditorData`(editor, index)

    Use a custom delegate setEditorData method if it exists

  `setModelData`(editor, model, index)

    Use a custom delegate setModelData method if it exists

class `camelot.view.controls.delegates.``BoolDelegate`(parent=None, editable=True, **kwargs)

  Custom delegate for boolean values

  By default, creates a BoolEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - minimum
  > - maximum
  > - nullable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `BoolEditor`

class `camelot.view.controls.delegates.``ChartDelegate`(parent=None, **kwargs)

  Custom delegate for Matplotlib charts

  `editor`

    alias of `ChartEditor`

class `camelot.view.controls.delegates.``CodeDelegate`(parent=None, parts=[], separator=u'.', **kwargs)

  Field attributes supported by the delegate :

  > - parts
  > - separator

  By default, creates a CodeEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - parts
  > - editable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``ColorDelegate`(parent=None, editable=True, **kwargs)

  By default, creates a ColorEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``ColoredFloatDelegate`(parent=None, minimum=-1000000000000000.0, maximum=1000000000000000.0, precision=2, reverse=False, neutral=False, unicode_format=None, **kwargs)

  Custom delegate for float values.

  > The class attribute icons is used to customize the icons displayed.

  Field attributes supported by the delegate :

  > - minimum
  > - maximum
  > - precision
  > - reverse
  > - neutral
  > - unicode_format

  By default, creates a ColoredFloatEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - precision
  > - reverse
  > - neutral
  > - option
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip
  > - prefix
  > - suffix
  > - minimum
  > - maximum
  > - single_step

  `editor`

    alias of `ColoredFloatEditor`

class `camelot.view.controls.delegates.``ComboBoxDelegate`(parent=None, editable=True, **kwargs)

  By default, creates a ChoicesEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - nullable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - choices

  `editor`

    alias of `ChoicesEditor`

class `camelot.view.controls.delegates.``CurrencyDelegate`(minimum=-1000000000000000.0, maximum=1000000000000000.0, parent=None, unicode_format=None, **kwargs)

  Custom delegate for currency values

class `camelot.view.controls.delegates.``CustomDelegate`(parent=None, editable=True, **kwargs)

  Base class for implementing custom delegates.

  `editor`

  class attribute specifies the editor class that should be used

  `createEditor`(parent, option, index)

    Parameters: | option – use an option with version 5 to indicate the widget

    will be put onto a form

  `paint_text`(painter, option, index, text, margin_left=0, margin_right=0, horizontal_align=1, vertical_align=128)

    Paint unicode text into the given rect defined by option, and fill the rect with the background color :arg margin_left: additional margin to the left, to be used for icons or others :arg margin_right: additional margin to the right, to be used for icons or others

  `render_html`(index)

    Generator that renders a value to html

  `render_ooxml`(value)

    Generator for label text in Office Open XML representing this form

class `camelot.view.controls.delegates.``DateDelegate`(parent=None, **kwargs)

  Custom delegate for date values

  Field attributes supported by the delegate :

  By default, creates a DateEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - nullable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `DateEditor`

class `camelot.view.controls.delegates.``DateTimeDelegate`(parent=None, editable=True, **kwargs)

  Field attributes supported by the delegate :

  > - editable

  By default, creates a DateTimeEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - nullable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `DateTimeEditor`

class `camelot.view.controls.delegates.``EnumerationDelegate`(parent=None, choices=[], editable=True, **kwargs)
  Contrary to the comboboxdelegate, the enumeration delegate does not support dynamic
    choices

  Field attributes supported by the delegate :

  > - choices
  > - editable

  By default, creates a ChoicesEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - nullable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - choices

  `editor`

    alias of `ChoicesEditor`

class `camelot.view.controls.delegates.``FileDelegate`(parent=None, editable=True, **kwargs)

  Delegate for camelot.types.file fields. Expects values of type camelot.core.files.storage.StoredFile.

  By default, creates a FileEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - storage
  > - field_name
  > - remove_original

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip
  > - remove_original

  `editor`

    alias of `FileEditor`

class `camelot.view.controls.delegates.``FloatDelegate`(minimum=-1000000000000000.0, maximum=1000000000000000.0, parent=None, unicode_format=None, **kwargs)

  Custom delegate for float values

  Field attributes supported by the delegate :

  > - minimum
  > - maximum
  > - unicode_format

  By default, creates a FloatEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - minimum
  > - maximum
  > - calculator
  > - decimal
  > - option
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip
  > - prefix
  > - suffix
  > - precision
  > - single_step

  `editor`

    alias of `FloatEditor`

class `camelot.view.controls.delegates.``ImageDelegate`(parent=None, editable=True, **kwargs)
  `editor`

    alias of `ImageEditor`

class `camelot.view.controls.delegates.``IntegerDelegate`(minimum=-2147483648, maximum=2147483647, parent=None, unicode_format=None, **kwargs)

  Custom delegate for integer values

  Field attributes supported by the delegate :

  > - minimum
  > - maximum
  > - unicode_format

  By default, creates a IntegerEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - minimum
  > - maximum
  > - calculator
  > - option
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip
  > - prefix
  > - suffix
  > - nullable
  > - single_step

  `editor`

    alias of `IntegerEditor`

class `camelot.view.controls.delegates.``IntervalsDelegate`(parent=None, editable=True, **kwargs)
  Custom delegate for visualizing camelot.container.IntervalsContainer
    data:

class `camelot.view.controls.delegates.``LocalFileDelegate`(parent=None, **kw)
  Delegate for displaying a path on the local file system. This path can
    either point to a file or a directory

  Field attributes supported by the delegate :

  By default, creates a LocalFileEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - field_name
  > - directory
  > - save_as
  > - file_filter

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `LocalFileEditor`

class `camelot.view.controls.delegates.``ManyToManyDelegate`(parent=None, **kwargs)

class `camelot.view.controls.delegates.``Many2OneDelegate`(parent=None, admin=None, embedded=False, editable=True, **kwargs)

  Custom delegate for many 2 one relations

  > Once an item has been selected, it is represented by its unicode representation in the editor or the table. So the related classes need an implementation of their __unicode__ method.

  Field attributes supported by the delegate :

  > - admin
  > - embedded
  > - editable

  By default, creates a Many2OneEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - admin
  > - editable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `Many2OneEditor`

class `camelot.view.controls.delegates.``One2ManyDelegate`(parent=None, **kwargs)

  Custom delegate for many 2 one relations

  Field attributes supported by the delegate :

class `camelot.view.controls.delegates.``ManyToOneChoicesDelegate`(parent=None, editable=True, **kwargs)

  Display a ManyToOne field as a ComboBox, filling the list of choices with the objects of the target class.

  The items in the ComboBox are the unicode representation of the related objects. So these classes need an implementation of their __unicode__ method to show up in a human readable way in the ComboBox.

class `camelot.view.controls.delegates.``PlainTextDelegate`(parent=None, length=20, editable=True, translate_content=False, **kw)

  Custom delegate for simple string values

  Field attributes supported by the delegate :

  > - length
  > - editable
  > - translate_content

  By default, creates a TextLineEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - length
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``RichTextDelegate`(parent=None, editable=True, **kwargs)

  Custom delegate for rich text (HTML) string values

  Field attributes supported by the delegate :

  > - editable

  By default, creates a RichTextEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color

class `camelot.view.controls.delegates.``StarDelegate`(parent=None, editable=True, maximum=5, **kwargs)

  Delegate for integer values from (1 to 5)(Rating Delegate)

  Field attributes supported by the delegate :

  > - editable
  > - maximum

  By default, creates a StarEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - maximum
  > - editable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``TextEditDelegate`(parent=None, **kwargs)

  Custom delegate for simple string values

  Field attributes supported by the delegate :

  By default, creates a TextEditEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - length
  > - editable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``TimeDelegate`(parent=None, editable=True, **kwargs)

  Field attributes supported by the delegate :

  > - editable

  By default, creates a TimeEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - field_name
  > - format

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``VirtualAddressDelegate`(parent=None, editable=True, address_type=None, **kwargs)

  Field attributes supported by the delegate :

  > - editable
  > - address_type

  By default, creates a VirtualAddressEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - address_type
  > - address_validator
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``SmileyDelegate`(parent, editable=True, icons=[('face-angel', Icon('tango/16x16/emotes/face-angel.png')), ('face-crying', Icon('tango/16x16/emotes/face-crying.png')), ('face-devilish', Icon('tango/16x16/emotes/face-devilish.png')), ('face-glasses', Icon('tango/16x16/emotes/face-glasses.png')), ('face-grin', Icon('tango/16x16/emotes/face-grin.png')), ('face-kiss', Icon('tango/16x16/emotes/face-kiss.png')), ('face-monkey', Icon('tango/16x16/emotes/face-monkey.png')), ('face-plain', Icon('tango/16x16/emotes/face-plain.png')), ('face-sad', Icon('tango/16x16/emotes/face-sad.png')), ('face-smile', Icon('tango/16x16/emotes/face-smile.png')), ('face-smile-big', Icon('tango/16x16/emotes/face-smile-big.png')), ('face-surprise', Icon('tango/16x16/emotes/face-surprise.png')), ('face-wink', Icon('tango/16x16/emotes/face-wink.png'))], **kwargs)

  Delegate for Smiley’s

  Field attributes supported by the delegate :

  > - editable
  > - icons

  By default, creates a SmileyEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - icons
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``NoteDelegate`(parent=None, **kwargs)

  By default, creates a NoteEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `NoteEditor`

class `camelot.view.controls.delegates.``LabelDelegate`(parent=None, editable=True, **kwargs)

  Delegate to display an attribute as a label

  By default, creates a LabelEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - text
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

class `camelot.view.controls.delegates.``MonthsDelegate`(parent=None, forever=2400, **kwargs)

  MonthsDelegate

  > custom delegate for showing and editing months and years

  Field attributes supported by the delegate :

  > - forever

  By default, creates a MonthsEditor as its editor.

  Field Attributes | Editor
  editable=False tooltip=’tooltip’ |
  editable=True |
  editable=True tooltip=’tooltip’ |
  editable=False |
  editable=False background_color=ColorScheme.green |
  editable=True background_color=ColorScheme.green |

  Static attributes supported by this editor :

  > - editable
  > - field_name

  Dynamic field attributes supported by the editor :

  > - editable
  > - background_color
  > - tooltip

  `editor`

    alias of `MonthsEditor`

- booldelegate
- chartdelegate
- codedelegate
- colordelegate
- coloredfloatdelegate
- comboboxdelegate
- currencydelegate
- customdelegate
- datedelegate
- datetimedelegate
- delegatemanager
- enumerationdelegate
- filedelegate
- floatdelegate
- imagedelegate
- integerdelegate
- intervalsdelegate
- labeldelegate
- languagedelegate
- localfiledelegate
- many2onedelegate
- manytomanydelegate
- manytoonechoicesdelegate
- monthsdelegate
- notedelegate
- one2manydelegate
- plaintextdelegate
- richtextdelegate
- smileydelegate
- stardelegate
- texteditdelegate
- timedelegate
- virtualaddressdelegate

### Navigation

- index
- modules |
- next |
- previous |
- Camelot documentation »
- Camelot API »
- view »
- controls »

Comments
blog comments powered by Disqus