1 class Field(object):
   2     """A class to represent an input field on the dialog or command line."""
   3     def __init__(self, name, descr=None, default=None):
   4         """name: name of field
   5         descr: description to show to user
   6         default: default value."""
   7 
   8 class FieldText(Field):
   9     """Text entry on the dialog."""
  10 
  11 class FieldCombo(Field):
  12     """Drop-down combobox on dialog."""
  13     def __init__(self, name, descr=None, default=None, items=(),
  14                  editable=True):
  15         """name: name of field
  16         descr: description to show to user
  17         default: default value
  18         items: items in drop-down box
  19         editable: whether user can enter their own value."""
  20 
  21 class FieldWidget(Field):
  22     """Drop-down combobox for selecting widgets."""
  23 
  24     def __init__(self, name, descr=None, default='/', widgettypes=set()):
  25         """name: name of field
  26         descr: description to show to user
  27         default: default value
  28         widgettypes: set of types of widgets to show (leave blank for all)"""
  29 
  30 # _FieldSetting is an internally-derived from Field
  31 
  32 class FieldBool(_FieldSetting):
  33     """A true/false value using a check box."""
  34 
  35 class FieldInt(_FieldSetting):
  36     """An integer number field."""
  37 
  38     def __init__(self, name, descr=None, default=0,
  39                  minval=-9999999, maxval=9999999):
  40         """name: name of field
  41         descr: description to show to user
  42         default: default value.
  43         minval and maxval: minimum and maximum integers
  44         """
  45 
  46 class FieldFloat(_FieldSetting):
  47     """A floating point number field."""
  48 
  49     def __init__(self, name, descr=None, default=None,
  50                  minval=-1e99, maxval=1e99):
  51         """name: name of field
  52         descr: description to show to user
  53         default: default value.
  54         minval and maxval: minimum and maximum values
  55         """
  56 
  57 class FieldColor(_FieldSetting):
  58     """Field for selecting a color - returns #rrggbb string."""
  59     def __init__(self, name, descr=None, default='black'):
  60         ...
  61 
  62 class FieldFillStyle(_FieldSetting):
  63     """Field for selecting fill styles - returns a string."""
  64     def __init__(self, name, descr=None, default='solid'):
  65         ...
  66 
  67 class FieldLineStyle(_FieldSetting):
  68     """Field for selecting line styles - returns a string."""
  69     def __init__(self, name, descr=None, default='solid'):
  70         ...
  71 
  72 class FieldMarker(_FieldSetting):
  73     """Field for selecting a marker type.
  74 
  75     Returns a string
  76     """
  77     def __init__(self, name, descr=None, default='circle'):
  78         ...
  79 
  80 class FieldArrow(_FieldSetting):
  81     """Field for selecting an arrow type.
  82 
  83     Returns a string
  84     """
  85     def __init__(self, name, descr=None, default='none'):
  86         ...
  87 
  88 class FieldErrorStyle(_FieldSetting):
  89     """Field for selecting an error bar style
  90 
  91     Returns a string
  92     """
  93     def __init__(self, name, descr=None, default='bar'):
  94         ...
  95 
  96 class FieldDistance(_FieldSetting):
  97     """Field for selecting a veusz-style distance, e.g. '1pt'.
  98 
  99     Returns a string
 100     """
 101     def __init__(self, name, descr=None, default='1pt'):
 102         ...
 103 
 104 class FieldFloatList(_FieldSetting):
 105     """Field for entering multiple numbers, separated by commas or spaces
 106 
 107     Returns a list/tuple of floats
 108     """
 109     def __init__(self, name, descr=None, default=()):
 110         ...
 111 
 112 class FieldDataset(_FieldSetting):
 113     """Field for selecting a datset.
 114     Returns a string.
 115 
 116     Note that the validity of dataset names is not checked
 117     Note that a blank string may result
 118     """
 119 
 120     def __init__(self, name, descr=None, default='', dims=1,
 121                  datatype='numeric'):
 122         """name: name of field
 123         descr: description to show to user
 124         default: default value (ignored currently)
 125         dims: dimensions of dataset to show
 126         datatype: type of data: numeric or text
 127         """
 128 
 129 class FieldTextMulti(_FieldSetting):
 130     """Field for entering multiple lines of text.
 131     Returns a tuple/list of strings.
 132     """
 133     def __init__(self, name, descr=None, default=('')):
 134         ...
 135 
 136 class FieldDatasetMulti(_FieldSetting):
 137     """Field for entering multiple datasets.
 138     Returns a tuple/list of strings.
 139     """
 140     def __init__(self, name, descr=None, default=(''), dims=1,
 141                  datatype='numeric'):
 142         """dims is number of dimensions of datasets to show in
 143         drop-down list.
 144 
 145         datatype is 'numeric' or 'text'
 146         """
 147         ...
 148 
 149 class FieldLineMulti(_FieldSetting):
 150     """A field for holding a set of lines. Consists of tuples
 151     [('dotted', '1pt', 'color', <trans>, False), ...]
 152 
 153     These are style, width, color, and hide or
 154     style, widget, color, transparency, hide
 155 
 156     This is compatible with the contour widget line style
 157     """
 158 
 159     def __init__(self, name, descr=None,
 160                  default=(('solid', '1pt', 'black', False),) ):
 161         ...
 162 
 163 class FieldFillMulti(_FieldSetting):
 164     """A field for holding a set of fills. Consists of tuples
 165 
 166     [('solid', 'color', <trans>, False), ...]
 167 
 168     These are color, fill style, and hide or
 169     color, fill style, transparency and hide
 170 
 171     This is compatible with the contour widget line style
 172     """
 173 
 174     def __init__(self, name, descr=None, default=()):
 175         ...
 176 
 177 class FieldFontFamily(_FieldSetting):
 178     """A field for holding a font family.
 179 
 180     Returns a string.
 181     """
 182 
 183     def __init__(self, name, descr=None, default=None):
 184         """Default None selects the default font."""
 185         ...
 186 
 187 class FieldFilename(_FieldSetting):
 188     """Select a filename with a browse button."""
 189 
 190     def __init__(self, name, descr=None, default=''):
 191         ...