wxPython/wx/tools/XRCed/panel.py

   1 # Name:         panel.py
   2 # Purpose:      XRC editor, Panel class and related
   3 # Author:       Roman Rolinsky <rolinsky@mema.ucl.ac.be>
   4 # Created:      02.12.2002
   5 # RCS-ID:       $Id$
   6
   7 from xxx import *                       # xxx imports globals and params
   8 from undo import *
   9 from wxPython.html import wxHtmlWindow
  10
  11 # Properties panel containing notebook
  12 class Panel(wxNotebook):
  13     def __init__(self, parent, id = -1):
  14         if wxPlatform != '__WXMAC__':   # some problems with this style on macs
  15             wxNotebook.__init__(self, parent, id, style=wxNB_BOTTOM)
  16         else:
  17             wxNotebook.__init__(self, parent, id)
  18         global panel
  19         g.panel = panel = self
  20         self.modified = False
  21
  22         # Set common button size for parameter buttons
  23         bTmp = wxButton(self, -1, '')
  24         import params
  25         params.buttonSize = (self.DLG_SZE(buttonSize)[0], bTmp.GetSize()[1])
  26         bTmp.Destroy()
  27         del bTmp
  28
  29         # List of child windows
  30         self.pages = []
  31         # Create scrolled windows for pages
  32         self.page1 = wxScrolledWindow(self, -1)
  33         sizer = wxBoxSizer()
  34         sizer.Add(wxBoxSizer())         # dummy sizer
  35         self.page1.SetAutoLayout(True)
  36         self.page1.SetSizer(sizer)
  37         self.AddPage(self.page1, 'Properties')
  38         # Second page
  39         self.page2 = wxScrolledWindow(self, -1)
  40         sizer = wxBoxSizer()
  41         sizer.Add(wxBoxSizer())         # dummy sizer
  42         self.page2.SetAutoLayout(True)
  43         self.page2.SetSizer(sizer)
  44         # Cache for already used panels
  45         self.pageCache = {}             # cached property panels
  46         self.stylePageCache = {}        # cached style panels
  47         # Dummy parent window for cache pages
  48         self.cacheParent = wxFrame(None, -1, 'i am invisible')
  49     # Delete child windows and recreate page sizer
  50     def ResetPage(self, page):
  51         topSizer = page.GetSizer()
  52         sizer = topSizer.GetChildren()[0].GetSizer()
  53         for w in page.GetChildren():
  54             sizer.Remove(w)
  55             if isinstance(w, ParamPage):
  56                 # With SetParent, we wouldn't need this
  57                 w.Reparent(self.cacheParent)
  58             else:
  59                 w.Destroy()
  60         topSizer.Remove(sizer)
  61         # Create new windows
  62         sizer = wxBoxSizer(wxVERTICAL)
  63         # Special case - resize html window
  64         if g.conf.panic:
  65             topSizer.Add(sizer, 1, wxEXPAND)
  66         else:
  67             topSizer.Add(sizer, 0, wxALL, 5)
  68         return sizer
  69     def SetData(self, xxx):
  70         self.pages = []
  71         # First page
  72         # Set cached or new page
  73         # Remove current objects and sizer
  74         sizer = self.ResetPage(self.page1)
  75         if not xxx or (not xxx.allParams and not xxx.hasName):
  76             if g.tree.selection:
  77                 sizer.Add(wxStaticText(self.page1, -1, 'This item has no properties.'))
  78             else:                       # nothing selected
  79                 # If first time, show some help
  80                 if g.conf.panic:
  81                     html = wxHtmlWindow(self.page1, -1, wxDefaultPosition,
  82                                         wxDefaultSize, wxSUNKEN_BORDER)
  83                     html.SetPage(g.helpText)
  84                     sizer.Add(html, 1, wxEXPAND)
  85                     g.conf.panic = False
  86                 else:
  87                     sizer.Add(wxStaticText(self.page1, -1, 'Select a tree item.'))
  88         else:
  89             g.currentXXX = xxx.treeObject()
  90             # Normal or SizerItem page
  91             isGBSizerItem = isinstance(xxx.parent, xxxGridBagSizer)
  92             cacheID = (xxx.__class__, isGBSizerItem)
  93             try:
  94                 page = self.pageCache[cacheID]
  95                 page.box.SetLabel(xxx.panelName())
  96                 page.Reparent(self.page1)
  97             except KeyError:
  98                 page = PropPage(self.page1, xxx.panelName(), xxx)
  99                 self.pageCache[cacheID] = page
 100             page.SetValues(xxx)
 101             self.pages.append(page)
 102             sizer.Add(page, 1, wxEXPAND)
 103             if xxx.hasChild:
 104                 # Special label for child objects - they may have different GUI
 105                 cacheID = (xxx.child.__class__, xxx.__class__)
 106                 try:
 107                     page = self.pageCache[cacheID]
 108                     page.box.SetLabel(xxx.child.panelName())
 109                     page.Reparent(self.page1)
 110                 except KeyError:
 111                     page = PropPage(self.page1, xxx.child.panelName(), xxx.child)
 112                     self.pageCache[cacheID] = page
 113                 page.SetValues(xxx.child)
 114                 self.pages.append(page)
 115                 sizer.Add(page, 0, wxEXPAND | wxTOP, 5)
 116         self.page1.Layout()
 117         size = self.page1.GetSizer().GetMinSize()
 118         self.page1.SetScrollbars(1, 1, size.width, size.height, 0, 0, True)
 119
 120         # Second page
 121         # Create if does not exist
 122         if xxx and xxx.treeObject().hasStyle:
 123             xxx = xxx.treeObject()
 124             # Simplest case: set data if class is the same
 125             sizer = self.ResetPage(self.page2)
 126             try:
 127                 page = self.stylePageCache[xxx.__class__]
 128                 page.Reparent(self.page2)
 129             except KeyError:
 130                 page = StylePage(self.page2, xxx.className + ' style', xxx)
 131                 self.stylePageCache[xxx.__class__] = page
 132             page.SetValues(xxx)
 133             self.pages.append(page)
 134             sizer.Add(page, 0, wxEXPAND)
 135             # Add page if not exists
 136             if not self.GetPageCount() == 2:
 137                 self.AddPage(self.page2, 'Style')
 138             self.page2.Layout()
 139             size = self.page2.GetSizer().GetMinSize()
 140             self.page2.SetScrollbars(1, 1, size.width, size.height, 0, 0, True)
 141         else:
 142             # Remove page if exists
 143             if self.GetPageCount() == 2:
 144                 self.SetSelection(0)
 145                 self.page1.Refresh()
 146                 self.RemovePage(1)
 147         self.modified = False
 148     def Clear(self):
 149         self.SetData(None)
 150         self.modified = False
 151     # If some parameter has changed
 152     def IsModified(self):
 153         return self.modified
 154     def SetModified(self, value):
 155         # Register undo object when modifying first time
 156         if not self.modified and value:
 157            g.undoMan.RegisterUndo(UndoEdit())
 158         self.modified = value
 159     def Apply(self):
 160         for p in self.pages: p.Apply()
 161
 162 ################################################################################
 163
 164 # General class for notebook pages
 165 class ParamPage(wxPanel):
 166     def __init__(self, parent, xxx):
 167         wxPanel.__init__(self, parent, -1)
 168         self.SetBackgroundColour(parent.GetBackgroundColour())
 169         self.SetForegroundColour(parent.GetForegroundColour())
 170         self.xxx = xxx
 171         # Register event handlers
 172         for id in paramIDs.values():
 173             EVT_CHECKBOX(self, id, self.OnCheckParams)
 174         self.checks = {}
 175         self.controls = {}              # save python objects
 176         self.controlName = None
 177
 178     def OnCheckParams(self, evt):
 179         xxx = self.xxx
 180         param = evt.GetEventObject().GetName()
 181         w = self.controls[param]
 182         w.Enable(True)
 183         objElem = xxx.element
 184         if evt.IsChecked():
 185             # Ad  new text node in order of allParams
 186             w.SetValue('')              # set empty (default) value
 187             w.SetModified()             # mark as changed
 188             elem = g.tree.dom.createElement(param)
 189             # Some classes are special
 190             if param == 'font':
 191                 xxx.params[param] = xxxParamFont(xxx.element, elem)
 192             elif param in xxxObject.bitmapTags:
 193                 xxx.params[param] = xxxParamBitmap(elem)
 194             else:
 195                 xxx.params[param] = xxxParam(elem)
 196             # Find place to put new element: first present element after param
 197             found = False
 198             paramStyles = xxx.allParams + xxx.styles
 199             for p in paramStyles[paramStyles.index(param) + 1:]:
 200                 # Content params don't have same type
 201                 if xxx.params.has_key(p) and p != 'content':
 202                     found = True
 203                     break
 204             if found:
 205                 nextTextElem = xxx.params[p].node
 206                 objElem.insertBefore(elem, nextTextElem)
 207             else:
 208                 objElem.appendChild(elem)
 209         else:
 210             # Remove parameter
 211             xxx.params[param].remove()
 212             del xxx.params[param]
 213             w.SetValue('')
 214             w.modified = False          # mark as not changed
 215             w.Enable(False)
 216         # Set modified flag (provokes undo storing is necessary)
 217         panel.SetModified(True)
 218     def Apply(self):
 219         xxx = self.xxx
 220         if self.controlName:
 221             name = self.controlName.GetValue()
 222             if xxx.name != name:
 223                 xxx.name = name
 224                 xxx.element.setAttribute('name', name)
 225         for param, w in self.controls.items():
 226             if w.modified:
 227                 paramObj = xxx.params[param]
 228                 value = w.GetValue()
 229                 if param in xxx.specials:
 230                     xxx.setSpecial(param, value)
 231                 else:
 232                     paramObj.update(value)
 233     # Save current state
 234     def SaveState(self):
 235         self.origChecks = map(lambda i: (i[0], i[1].GetValue()), self.checks.items())
 236         self.origControls = map(lambda i: (i[0], i[1].GetValue(), i[1].IsEnabled()),
 237                             self.controls.items())
 238         if self.controlName:
 239             self.origName = self.controlName.GetValue()
 240     # Return original values
 241     def GetState(self):
 242         if self.controlName:
 243             return (self.origChecks, self.origControls, self.origName)
 244         else:
 245             return (self.origChecks, self.origControls)
 246     # Set values from undo data
 247     def SetState(self, state):
 248         for k,v in state[0]:
 249             self.checks[k].SetValue(v)
 250         for k,v,e in state[1]:
 251             self.controls[k].SetValue(v)
 252             self.controls[k].Enable(e)
 253             if e: self.controls[k].modified = True
 254         if self.controlName:
 255             self.controlName.SetValue(state[2])
 256
 257 ################################################################################
 258
 259 # Panel for displaying properties
 260 class PropPage(ParamPage):
 261     def __init__(self, parent, label, xxx):
 262         ParamPage.__init__(self, parent, xxx)
 263         self.box = wxStaticBox(self, -1, label)
 264         self.box.SetFont(g.labelFont())
 265         topSizer = wxStaticBoxSizer(self.box, wxVERTICAL)
 266         sizer = wxFlexGridSizer(len(xxx.allParams), 2, 1, 1)
 267         sizer.AddGrowableCol(1)
 268         if xxx.hasName:
 269             label = wxStaticText(self, -1, 'XML ID:', size=(100,-1))
 270             control = ParamText(self, 'XML_name', 200)
 271             sizer.AddMany([ (label, 0, wxALIGN_CENTER_VERTICAL),
 272                             (control, 0, wxALIGN_CENTER_VERTICAL | wxBOTTOM | wxGROW, 5) ])
 273             self.controlName = control
 274         for param in xxx.allParams:
 275             present = xxx.params.has_key(param)
 276             if param in xxx.required:
 277                 label = wxStaticText(self, paramIDs[param], param + ':',
 278                                      size = (100,-1), name = param)
 279             else:
 280                 # Notebook has one very loooooong parameter
 281                 if param == 'usenotebooksizer': sParam = 'usesizer:'
 282                 else: sParam = param + ':'
 283                 label = wxCheckBox(self, paramIDs[param], sParam,
 284                                    size = (100,-1), name = param)
 285                 self.checks[param] = label
 286             try:
 287                 typeClass = xxx.paramDict[param]
 288             except KeyError:
 289                 try:
 290                     # Standart type
 291                     typeClass = paramDict[param]
 292                 except KeyError:
 293                     # Default
 294                     typeClass = ParamText
 295             control = typeClass(self, param)
 296             control.Enable(present)
 297             sizer.AddMany([ (label, 0, wxALIGN_CENTER_VERTICAL),
 298                             (control, 0, wxALIGN_CENTER_VERTICAL | wxGROW) ])
 299             self.controls[param] = control
 300         topSizer.Add(sizer, 1, wxALL | wxEXPAND, 3)
 301         self.SetAutoLayout(True)
 302         self.SetSizer(topSizer)
 303         topSizer.Fit(self)
 304     def SetValues(self, xxx):
 305         self.xxx = xxx
 306         self.origChecks = []
 307         self.origControls = []
 308         # Set values, checkboxes to False, disable defaults
 309         if xxx.hasName:
 310             self.controlName.SetValue(xxx.name)
 311             self.origName = xxx.name
 312         for param in xxx.allParams:
 313             w = self.controls[param]
 314             w.modified = False
 315             try:
 316                 value = xxx.params[param].value()
 317                 w.Enable(True)
 318                 w.SetValue(value)
 319                 if not param in xxx.required:
 320                     self.checks[param].SetValue(True)
 321                     self.origChecks.append((param, True))
 322                 self.origControls.append((param, value, True))
 323             except KeyError:
 324                 self.checks[param].SetValue(False)
 325                 w.SetValue('')
 326                 w.Enable(False)
 327                 self.origChecks.append((param, False))
 328                 self.origControls.append((param, '', False))
 329
 330 ################################################################################
 331
 332 # Style notebook page
 333 class StylePage(ParamPage):
 334     def __init__(self, parent, label, xxx):
 335         ParamPage.__init__(self, parent, xxx)
 336         box = wxStaticBox(self, -1, label)
 337         box.SetFont(g.labelFont())
 338         topSizer = wxStaticBoxSizer(box, wxVERTICAL)
 339         sizer = wxFlexGridSizer(len(xxx.styles), 2, 1, 1)
 340         sizer.AddGrowableCol(1)
 341         for param in xxx.styles:
 342             present = xxx.params.has_key(param)
 343             check = wxCheckBox(self, paramIDs[param],
 344                                param + ':', size = (100,-1), name = param)
 345             check.SetValue(present)
 346             control = paramDict[param](self, name = param)
 347             control.Enable(present)
 348             sizer.AddMany([ (check, 0, wxALIGN_CENTER_VERTICAL),
 349                             (control, 0, wxALIGN_CENTER_VERTICAL | wxGROW) ])
 350             self.checks[param] = check
 351             self.controls[param] = control
 352         topSizer.Add(sizer, 1, wxALL | wxEXPAND, 3)
 353         self.SetAutoLayout(True)
 354         self.SetSizer(topSizer)
 355         topSizer.Fit(self)
 356     # Set data for a cahced page
 357     def SetValues(self, xxx):
 358         self.xxx = xxx
 359         self.origChecks = []
 360         self.origControls = []
 361         for param in xxx.styles:
 362             present = xxx.params.has_key(param)
 363             check = self.checks[param]
 364             check.SetValue(present)
 365             w = self.controls[param]
 366             w.modified = False
 367             if present:
 368                 value = xxx.params[param].value()
 369             else:
 370                 value = ''
 371             w.SetValue(value)
 372             w.Enable(present)
 373             self.origChecks.append((param, present))
 374             self.origControls.append((param, value, present))
 375