kiwi.ui.objectlist.Column(PropertyObject, gobject.GObject) class documentation

Specifies a column for an L{ObjectList}, see the ObjectList documentation
for a simple example.

Properties
==========
  - B{title}: string I{mandatory}
    - the title of the column, defaulting to the capitalized form of
      the attribute
  - B{data-type}: object I{str}
    - the type of the attribute that will be inserted into the column.
      Supported data types: bool, int, float, str, unicode,
      decimal.Decimal, datetime.date, datetime.time, datetime.datetime,
      gtk.gdk.Pixbuf, L{kiwi.currency.currency}, L{kiwi.python.enum}.
  - B{visible}: bool I{True}
    - specifying if it is initially hidden or shown.
  - B{justify}: gtk.Justification I{None}
    - one of gtk.JUSTIFY_LEFT, gtk.JUSTIFY_RIGHT or gtk.JUSTIFY_CENTER
      or None. If None, the justification will be determined by the type
      of the attribute value of the first instance to be inserted in the
      ObjectList (for instance numbers will be right-aligned).
  - B{format}: string I{""}
    - a format string to be applied to the attribute value upon insertion
      in the list.
  - B{width}: integer I{65535}
    - the width in pixels of the column, if not set, uses the default to
      ObjectList. If no Column specifies a width, columns_autosize() will
      be called on the ObjectList upon append() or the first add_list().
  - B{sorted}: bool I{False}
    - whether or not the ObjectList is to be sorted by this column.
      If no Columns are sorted, the ObjectList will be created unsorted.
  - B{order}: GtkSortType I{-1}
    - one of gtk.SORT_ASCENDING, gtk.SORT_DESCENDING or -1
      The value -1 is mean that the column is not sorted.
  - B{expand}: bool I{False}
    - if set column will expand. Note: this space is shared equally amongst
      all columns that have the expand set to True.
  - B{tooltip}: string I{""}
    - a string which will be used as a tooltip for the column header
  - B{format_func}: object I{None}
    -  a callable which will be used to format the output of a column.
       The function will take one argument which is the value to convert
       and is expected to return a string.
       I{Note}: that you cannot use format and format_func at the same time,
       if you provide a format function you'll be responsible for
       converting the value to a string.
  - B{editable}: bool I{False}
    - if true the field is editable and when you modify the contents of
      the cell the model will be updated.
  - B{searchable}: bool I{False}
    - if true the attribute values of the column can be searched using
      type ahead search. Only string attributes are currently supported.
  - B{radio}: bool I{False}
    -  If true render the column as a radio instead of toggle.
       Only applicable for columns with boolean data types.
  - B{spin_adjustment}: gtk.Adjustment I{None}
    -  A gtk.Adjustment instance. If set, render the column cell as
       a spinbutton.
  - B{use_stock}: bool I{False}
    - If true, this will be rendered as pixbuf from the value which
      should be a stock id.
  - B{icon_size}: gtk.IconSize I{gtk.ICON_SIZE_MENU}
  - B{editable_attribute}: string I{""}
    - a string which is the attribute which should decide if the
      cell is editable or not.
  - B{use_markup}: bool I{False}
    - If true, the text will be rendered with markup
  - B{expander}: bool I{False}
    - If True, this column will be used as the tree expander column
  - B{ellipsize}: pango.EllipsizeMode I{pango.ELLIPSIZE_NONE}
    - One of pango.ELLIPSIZE_{NONE, START, MIDDLE_END}, it describes
      where characters should be removed in case ellipsization
      (where to put the ...) is needed.
  - B{font-desc}: str I{""}
    - A string passed to pango.FontDescription, for instance "Sans" or
  - B{column}: str None
    - A string referencing to another column. If this is set a new column
      will not be created and the column will be packed into the other.