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 FieldFloatOrAuto(_FieldSetting):
  58     """A floating point value or the text 'Auto'. (Version >= 1.16)"""
  59 
  60     def __init__(self, name, descr=None, default='Auto'):
  61         """name: name of field
  62         descr: description to show to user
  63         default: default value.
  64         """
  65 
  66 class FieldColor(_FieldSetting):
  67     """Field for selecting a color - returns #rrggbb string."""
  68     def __init__(self, name, descr=None, default='black'):
  69         ...
  70 
  71 class FieldFillStyle(_FieldSetting):
  72     """Field for selecting fill styles - returns a string."""
  73     def __init__(self, name, descr=None, default='solid'):
  74         ...
  75 
  76 class FieldLineStyle(_FieldSetting):
  77     """Field for selecting line styles - returns a string."""
  78     def __init__(self, name, descr=None, default='solid'):
  79         ...
  80 
  81 class FieldMarker(_FieldSetting):
  82     """Field for selecting a marker type.
  83 
  84     Returns a string
  85     """
  86     def __init__(self, name, descr=None, default='circle'):
  87         ...
  88 
  89 class FieldArrow(_FieldSetting):
  90     """Field for selecting an arrow type.
  91 
  92     Returns a string
  93     """
  94     def __init__(self, name, descr=None, default='none'):
  95         ...
  96 
  97 class FieldErrorStyle(_FieldSetting):
  98     """Field for selecting an error bar style
  99 
 100     Returns a string
 101     """
 102     def __init__(self, name, descr=None, default='bar'):
 103         ...
 104 
 105 class FieldDistance(_FieldSetting):
 106     """Field for selecting a veusz-style distance, e.g. '1pt'.
 107 
 108     Returns a string
 109     """
 110     def __init__(self, name, descr=None, default='1pt'):
 111         ...
 112 
 113 class FieldFloatList(_FieldSetting):
 114     """Field for entering multiple numbers, separated by commas or spaces
 115 
 116     Returns a list/tuple of floats
 117     """
 118     def __init__(self, name, descr=None, default=()):
 119         ...
 120 
 121 class FieldDataset(_FieldSetting):
 122     """Field for selecting a datset.
 123     Returns a string.
 124 
 125     Note that the validity of dataset names is not checked
 126     Note that a blank string may result
 127     """
 128 
 129     def __init__(self, name, descr=None, default='', dims=1,
 130                  datatype='numeric'):
 131         """name: name of field
 132         descr: description to show to user
 133         default: default value (ignored currently)
 134         dims: dimensions of dataset to show
 135         datatype: type of data: numeric or text
 136         """
 137 
 138 class FieldTextMulti(_FieldSetting):
 139     """Field for entering multiple lines of text.
 140     Returns a tuple/list of strings.
 141     """
 142     def __init__(self, name, descr=None, default=('')):
 143         ...
 144 
 145 class FieldDatasetMulti(_FieldSetting):
 146     """Field for entering multiple datasets.
 147     Returns a tuple/list of strings.
 148     """
 149     def __init__(self, name, descr=None, default=(''), dims=1,
 150                  datatype='numeric'):
 151         """dims is number of dimensions of datasets to show in
 152         drop-down list.
 153 
 154         datatype is 'numeric' or 'text'
 155         """
 156         ...
 157 
 158 class FieldLineMulti(_FieldSetting):
 159     """A field for holding a set of lines. Consists of tuples
 160     [('dotted', '1pt', 'color', <trans>, False), ...]
 161 
 162     These are style, width, color, and hide or
 163     style, widget, color, transparency, hide
 164 
 165     This is compatible with the contour widget line style
 166     """
 167 
 168     def __init__(self, name, descr=None,
 169                  default=(('solid', '1pt', 'black', False),) ):
 170         ...
 171 
 172 class FieldFillMulti(_FieldSetting):
 173     """A field for holding a set of fills. Consists of tuples
 174 
 175     [('solid', 'color', <trans>, False), ...]
 176 
 177     These are color, fill style, and hide or
 178     color, fill style, transparency and hide
 179 
 180     This is compatible with the contour widget line style
 181     """
 182 
 183     def __init__(self, name, descr=None, default=()):
 184         ...
 185 
 186 class FieldFontFamily(_FieldSetting):
 187     """A field for holding a font family.
 188 
 189     Returns a string.
 190     """
 191 
 192     def __init__(self, name, descr=None, default=None):
 193         """Default None selects the default font."""
 194         ...
 195 
 196 class FieldFilename(_FieldSetting):
 197     """Select a filename with a browse button."""
 198 
 199     def __init__(self, name, descr=None, default=''):
 200         ...