| 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 | self.page2.Hide() |
| 41 | sizer = wxBoxSizer() |
| 42 | sizer.Add(wxBoxSizer()) # dummy sizer |
| 43 | self.page2.SetAutoLayout(True) |
| 44 | self.page2.SetSizer(sizer) |
| 45 | # Cache for already used panels |
| 46 | self.pageCache = {} # cached property panels |
| 47 | self.stylePageCache = {} # cached style panels |
| 48 | |
| 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.Detach(w) |
| 55 | if isinstance(w, ParamPage): |
| 56 | if w.IsShown(): |
| 57 | w.Hide() |
| 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 | |
| 70 | def SetData(self, xxx): |
| 71 | self.pages = [] |
| 72 | # First 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.Show() |
| 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.Show() |
| 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.Show() |
| 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 | if 'wxGTK' in wx.PlatformInfo: |
| 140 | self.page2.Show(True) |
| 141 | size = self.page2.GetSizer().GetMinSize() |
| 142 | self.page2.SetScrollbars(1, 1, size.width, size.height, 0, 0, True) |
| 143 | else: |
| 144 | # Remove page if exists |
| 145 | if self.GetPageCount() == 2: |
| 146 | self.SetSelection(0) |
| 147 | self.page1.Refresh() |
| 148 | self.RemovePage(1) |
| 149 | self.modified = False |
| 150 | |
| 151 | def Clear(self): |
| 152 | self.SetData(None) |
| 153 | self.modified = False |
| 154 | |
| 155 | # If some parameter has changed |
| 156 | def IsModified(self): |
| 157 | return self.modified |
| 158 | |
| 159 | def SetModified(self, value): |
| 160 | # Register undo object when modifying first time |
| 161 | if not self.modified and value: |
| 162 | g.undoMan.RegisterUndo(UndoEdit()) |
| 163 | self.modified = value |
| 164 | |
| 165 | def Apply(self): |
| 166 | for p in self.pages: p.Apply() |
| 167 | |
| 168 | ################################################################################ |
| 169 | |
| 170 | # General class for notebook pages |
| 171 | class ParamPage(wxPanel): |
| 172 | def __init__(self, parent, xxx): |
| 173 | wxPanel.__init__(self, parent, -1) |
| 174 | self.SetBackgroundColour(parent.GetBackgroundColour()) |
| 175 | self.SetForegroundColour(parent.GetForegroundColour()) |
| 176 | self.xxx = xxx |
| 177 | # Register event handlers |
| 178 | for id in paramIDs.values(): |
| 179 | EVT_CHECKBOX(self, id, self.OnCheckParams) |
| 180 | self.checks = {} |
| 181 | self.controls = {} # save python objects |
| 182 | self.controlName = None |
| 183 | |
| 184 | def OnCheckParams(self, evt): |
| 185 | xxx = self.xxx |
| 186 | param = evt.GetEventObject().GetName() |
| 187 | w = self.controls[param] |
| 188 | w.Enable(True) |
| 189 | objElem = xxx.element |
| 190 | if evt.IsChecked(): |
| 191 | # Ad new text node in order of allParams |
| 192 | w.SetValue('') # set empty (default) value |
| 193 | w.SetModified() # mark as changed |
| 194 | elem = g.tree.dom.createElement(param) |
| 195 | # Some classes are special |
| 196 | if param == 'font': |
| 197 | xxx.params[param] = xxxParamFont(xxx.element, elem) |
| 198 | elif param in xxxObject.bitmapTags: |
| 199 | xxx.params[param] = xxxParamBitmap(elem) |
| 200 | else: |
| 201 | xxx.params[param] = xxxParam(elem) |
| 202 | # Find place to put new element: first present element after param |
| 203 | found = False |
| 204 | paramStyles = xxx.allParams + xxx.styles |
| 205 | for p in paramStyles[paramStyles.index(param) + 1:]: |
| 206 | # Content params don't have same type |
| 207 | if xxx.params.has_key(p) and p != 'content': |
| 208 | found = True |
| 209 | break |
| 210 | if found: |
| 211 | nextTextElem = xxx.params[p].node |
| 212 | objElem.insertBefore(elem, nextTextElem) |
| 213 | else: |
| 214 | objElem.appendChild(elem) |
| 215 | else: |
| 216 | # Remove parameter |
| 217 | xxx.params[param].remove() |
| 218 | del xxx.params[param] |
| 219 | w.SetValue('') |
| 220 | w.modified = False # mark as not changed |
| 221 | w.Enable(False) |
| 222 | # Set modified flag (provokes undo storing is necessary) |
| 223 | panel.SetModified(True) |
| 224 | def Apply(self): |
| 225 | xxx = self.xxx |
| 226 | if self.controlName: |
| 227 | name = self.controlName.GetValue() |
| 228 | if xxx.name != name: |
| 229 | xxx.name = name |
| 230 | xxx.element.setAttribute('name', name) |
| 231 | for param, w in self.controls.items(): |
| 232 | if w.modified: |
| 233 | paramObj = xxx.params[param] |
| 234 | value = w.GetValue() |
| 235 | if param in xxx.specials: |
| 236 | xxx.setSpecial(param, value) |
| 237 | else: |
| 238 | paramObj.update(value) |
| 239 | # Save current state |
| 240 | def SaveState(self): |
| 241 | self.origChecks = map(lambda i: (i[0], i[1].GetValue()), self.checks.items()) |
| 242 | self.origControls = map(lambda i: (i[0], i[1].GetValue(), i[1].IsEnabled()), |
| 243 | self.controls.items()) |
| 244 | if self.controlName: |
| 245 | self.origName = self.controlName.GetValue() |
| 246 | # Return original values |
| 247 | def GetState(self): |
| 248 | if self.controlName: |
| 249 | return (self.origChecks, self.origControls, self.origName) |
| 250 | else: |
| 251 | return (self.origChecks, self.origControls) |
| 252 | # Set values from undo data |
| 253 | def SetState(self, state): |
| 254 | for k,v in state[0]: |
| 255 | self.checks[k].SetValue(v) |
| 256 | for k,v,e in state[1]: |
| 257 | self.controls[k].SetValue(v) |
| 258 | self.controls[k].Enable(e) |
| 259 | if e: self.controls[k].modified = True |
| 260 | if self.controlName: |
| 261 | self.controlName.SetValue(state[2]) |
| 262 | |
| 263 | ################################################################################ |
| 264 | |
| 265 | LABEL_WIDTH = 125 |
| 266 | |
| 267 | # Panel for displaying properties |
| 268 | class PropPage(ParamPage): |
| 269 | def __init__(self, parent, label, xxx): |
| 270 | ParamPage.__init__(self, parent, xxx) |
| 271 | self.box = wxStaticBox(self, -1, label) |
| 272 | self.box.SetFont(g.labelFont()) |
| 273 | topSizer = wxStaticBoxSizer(self.box, wxVERTICAL) |
| 274 | sizer = wxFlexGridSizer(len(xxx.allParams), 2, 1, 1) |
| 275 | sizer.AddGrowableCol(1) |
| 276 | if xxx.hasName: |
| 277 | label = wxStaticText(self, -1, 'XML ID:', size=(LABEL_WIDTH,-1)) |
| 278 | control = ParamText(self, 'XML_name', 200) |
| 279 | sizer.AddMany([ (label, 0, wxALIGN_CENTER_VERTICAL), |
| 280 | (control, 0, wxALIGN_CENTER_VERTICAL | wxBOTTOM | wxGROW, 5) ]) |
| 281 | self.controlName = control |
| 282 | for param in xxx.allParams: |
| 283 | present = xxx.params.has_key(param) |
| 284 | if param in xxx.required: |
| 285 | label = wxStaticText(self, paramIDs[param], param + ':', |
| 286 | size = (LABEL_WIDTH,-1), name = param) |
| 287 | else: |
| 288 | # Notebook has one very loooooong parameter |
| 289 | if param == 'usenotebooksizer': sParam = 'usesizer:' |
| 290 | else: sParam = param + ':' |
| 291 | label = wxCheckBox(self, paramIDs[param], sParam, |
| 292 | size = (LABEL_WIDTH,-1), name = param) |
| 293 | self.checks[param] = label |
| 294 | try: |
| 295 | typeClass = xxx.paramDict[param] |
| 296 | except KeyError: |
| 297 | try: |
| 298 | # Standart type |
| 299 | typeClass = paramDict[param] |
| 300 | except KeyError: |
| 301 | # Default |
| 302 | typeClass = ParamText |
| 303 | control = typeClass(self, param) |
| 304 | control.Enable(present) |
| 305 | sizer.AddMany([ (label, 0, wxALIGN_CENTER_VERTICAL), |
| 306 | (control, 0, wxALIGN_CENTER_VERTICAL | wxGROW) ]) |
| 307 | self.controls[param] = control |
| 308 | topSizer.Add(sizer, 1, wxALL | wxEXPAND, 3) |
| 309 | self.SetAutoLayout(True) |
| 310 | self.SetSizer(topSizer) |
| 311 | topSizer.Fit(self) |
| 312 | def SetValues(self, xxx): |
| 313 | self.xxx = xxx |
| 314 | self.origChecks = [] |
| 315 | self.origControls = [] |
| 316 | # Set values, checkboxes to False, disable defaults |
| 317 | if xxx.hasName: |
| 318 | self.controlName.SetValue(xxx.name) |
| 319 | self.origName = xxx.name |
| 320 | for param in xxx.allParams: |
| 321 | w = self.controls[param] |
| 322 | w.modified = False |
| 323 | try: |
| 324 | value = xxx.params[param].value() |
| 325 | w.Enable(True) |
| 326 | w.SetValue(value) |
| 327 | if not param in xxx.required: |
| 328 | self.checks[param].SetValue(True) |
| 329 | self.origChecks.append((param, True)) |
| 330 | self.origControls.append((param, value, True)) |
| 331 | except KeyError: |
| 332 | self.checks[param].SetValue(False) |
| 333 | w.SetValue('') |
| 334 | w.Enable(False) |
| 335 | self.origChecks.append((param, False)) |
| 336 | self.origControls.append((param, '', False)) |
| 337 | |
| 338 | ################################################################################ |
| 339 | |
| 340 | # Style notebook page |
| 341 | class StylePage(ParamPage): |
| 342 | def __init__(self, parent, label, xxx): |
| 343 | ParamPage.__init__(self, parent, xxx) |
| 344 | box = wxStaticBox(self, -1, label) |
| 345 | box.SetFont(g.labelFont()) |
| 346 | topSizer = wxStaticBoxSizer(box, wxVERTICAL) |
| 347 | sizer = wxFlexGridSizer(len(xxx.styles), 2, 1, 1) |
| 348 | sizer.AddGrowableCol(1) |
| 349 | for param in xxx.styles: |
| 350 | present = xxx.params.has_key(param) |
| 351 | check = wxCheckBox(self, paramIDs[param], |
| 352 | param + ':', size = (LABEL_WIDTH,-1), name = param) |
| 353 | check.SetValue(present) |
| 354 | control = paramDict[param](self, name = param) |
| 355 | control.Enable(present) |
| 356 | sizer.AddMany([ (check, 0, wxALIGN_CENTER_VERTICAL), |
| 357 | (control, 0, wxALIGN_CENTER_VERTICAL | wxGROW) ]) |
| 358 | self.checks[param] = check |
| 359 | self.controls[param] = control |
| 360 | topSizer.Add(sizer, 1, wxALL | wxEXPAND, 3) |
| 361 | self.SetAutoLayout(True) |
| 362 | self.SetSizer(topSizer) |
| 363 | topSizer.Fit(self) |
| 364 | # Set data for a cahced page |
| 365 | def SetValues(self, xxx): |
| 366 | self.xxx = xxx |
| 367 | self.origChecks = [] |
| 368 | self.origControls = [] |
| 369 | for param in xxx.styles: |
| 370 | present = xxx.params.has_key(param) |
| 371 | check = self.checks[param] |
| 372 | check.SetValue(present) |
| 373 | w = self.controls[param] |
| 374 | w.modified = False |
| 375 | if present: |
| 376 | value = xxx.params[param].value() |
| 377 | else: |
| 378 | value = '' |
| 379 | w.SetValue(value) |
| 380 | w.Enable(present) |
| 381 | self.origChecks.append((param, present)) |
| 382 | self.origControls.append((param, value, present)) |
| 383 | |