wxPython/wx/tools/XRCed/xxx.py

   1 # Name:         xxx.py ('xxx' is easy to distinguish from 'wx' :) )
   2 # Purpose:      XML interface classes
   3 # Author:       Roman Rolinsky <rolinsky@mema.ucl.ac.be>
   4 # Created:      22.08.2001
   5 # RCS-ID:       $Id$
   6
   7 from xml.dom import minidom
   8 from globals import *
   9 from params import *
  10
  11 # Base class for interface parameter classes
  12 class xxxNode:
  13     def __init__(self, node):
  14         self.node = node
  15     def remove(self):
  16         self.node.parentNode.removeChild(self.node)
  17         self.node.unlink()
  18
  19 # Generic (text) parameter class
  20 class xxxParam(xxxNode):
  21     # Standard use: for text nodes
  22     def __init__(self, node):
  23         xxxNode.__init__(self, node)
  24         if not node.hasChildNodes():
  25             # If does not have child nodes, create empty text node
  26             text = g.tree.dom.createTextNode('')
  27             node.appendChild(text)
  28         else:
  29             text = node.childNodes[0] # first child must be text node
  30             assert text.nodeType == minidom.Node.TEXT_NODE
  31             # Append other text nodes if present and delete them
  32             extraText = ''
  33             for n in node.childNodes[1:]:
  34                 if n.nodeType == minidom.Node.TEXT_NODE:
  35                     extraText += n.data
  36                     node.removeChild(n)
  37                     n.unlink()
  38                 else: break
  39             if extraText: text.data = text.data + extraText
  40         # Use convertion from unicode to current encoding
  41         self.textNode = text
  42     # Value returns string
  43     if wxUSE_UNICODE:   # no conversion is needed
  44         def value(self):
  45             return self.textNode.data
  46         def update(self, value):
  47             self.textNode.data = value
  48     else:
  49         def value(self):
  50             return self.textNode.data.encode(g.currentEncoding)
  51         def update(self, value):
  52             self.textNode.data = unicode(value, g.currentEncoding)
  53
  54 # Integer parameter
  55 class xxxParamInt(xxxParam):
  56     # Standard use: for text nodes
  57     def __init__(self, node):
  58         xxxParam.__init__(self, node)
  59     # Value returns string
  60     def value(self):
  61         try:
  62             return int(self.textNode.data)
  63         except ValueError:
  64             return -1                   # invalid value
  65     def update(self, value):
  66         self.textNode.data = str(value)
  67
  68 # Content parameter
  69 class xxxParamContent(xxxNode):
  70     def __init__(self, node):
  71         xxxNode.__init__(self, node)
  72         data, l = [], []                # data is needed to quicker value retrieval
  73         nodes = node.childNodes[:]      # make a copy of the child list
  74         for n in nodes:
  75             if n.nodeType == minidom.Node.ELEMENT_NODE:
  76                 assert n.tagName == 'item', 'bad content content'
  77                 if not n.hasChildNodes():
  78                     # If does not have child nodes, create empty text node
  79                     text = g.tree.dom.createTextNode('')
  80                     node.appendChild(text)
  81                 else:
  82                     # !!! normalize?
  83                     text = n.childNodes[0] # first child must be text node
  84                     assert text.nodeType == minidom.Node.TEXT_NODE
  85                 l.append(text)
  86                 data.append(str(text.data))
  87             else:                       # remove other
  88                 node.removeChild(n)
  89                 n.unlink()
  90         self.l, self.data = l, data
  91     def value(self):
  92         return self.data
  93     def update(self, value):
  94         # If number if items is not the same, recreate children
  95         if len(value) != len(self.l):   # remove first if number of items has changed
  96             childNodes = self.node.childNodes[:]
  97             for n in childNodes:
  98                 self.node.removeChild(n)
  99             l = []
 100             for str in value:
 101                 itemElem = g.tree.dom.createElement('item')
 102                 itemText = g.tree.dom.createTextNode(str)
 103                 itemElem.appendChild(itemText)
 104                 self.node.appendChild(itemElem)
 105                 l.append(itemText)
 106             self.l = l
 107         else:
 108             for i in range(len(value)):
 109                 self.l[i].data = value[i]
 110         self.data = value
 111
 112 # Content parameter for checklist
 113 class xxxParamContentCheckList(xxxNode):
 114     def __init__(self, node):
 115         xxxNode.__init__(self, node)
 116         data, l = [], []                # data is needed to quicker value retrieval
 117         nodes = node.childNodes[:]      # make a copy of the child list
 118         for n in nodes:
 119             if n.nodeType == minidom.Node.ELEMENT_NODE:
 120                 assert n.tagName == 'item', 'bad content content'
 121                 checked = n.getAttribute('checked')
 122                 if not checked: checked = 0
 123                 if not n.hasChildNodes():
 124                     # If does not have child nodes, create empty text node
 125                     text = g.tree.dom.createTextNode('')
 126                     node.appendChild(text)
 127                 else:
 128                     # !!! normalize?
 129                     text = n.childNodes[0] # first child must be text node
 130                     assert text.nodeType == minidom.Node.TEXT_NODE
 131                 l.append((text, n))
 132                 data.append((str(text.data), int(checked)))
 133             else:                       # remove other
 134                 node.removeChild(n)
 135                 n.unlink()
 136         self.l, self.data = l, data
 137     def value(self):
 138         return self.data
 139     def update(self, value):
 140         # If number if items is not the same, recreate children
 141         if len(value) != len(self.l):   # remove first if number of items has changed
 142             childNodes = self.node.childNodes[:]
 143             for n in childNodes:
 144                 self.node.removeChild(n)
 145             l = []
 146             for s,ch in value:
 147                 itemElem = g.tree.dom.createElement('item')
 148                 # Add checked only if True
 149                 if ch: itemElem.setAttribute('checked', '1')
 150                 itemText = g.tree.dom.createTextNode(s)
 151                 itemElem.appendChild(itemText)
 152                 self.node.appendChild(itemElem)
 153                 l.append((itemText, itemElem))
 154             self.l = l
 155         else:
 156             for i in range(len(value)):
 157                 self.l[i][0].data = value[i][0]
 158                 self.l[i][1].setAttribute('checked', str(value[i][1]))
 159         self.data = value
 160
 161 # Bitmap parameter
 162 class xxxParamBitmap(xxxParam):
 163     def __init__(self, node):
 164         xxxParam.__init__(self, node)
 165         self.stock_id = node.getAttribute('stock_id')
 166     def value(self):
 167         return [self.stock_id, xxxParam.value(self)]
 168     def update(self, value):
 169         self.stock_id = value[0]
 170         if self.stock_id:
 171             self.node.setAttribute('stock_id', self.stock_id)
 172         elif self.node.hasAttribute('stock_id'):
 173             self.node.removeAttribute('stock_id')
 174         xxxParam.update(self, value[1])
 175
 176 ################################################################################
 177
 178 # Classes to interface DOM objects
 179 class xxxObject:
 180     # Default behavior
 181     hasChildren = False                 # has children elements?
 182     hasStyle = True                     # almost everyone
 183     hasName = True                      # has name attribute?
 184     isSizer = hasChild = False
 185     allParams = None                    # Some nodes have no parameters
 186     # Style parameters (all optional)
 187     styles = ['fg', 'bg', 'font', 'enabled', 'focused', 'hidden', 'tooltip']
 188     # Special parameters
 189     specials = []
 190     # Bitmap tags
 191     bitmapTags = ['bitmap', 'bitmap2', 'icon']
 192     # Required paremeters: none by default
 193     required = []
 194     # Default parameters with default values
 195     default = {}
 196     # Parameter types
 197     paramDict = {}
 198     # Window styles and extended styles
 199     winStyles = []
 200     # Tree icon index
 201     #image = -1
 202     # Construct a new xxx object from DOM element
 203     # parent is parent xxx object (or None if none), element is DOM element object
 204     def __init__(self, parent, element):
 205         self.parent = parent
 206         self.element = element
 207         self.undo = None
 208         # Get attributes
 209         self.className = element.getAttribute('class')
 210         self.subclass = element.getAttribute('subclass')
 211         if self.hasName: self.name = element.getAttribute('name')
 212         # Set parameters (text element children)
 213         self.params = {}
 214         nodes = element.childNodes[:]
 215         for node in nodes:
 216             if node.nodeType == minidom.Node.ELEMENT_NODE:
 217                 tag = node.tagName
 218                 if tag == 'object':
 219                     continue            # do nothing for object children here
 220                 if tag not in self.allParams and tag not in self.styles:
 221                     print 'WARNING: unknown parameter for %s: %s' % \
 222                           (self.className, tag)
 223                 elif tag in self.specials:
 224                     self.special(tag, node)
 225                 elif tag == 'content':
 226                     if self.className == 'wxCheckList':
 227                         self.params[tag] = xxxParamContentCheckList(node)
 228                     else:
 229                         self.params[tag] = xxxParamContent(node)
 230                 elif tag == 'font': # has children
 231                     self.params[tag] = xxxParamFont(element, node)
 232                 elif tag in self.bitmapTags:
 233                     # Can have attributes
 234                     self.params[tag] = xxxParamBitmap(node)
 235                 else:                   # simple parameter
 236                     self.params[tag] = xxxParam(node)
 237             else:
 238                 # Remove all other nodes
 239                 element.removeChild(node)
 240                 node.unlink()
 241         # Check that all required params are set
 242         for param in self.required:
 243             if not self.params.has_key(param):
 244                 # If default is specified, set it
 245                 if self.default.has_key(param):
 246                     elem = g.tree.dom.createElement(param)
 247                     if param == 'content':
 248                         if self.className == 'wxCheckList':
 249                             self.params[param] = xxxParamContentCheckList(elem)
 250                         else:
 251                             self.params[param] = xxxParamContent(elem)
 252                     else:
 253                         self.params[param] = xxxParam(elem)
 254                     # Find place to put new element: first present element after param
 255                     found = False
 256                     paramStyles = self.allParams + self.styles
 257                     for p in paramStyles[paramStyles.index(param) + 1:]:
 258                         # Content params don't have same type
 259                         if self.params.has_key(p) and p != 'content':
 260                             found = True
 261                             break
 262                     if found:
 263                         nextTextElem = self.params[p].node
 264                         self.element.insertBefore(elem, nextTextElem)
 265                     else:
 266                         self.element.appendChild(elem)
 267                 else:
 268                     wxLogWarning('Required parameter %s of %s missing' %
 269                                  (param, self.className))
 270     # Returns real tree object
 271     def treeObject(self):
 272         if self.hasChild: return self.child
 273         return self
 274     # Returns tree image index
 275     def treeImage(self):
 276         if self.hasChild: return self.child.treeImage()
 277         return self.image
 278     # Class name plus wx name
 279     def treeName(self):
 280         if self.hasChild: return self.child.treeName()
 281         if self.subclass: className = self.subclass
 282         else: className = self.className
 283         if self.hasName and self.name: return className + ' "' + self.name + '"'
 284         return className
 285     # Class name or subclass
 286     def panelName(self):
 287         if self.subclass: return self.subclass + '(' + self.className + ')'
 288         else: return self.className
 289
 290 ################################################################################
 291
 292 # This is a little special: it is both xxxObject and xxxNode
 293 class xxxParamFont(xxxObject, xxxNode):
 294     allParams = ['size', 'style', 'weight', 'family', 'underlined',
 295                  'face', 'encoding']
 296     def __init__(self, parent, element):
 297         xxxObject.__init__(self, parent, element)
 298         xxxNode.__init__(self, element)
 299         self.parentNode = parent       # required to behave similar to DOM node
 300         v = []
 301         for p in self.allParams:
 302             try:
 303                 v.append(str(self.params[p].value()))
 304             except KeyError:
 305                 v.append('')
 306         self.data = v
 307     def update(self, value):
 308         # `value' is a list of strings corresponding to all parameters
 309         elem = self.element
 310         # Remove old elements first
 311         childNodes = elem.childNodes[:]
 312         for node in childNodes: elem.removeChild(node)
 313         i = 0
 314         self.params.clear()
 315         v = []
 316         for param in self.allParams:
 317             if value[i]:
 318                 fontElem = g.tree.dom.createElement(param)
 319                 textNode = g.tree.dom.createTextNode(value[i])
 320                 self.params[param] = textNode
 321                 fontElem.appendChild(textNode)
 322                 elem.appendChild(fontElem)
 323             v.append(value[i])
 324             i += 1
 325         self.data = v
 326     def value(self):
 327         return self.data
 328
 329 ################################################################################
 330
 331 class xxxContainer(xxxObject):
 332     hasChildren = True
 333
 334 # Simulate normal parameter for encoding
 335 class xxxEncoding:
 336     def __init__(self, val):
 337         self.encd = val
 338     def value(self):
 339         return self.encd
 340     def update(self, val):
 341         self.encd = val
 342
 343 # Special class for root node
 344 class xxxMainNode(xxxContainer):
 345     allParams = ['encoding']
 346     hasStyle = hasName = False
 347     def __init__(self, dom):
 348         xxxContainer.__init__(self, None, dom.documentElement)
 349         self.className = 'XML tree'
 350         # Reset required parameters after processing XML, because encoding is
 351         # a little special
 352         self.required = ['encoding']
 353         self.params['encoding'] = xxxEncoding(dom.encoding)
 354
 355 ################################################################################
 356 # Top-level windwows
 357
 358 class xxxPanel(xxxContainer):
 359     allParams = ['pos', 'size', 'style']
 360     styles = ['fg', 'bg', 'font', 'enabled', 'focused', 'hidden', 'exstyle',
 361               'tooltip']
 362     winStyles = ['wxNO_3D', 'wxTAB_TRAVERSAL', 'wxCLIP_CHILDREN']
 363     exStyles = ['wxWS_EX_VALIDATE_RECURSIVELY']
 364
 365 class xxxDialog(xxxContainer):
 366     allParams = ['title', 'centered', 'pos', 'size', 'style']
 367     paramDict = {'centered': ParamBool}
 368     required = ['title']
 369     default = {'title': ''}
 370     winStyles = ['wxDEFAULT_DIALOG_STYLE', 'wxSTAY_ON_TOP',
 371                  'wxDIALOG_MODAL', 'wxDIALOG_MODELESS',
 372                  'wxCAPTION', 'wxSYSTEM_MENU', 'wxRESIZE_BORDER', 'wxRESIZE_BOX',
 373                  'wxTHICK_FRAME',
 374                  'wxNO_3D', 'wxTAB_TRAVERSAL', 'wxCLIP_CHILDREN']
 375     styles = ['fg', 'bg', 'font', 'enabled', 'focused', 'hidden', 'exstyle',
 376               'tooltip']
 377     exStyles = ['wxWS_EX_VALIDATE_RECURSIVELY']
 378
 379 class xxxFrame(xxxContainer):
 380     allParams = ['title', 'centered', 'pos', 'size', 'style']
 381     paramDict = {'centered': ParamBool}
 382     required = ['title']
 383     default = {'title': ''}
 384     winStyles = ['wxDEFAULT_FRAME_STYLE', 'wxDEFAULT_DIALOG_STYLE',
 385                  'wxSTAY_ON_TOP',
 386                  'wxCAPTION', 'wxSYSTEM_MENU', 'wxRESIZE_BORDER',
 387                  'wxRESIZE_BOX', 'wxMINIMIZE_BOX', 'wxMAXIMIZE_BOX',
 388                  'wxFRAME_FLOAT_ON_PARENT', 'wxFRAME_TOOL_WINDOW',
 389                  'wxNO_3D', 'wxTAB_TRAVERSAL', 'wxCLIP_CHILDREN']
 390     styles = ['fg', 'bg', 'font', 'enabled', 'focused', 'hidden', 'exstyle',
 391               'tooltip']
 392     exStyles = ['wxWS_EX_VALIDATE_RECURSIVELY']
 393
 394 class xxxTool(xxxObject):
 395     allParams = ['bitmap', 'bitmap2', 'toggle', 'tooltip', 'longhelp']
 396     required = ['bitmap']
 397     paramDict = {'bitmap2': ParamBitmap, 'toggle': ParamBool}
 398     hasStyle = False
 399
 400 class xxxToolBar(xxxContainer):
 401     allParams = ['bitmapsize', 'margins', 'packing', 'separation',
 402                  'pos', 'size', 'style']
 403     hasStyle = False
 404     paramDict = {'bitmapsize': ParamPosSize, 'margins': ParamPosSize,
 405                  'packing': ParamInt, 'separation': ParamInt,
 406                  'style': ParamNonGenericStyle}
 407     winStyles = ['wxTB_FLAT', 'wxTB_DOCKABLE', 'wxTB_VERTICAL', 'wxTB_HORIZONTAL']
 408
 409 ################################################################################
 410 # Bitmap, Icon
 411
 412 class xxxBitmap(xxxObject):
 413     allParams = ['bitmap']
 414     required = ['bitmap']
 415
 416 # Just like bitmap
 417 class xxxIcon(xxxObject):
 418     allParams = ['icon']
 419     required = ['icon']
 420
 421 ################################################################################
 422 # Controls
 423
 424 class xxxStaticText(xxxObject):
 425     allParams = ['label', 'pos', 'size', 'style']
 426     required = ['label']
 427     default = {'label': ''}
 428     winStyles = ['wxALIGN_LEFT', 'wxALIGN_RIGHT', 'wxALIGN_CENTRE', 'wxST_NO_AUTORESIZE']
 429
 430 class xxxStaticLine(xxxObject):
 431     allParams = ['pos', 'size', 'style']
 432     winStyles = ['wxLI_HORIZONTAL', 'wxLI_VERTICAL']
 433
 434 class xxxStaticBitmap(xxxObject):
 435     allParams = ['bitmap', 'pos', 'size', 'style']
 436     required = ['bitmap']
 437
 438 class xxxTextCtrl(xxxObject):
 439     allParams = ['value', 'pos', 'size', 'style']
 440     winStyles = ['wxTE_PROCESS_ENTER', 'wxTE_PROCESS_TAB', 'wxTE_MULTILINE',
 441               'wxTE_PASSWORD', 'wxTE_READONLY', 'wxHSCROLL']
 442     paramDict = {'value': ParamMultilineText}
 443
 444 class xxxChoice(xxxObject):
 445     allParams = ['content', 'selection', 'pos', 'size', 'style']
 446     required = ['content']
 447     default = {'content': '[]'}
 448     winStyles = ['wxCB_SORT']
 449
 450 class xxxSlider(xxxObject):
 451     allParams = ['value', 'min', 'max', 'pos', 'size', 'style',
 452                  'tickfreq', 'pagesize', 'linesize', 'thumb', 'tick',
 453                  'selmin', 'selmax']
 454     paramDict = {'value': ParamInt, 'tickfreq': ParamInt, 'pagesize': ParamInt,
 455                  'linesize': ParamInt, 'thumb': ParamInt, 'thumb': ParamInt,
 456                  'tick': ParamInt, 'selmin': ParamInt, 'selmax': ParamInt}
 457     required = ['value', 'min', 'max']
 458     winStyles = ['wxSL_HORIZONTAL', 'wxSL_VERTICAL', 'wxSL_AUTOTICKS', 'wxSL_LABELS',
 459                  'wxSL_LEFT', 'wxSL_RIGHT', 'wxSL_TOP', 'wxSL_BOTTOM',
 460                  'wxSL_BOTH', 'wxSL_SELRANGE']
 461
 462 class xxxGauge(xxxObject):
 463     allParams = ['range', 'pos', 'size', 'style', 'value', 'shadow', 'bezel']
 464     paramDict = {'range': ParamInt, 'value': ParamInt,
 465                  'shadow': ParamInt, 'bezel': ParamInt}
 466     winStyles = ['wxGA_HORIZONTAL', 'wxGA_VERTICAL', 'wxGA_PROGRESSBAR', 'wxGA_SMOOTH']
 467
 468 class xxxScrollBar(xxxObject):
 469     allParams = ['pos', 'size', 'style', 'value', 'thumbsize', 'range', 'pagesize']
 470     paramDict = {'value': ParamInt, 'range': ParamInt, 'thumbsize': ParamInt,
 471                  'pagesize': ParamInt}
 472     winStyles = ['wxSB_HORIZONTAL', 'wxSB_VERTICAL']
 473
 474 class xxxListCtrl(xxxObject):
 475     allParams = ['pos', 'size', 'style']
 476     winStyles = ['wxLC_LIST', 'wxLC_REPORT', 'wxLC_ICON', 'wxLC_SMALL_ICON',
 477               'wxLC_ALIGN_TOP', 'wxLC_ALIGN_LEFT', 'wxLC_AUTOARRANGE',
 478               'wxLC_USER_TEXT', 'wxLC_EDIT_LABELS', 'wxLC_NO_HEADER',
 479               'wxLC_SINGLE_SEL', 'wxLC_SORT_ASCENDING', 'wxLC_SORT_DESCENDING']
 480
 481 class xxxTreeCtrl(xxxObject):
 482     allParams = ['pos', 'size', 'style']
 483     winStyles = ['wxTR_HAS_BUTTONS', 'wxTR_NO_LINES', 'wxTR_LINES_AT_ROOT',
 484               'wxTR_EDIT_LABELS', 'wxTR_MULTIPLE']
 485
 486 class xxxHtmlWindow(xxxObject):
 487     allParams = ['pos', 'size', 'style', 'borders', 'url', 'htmlcode']
 488     paramDict = {'borders': ParamInt, 'htmlcode':ParamMultilineText}
 489     winStyles = ['wxHW_SCROLLBAR_NEVER', 'wxHW_SCROLLBAR_AUTO']
 490
 491 class xxxCalendarCtrl(xxxObject):
 492     allParams = ['pos', 'size', 'style']
 493
 494 class xxxNotebook(xxxContainer):
 495     allParams = ['usenotebooksizer', 'pos', 'size', 'style']
 496     paramDict = {'usenotebooksizer': ParamBool}
 497     winStyles = ['wxNB_FIXEDWIDTH', 'wxNB_LEFT', 'wxNB_RIGHT', 'wxNB_BOTTOM']
 498
 499 class xxxGenericDirCtrl(xxxObject):
 500     allParams = ['defaultfolder', 'filter', 'defaultfilter', 'pos', 'size', 'style']
 501     paramDict = {'defaultfilter': ParamInt}
 502     winStyles = ['wxDIRCTRL_DIR_ONLY', 'wxDIRCTRL_3D_INTERNAL', 'wxDIRCTRL_SELECT_FIRST',
 503                  'wxDIRCTRL_SHOW_FILTERS', 'wxDIRCTRL_EDIT_LABELS']
 504
 505 class xxxScrolledWindow(xxxContainer):
 506     allParams = ['pos', 'size', 'style']
 507     winStyles = ['wxHSCROLL', 'wxVSCROLL']
 508
 509 ################################################################################
 510 # Buttons
 511
 512 class xxxButton(xxxObject):
 513     allParams = ['label', 'default', 'pos', 'size', 'style']
 514     paramDict = {'default': ParamBool}
 515     required = ['label']
 516     winStyles = ['wxBU_LEFT', 'wxBU_TOP', 'wxBU_RIGHT', 'wxBU_BOTTOM']
 517
 518 class xxxBitmapButton(xxxObject):
 519     allParams = ['bitmap', 'selected', 'focus', 'disabled', 'default',
 520                  'pos', 'size', 'style']
 521     required = ['bitmap']
 522     winStyles = ['wxBU_AUTODRAW', 'wxBU_LEFT', 'wxBU_TOP',
 523                  'wxBU_RIGHT', 'wxBU_BOTTOM']
 524
 525 class xxxRadioButton(xxxObject):
 526     allParams = ['label', 'value', 'pos', 'size', 'style']
 527     paramDict = {'value': ParamBool}
 528     required = ['label']
 529     winStyles = ['wxRB_GROUP']
 530
 531 class xxxSpinButton(xxxObject):
 532     allParams = ['value', 'min', 'max', 'pos', 'size', 'style']
 533     paramDict = {'value': ParamInt}
 534     winStyles = ['wxSP_HORIZONTAL', 'wxSP_VERTICAL', 'wxSP_ARROW_KEYS', 'wxSP_WRAP']
 535
 536 class xxxSpinCtrl(xxxObject):
 537     allParams = ['value', 'min', 'max', 'pos', 'size', 'style']
 538     paramDict = {'value': ParamInt}
 539     winStyles = ['wxSP_HORIZONTAL', 'wxSP_VERTICAL', 'wxSP_ARROW_KEYS', 'wxSP_WRAP']
 540
 541 ################################################################################
 542 # Boxes
 543
 544 class xxxStaticBox(xxxObject):
 545     allParams = ['label', 'pos', 'size', 'style']
 546     required = ['label']
 547
 548 class xxxRadioBox(xxxObject):
 549     allParams = ['label', 'content', 'selection', 'dimension', 'pos', 'size', 'style']
 550     paramDict = {'dimension': ParamInt}
 551     required = ['label', 'content']
 552     default = {'content': '[]'}
 553     winStyles = ['wxRA_SPECIFY_ROWS', 'wxRA_SPECIFY_COLS']
 554
 555 class xxxCheckBox(xxxObject):
 556     allParams = ['label', 'checked', 'pos', 'size', 'style']
 557     paramDict = {'checked': ParamBool}
 558     required = ['label']
 559
 560 class xxxComboBox(xxxObject):
 561     allParams = ['content', 'selection', 'value', 'pos', 'size', 'style']
 562     required = ['content']
 563     default = {'content': '[]'}
 564     winStyles = ['wxCB_SIMPLE', 'wxCB_SORT', 'wxCB_READONLY', 'wxCB_DROPDOWN']
 565
 566 class xxxListBox(xxxObject):
 567     allParams = ['content', 'selection', 'pos', 'size', 'style']
 568     required = ['content']
 569     default = {'content': '[]'}
 570     winStyles = ['wxLB_SINGLE', 'wxLB_MULTIPLE', 'wxLB_EXTENDED', 'wxLB_HSCROLL',
 571               'wxLB_ALWAYS_SB', 'wxLB_NEEDED_SB', 'wxLB_SORT']
 572
 573 class xxxCheckList(xxxObject):
 574     allParams = ['content', 'pos', 'size', 'style']
 575     required = ['content']
 576     default = {'content': '[]'}
 577     winStyles = ['wxLC_LIST', 'wxLC_REPORT', 'wxLC_ICON', 'wxLC_SMALL_ICON',
 578               'wxLC_ALIGN_TOP', 'wxLC_ALIGN_LEFT', 'wxLC_AUTOARRANGE',
 579               'wxLC_USER_TEXT', 'wxLC_EDIT_LABELS', 'wxLC_NO_HEADER',
 580               'wxLC_SINGLE_SEL', 'wxLC_SORT_ASCENDING', 'wxLC_SORT_DESCENDING']
 581     paramDict = {'content': ParamContentCheckList}
 582
 583 ################################################################################
 584 # Sizers
 585
 586 class xxxSizer(xxxContainer):
 587     hasName = hasStyle = False
 588     paramDict = {'orient': ParamOrient}
 589     isSizer = True
 590
 591 class xxxBoxSizer(xxxSizer):
 592     allParams = ['orient']
 593     required = ['orient']
 594     default = {'orient': 'wxVERTICAL'}
 595     # Tree icon depends on orientation
 596     def treeImage(self):
 597         if self.params['orient'].value() == 'wxHORIZONTAL': return self.imageH
 598         else: return self.imageV
 599
 600 class xxxStaticBoxSizer(xxxBoxSizer):
 601     allParams = ['label', 'orient']
 602     required = ['label', 'orient']
 603
 604 class xxxGridSizer(xxxSizer):
 605     allParams = ['cols', 'rows', 'vgap', 'hgap']
 606     required = ['cols']
 607     default = {'cols': '2', 'rows': '2'}
 608
 609 # For repeated parameters
 610 class xxxParamMulti:
 611     def __init__(self, node):
 612         self.node = node
 613         self.l, self.data = [], []
 614     def append(self, param):
 615         self.l.append(param)
 616         self.data.append(param.value())
 617     def value(self):
 618         return self.data
 619     def remove(self):
 620         for param in self.l:
 621             param.remove()
 622         self.l, self.data = [], []
 623
 624 class xxxFlexGridSizer(xxxGridSizer):
 625     specials = ['growablecols', 'growablerows']
 626     allParams = ['cols', 'rows', 'vgap', 'hgap'] + specials
 627     paramDict = {'growablecols':ParamIntList, 'growablerows':ParamIntList}
 628     # Special processing for growable* parameters
 629     # (they are represented by several nodes)
 630     def special(self, tag, node):
 631         if not self.params.has_key(tag):
 632             # Create new multi-group
 633             self.params[tag] = xxxParamMulti(node)
 634         self.params[tag].append(xxxParamInt(node))
 635     def setSpecial(self, param, value):
 636         # Straightforward implementation: remove, add again
 637         self.params[param].remove()
 638         del self.params[param]
 639         for i in value:
 640             node = g.tree.dom.createElement(param)
 641             text = g.tree.dom.createTextNode(str(i))
 642             node.appendChild(text)
 643             self.element.appendChild(node)
 644             self.special(param, node)
 645
 646 class xxxGridBagSizer(xxxSizer):
 647     specials = ['growablecols', 'growablerows']
 648     allParams = ['vgap', 'hgap'] + specials
 649     paramDict = {'growablecols':ParamIntList, 'growablerows':ParamIntList}
 650     # Special processing for growable* parameters
 651     # (they are represented by several nodes)
 652     def special(self, tag, node):
 653         if not self.params.has_key(tag):
 654             # Create new multi-group
 655             self.params[tag] = xxxParamMulti(node)
 656         self.params[tag].append(xxxParamInt(node))
 657     def setSpecial(self, param, value):
 658         # Straightforward implementation: remove, add again
 659         self.params[param].remove()
 660         del self.params[param]
 661         for i in value:
 662             node = g.tree.dom.createElement(param)
 663             text = g.tree.dom.createTextNode(str(i))
 664             node.appendChild(text)
 665             self.element.appendChild(node)
 666             self.special(param, node)
 667
 668 # Container with only one child.
 669 # Not shown in tree.
 670 class xxxChildContainer(xxxObject):
 671     hasName = hasStyle = False
 672     hasChild = True
 673     def __init__(self, parent, element):
 674         xxxObject.__init__(self, parent, element)
 675         # Must have one child with 'object' tag, but we don't check it
 676         nodes = element.childNodes[:]   # create copy
 677         for node in nodes:
 678             if node.nodeType == minidom.Node.ELEMENT_NODE:
 679                 if node.tagName == 'object':
 680                     # Create new xxx object for child node
 681                     self.child = MakeXXXFromDOM(self, node)
 682                     self.child.parent = parent
 683                     # Copy hasChildren and isSizer attributes
 684                     self.hasChildren = self.child.hasChildren
 685                     self.isSizer = self.child.isSizer
 686                     return              # success
 687             else:
 688                 element.removeChild(node)
 689                 node.unlink()
 690         assert 0, 'no child found'
 691
 692 class xxxSizerItem(xxxChildContainer):
 693     allParams = ['option', 'flag', 'border', 'minsize', 'ratio']
 694     paramDict = {'option': ParamInt, 'minsize': ParamPosSize, 'ratio': ParamPosSize}
 695     #default = {'cellspan': '1,1'}
 696     def __init__(self, parent, element):
 697         # For GridBag sizer items, extra parameters added
 698         if isinstance(parent, xxxGridBagSizer):
 699             self.allParams = self.allParams + ['cellpos', 'cellspan']
 700         xxxChildContainer.__init__(self, parent, element)
 701         # Remove pos parameter - not needed for sizeritems
 702         if 'pos' in self.child.allParams:
 703             self.child.allParams = self.child.allParams[:]
 704             self.child.allParams.remove('pos')
 705
 706 class xxxNotebookPage(xxxChildContainer):
 707     allParams = ['label', 'selected']
 708     paramDict = {'selected': ParamBool}
 709     required = ['label']
 710     def __init__(self, parent, element):
 711         xxxChildContainer.__init__(self, parent, element)
 712         # pos and size dont matter for notebookpages
 713         if 'pos' in self.child.allParams:
 714             self.child.allParams = self.child.allParams[:]
 715             self.child.allParams.remove('pos')
 716         if 'size' in self.child.allParams:
 717             self.child.allParams = self.child.allParams[:]
 718             self.child.allParams.remove('size')
 719
 720 class xxxSpacer(xxxObject):
 721     hasName = hasStyle = False
 722     allParams = ['size', 'option', 'flag', 'border']
 723     paramDict = {'option': ParamInt}
 724     default = {'size': '0,0'}
 725
 726 class xxxMenuBar(xxxContainer):
 727     allParams = ['style']
 728     paramDict = {'style': ParamNonGenericStyle}    # no generic styles
 729     winStyles = ['wxMB_DOCKABLE']
 730
 731 class xxxMenu(xxxContainer):
 732     allParams = ['label', 'help', 'style']
 733     default = {'label': ''}
 734     paramDict = {'style': ParamNonGenericStyle}    # no generic styles
 735     winStyles = ['wxMENU_TEAROFF']
 736
 737 class xxxMenuItem(xxxObject):
 738     allParams = ['label', 'bitmap', 'accel', 'help',
 739                  'checkable', 'radio', 'enabled', 'checked']
 740     default = {'label': ''}
 741     hasStyle = False
 742
 743 class xxxSeparator(xxxObject):
 744     hasName = hasStyle = False
 745
 746 ################################################################################
 747 # Unknown control
 748
 749 class xxxUnknown(xxxObject):
 750     allParams = ['pos', 'size', 'style']
 751     paramDict = {'style': ParamNonGenericStyle}    # no generic styles
 752
 753 ################################################################################
 754
 755 xxxDict = {
 756     'wxPanel': xxxPanel,
 757     'wxDialog': xxxDialog,
 758     'wxFrame': xxxFrame,
 759     'tool': xxxTool,
 760     'wxToolBar': xxxToolBar,
 761
 762     'wxBitmap': xxxBitmap,
 763     'wxIcon': xxxIcon,
 764
 765     'wxButton': xxxButton,
 766     'wxBitmapButton': xxxBitmapButton,
 767     'wxRadioButton': xxxRadioButton,
 768     'wxSpinButton': xxxSpinButton,
 769
 770     'wxStaticBox': xxxStaticBox,
 771     'wxStaticBitmap': xxxStaticBitmap,
 772     'wxRadioBox': xxxRadioBox,
 773     'wxComboBox': xxxComboBox,
 774     'wxCheckBox': xxxCheckBox,
 775     'wxListBox': xxxListBox,
 776
 777     'wxStaticText': xxxStaticText,
 778     'wxStaticLine': xxxStaticLine,
 779     'wxTextCtrl': xxxTextCtrl,
 780     'wxChoice': xxxChoice,
 781     'wxSlider': xxxSlider,
 782     'wxGauge': xxxGauge,
 783     'wxScrollBar': xxxScrollBar,
 784     'wxTreeCtrl': xxxTreeCtrl,
 785     'wxListCtrl': xxxListCtrl,
 786     'wxCheckList': xxxCheckList,
 787     'wxNotebook': xxxNotebook,
 788     'notebookpage': xxxNotebookPage,
 789     'wxHtmlWindow': xxxHtmlWindow,
 790     'wxCalendarCtrl': xxxCalendarCtrl,
 791     'wxGenericDirCtrl': xxxGenericDirCtrl,
 792     'wxSpinCtrl': xxxSpinCtrl,
 793     'wxScrolledWindow': xxxScrolledWindow,
 794
 795     'wxBoxSizer': xxxBoxSizer,
 796     'wxStaticBoxSizer': xxxStaticBoxSizer,
 797     'wxGridSizer': xxxGridSizer,
 798     'wxFlexGridSizer': xxxFlexGridSizer,
 799     'wxGridBagSizer': xxxGridBagSizer,
 800     'sizeritem': xxxSizerItem,
 801     'spacer': xxxSpacer,
 802
 803     'wxMenuBar': xxxMenuBar,
 804     'wxMenu': xxxMenu,
 805     'wxMenuItem': xxxMenuItem,
 806     'separator': xxxSeparator,
 807
 808     'unknown': xxxUnknown,
 809     }
 810
 811 # Create IDs for all parameters of all classes
 812 paramIDs = {'fg': wxNewId(), 'bg': wxNewId(), 'exstyle': wxNewId(), 'font': wxNewId(),
 813             'enabled': wxNewId(), 'focused': wxNewId(), 'hidden': wxNewId(),
 814             'tooltip': wxNewId(), 'encoding': wxNewId(),
 815             'cellpos': wxNewId(), 'cellspan': wxNewId()
 816             }
 817 for cl in xxxDict.values():
 818     if cl.allParams:
 819         for param in cl.allParams + cl.paramDict.keys():
 820             if not paramIDs.has_key(param):
 821                 paramIDs[param] = wxNewId()
 822
 823 ################################################################################
 824 # Helper functions
 825
 826 # Test for object elements
 827 def IsObject(node):
 828     return node.nodeType == minidom.Node.ELEMENT_NODE and node.tagName == 'object'
 829
 830 # Make XXX object from some DOM object, selecting correct class
 831 def MakeXXXFromDOM(parent, element):
 832     try:
 833         klass = xxxDict[element.getAttribute('class')]
 834     except KeyError:
 835         # If we encounter a weird class, use unknown template
 836         print 'WARNING: unsupported class:', element.getAttribute('class')
 837         klass = xxxUnknown
 838     return klass(parent, element)
 839
 840 # Make empty DOM element
 841 def MakeEmptyDOM(className):
 842     elem = g.tree.dom.createElement('object')
 843     elem.setAttribute('class', className)
 844     # Set required and default parameters
 845     xxxClass = xxxDict[className]
 846     defaultNotRequired = filter(lambda x, l=xxxClass.required: x not in l,
 847                                 xxxClass.default.keys())
 848     for param in xxxClass.required + defaultNotRequired:
 849         textElem = g.tree.dom.createElement(param)
 850         try:
 851             textNode = g.tree.dom.createTextNode(xxxClass.default[param])
 852         except KeyError:
 853             textNode = g.tree.dom.createTextNode('')
 854         textElem.appendChild(textNode)
 855         elem.appendChild(textElem)
 856     return elem
 857
 858 # Make empty XXX object
 859 def MakeEmptyXXX(parent, className):
 860     # Make corresponding DOM object first
 861     elem = MakeEmptyDOM(className)
 862     # If parent is a sizer, we should create sizeritem object, except for spacers
 863     if parent:
 864         if parent.isSizer and className != 'spacer':
 865             sizerItemElem = MakeEmptyDOM('sizeritem')
 866             sizerItemElem.appendChild(elem)
 867             elem = sizerItemElem
 868         elif isinstance(parent, xxxNotebook):
 869             pageElem = MakeEmptyDOM('notebookpage')
 870             pageElem.appendChild(elem)
 871             elem = pageElem
 872     # Now just make object
 873     return MakeXXXFromDOM(parent, elem)
 874