Inspector.py

Inspects and edits design-time components, manages property editors and interacts with the designer and companions

Classes

ConstrNameValue
EventNameValue
EventsWindow
InspectorConstrScrollWin
InspectorEventScrollWin
InspectorFrame
InspectorNotebook
InspectorPropScrollWin
InspectorScrollWin
NameValue
NameValueEditorScrollWin
ParentTree
PropNameValue


ConstrNameValue

Name value for constructor parameters

Derived from

NameValue

Methods


*

EventNameValue

Name value for event definitions

Derived from

NameValue

Methods

initFromComponent


EventNameValue.initFromComponent

initFromComponent(self)

 


*

EventsWindow

Window that hosts event name values and event category selection

Derived from

wxSplitterWindow

Methods

OnAdd
OnCatClassDeselect
OnCatClassSelect
OnDelete
OnMacClassDeselect
OnMacClassSelect
OnMacroSelect
__init__
addEvent
cleanup
destroy
extendHelpUrl
findMacro
getEvent
macroNameToEvtName
readObject


EventsWindow.OnAdd

OnAdd(self, event)

 


EventsWindow.OnCatClassDeselect

OnCatClassDeselect(self, event)

 


EventsWindow.OnCatClassSelect

OnCatClassSelect(self, event)

 


EventsWindow.OnDelete

OnDelete(self, event)

 


EventsWindow.OnMacClassDeselect

OnMacClassDeselect(self, event)

 


EventsWindow.OnMacClassSelect

OnMacClassSelect(self, event)

 


EventsWindow.OnMacroSelect

OnMacroSelect(self, event)

 


EventsWindow.__init__

__init__(self, parent, inspector)

 


EventsWindow.addEvent

addEvent(self, name, value, wid = None)

 


EventsWindow.cleanup

cleanup(self)

 


EventsWindow.destroy

destroy(self)

 


EventsWindow.extendHelpUrl

extendHelpUrl(self, url)

 


EventsWindow.findMacro

findMacro(self, name)

 


EventsWindow.getEvent

getEvent(self, name)

 


EventsWindow.macroNameToEvtName

macroNameToEvtName(self, macName)

 


EventsWindow.readObject

readObject(self)

 


*

InspectorConstrScrollWin

Specialised InspectorScrollWin that understands contructor parameters

Derived from

InspectorScrollWin

Methods

addConstr
addProp
findInConstrLst
readObject


InspectorConstrScrollWin.addConstr

addConstr(self, name)

 


InspectorConstrScrollWin.addProp

addProp(self, name, propWrap)

 


InspectorConstrScrollWin.findInConstrLst

findInConstrLst(name, constrList)

 


InspectorConstrScrollWin.readObject

readObject(self, constrList)

 


*

InspectorEventScrollWin

Specialised InspectorScrollWin that understands events

Derived from

InspectorScrollWin

Methods

addEvent
readObject
removeEvent


InspectorEventScrollWin.addEvent

addEvent(self, name)

 


InspectorEventScrollWin.readObject

readObject(self)

 


InspectorEventScrollWin.removeEvent

removeEvent(self, name)

 


*

InspectorFrame

Main Inspector frame, mainly does frame initialisation and handles events from the toolbar

Derived from

wxFrame

Methods

OnCancel
OnCloseWindow
OnCopy
OnCut
OnDelete
OnHelp
OnPaste
OnPost
OnSizing
OnUp
__init__
_init_ctrls
_init_utils
cleanup
constructorUpdate
eventUpdate
initSashes
pageUpdate
propertyUpdate
selectObject
selectedCtrlHelpFile


InspectorFrame.OnCancel

OnCancel(self, event)

 


InspectorFrame.OnCloseWindow

OnCloseWindow(self, event)

 


InspectorFrame.OnCopy

OnCopy(self, event)

 


InspectorFrame.OnCut

OnCut(self, event)

 


InspectorFrame.OnDelete

OnDelete(self, event)

 


InspectorFrame.OnHelp

OnHelp(self, event)

 


InspectorFrame.OnPaste

OnPaste(self, event)

 


InspectorFrame.OnPost

OnPost(self, event)

 


InspectorFrame.OnSizing

OnSizing(self, event)

 


InspectorFrame.OnUp

OnUp(self, event)

 


InspectorFrame.__init__

__init__(self, parent)

 


InspectorFrame._init_ctrls

_init_ctrls(self, prnt)

 


InspectorFrame._init_utils

_init_utils(self)

 


InspectorFrame.cleanup

cleanup(self)

 


InspectorFrame.constructorUpdate

constructorUpdate(self, name)

 


InspectorFrame.eventUpdate

eventUpdate(self, name, delete = false)

 


InspectorFrame.initSashes

initSashes(self)

 


InspectorFrame.pageUpdate

pageUpdate(self, page, name)

 


InspectorFrame.propertyUpdate

propertyUpdate(self, name)

 


InspectorFrame.selectObject

selectObject(self, obj, compn, selectInContainment = true)

 Select an object in the inspector by populating the property pages. This method is called from the InspectableObjectCollection derived classes


InspectorFrame.selectedCtrlHelpFile

selectedCtrlHelpFile(self)

 Return the help file/link associated with the selected control


*

InspectorNotebook

Notebook that hosts Inspector pages

Derived from

wxNotebook

Methods

AddPage
__init__
destroy
extendHelpUrl


InspectorNotebook.AddPage

AddPage(self, window, name)

 


InspectorNotebook.__init__

__init__(self, parent)

 


InspectorNotebook.destroy

destroy(self)

 


InspectorNotebook.extendHelpUrl

extendHelpUrl(self, name)

 


*

InspectorPropScrollWin

Specialised InspectorScrollWin that understands properties

Derived from

InspectorScrollWin

Methods

collapse
expand
extendHelpUrl
readObject
setNameValues


InspectorPropScrollWin.collapse

collapse(self, nameValue)

 


InspectorPropScrollWin.expand

expand(self, nameValue)

 


InspectorPropScrollWin.extendHelpUrl

extendHelpUrl(self, url)

 


InspectorPropScrollWin.readObject

readObject(self, propList)

 


InspectorPropScrollWin.setNameValues

setNameValues(self, compn, rootCompn, nameValues, insIdx, indent)

 


*

InspectorScrollWin

Derivative of NameValueEditorScrollWin that adds knowledge about the Inspector and implements keyboard events

Derived from

NameValueEditorScrollWin

Methods

OnCrsDown
OnCrsUp
OnEnter
OnUndo
__init__
deleteNameValues
destroy
extendHelpUrl
readObject


InspectorScrollWin.OnCrsDown

OnCrsDown(self, event)

 


InspectorScrollWin.OnCrsUp

OnCrsUp(self, event)

 


InspectorScrollWin.OnEnter

OnEnter(self, event)

 


InspectorScrollWin.OnUndo

OnUndo(self, event)

 


InspectorScrollWin.__init__

__init__(self, parent, inspector)

 


InspectorScrollWin.deleteNameValues

deleteNameValues(self, idx, count, cancel = false)

 


InspectorScrollWin.destroy

destroy(self)

 


InspectorScrollWin.extendHelpUrl

extendHelpUrl(self, url)

 


InspectorScrollWin.readObject

readObject(self, propList)

 Override this method in derived classes to implement the initialisation and construction of the name value list


*

NameValue

Base class for all name value pairs that appear in the Inspector

Derived from

Methods

OnExpand
OnSelect
destroy
hideEditor
resize
setPos
showEdit


NameValue.OnExpand

OnExpand(self, event)

 


NameValue.OnSelect

OnSelect(self, event)

 


NameValue.destroy

destroy(self, cancel = false)

 


NameValue.hideEditor

hideEditor(self, cancel = false)

 


NameValue.resize

resize(self, nameWidth, valueWidth)

 


NameValue.setPos

setPos(self, idx)

 


NameValue.showEdit

showEdit(self)

 


*

NameValueEditorScrollWin

Window that hosts a list of name values. Also provides capability to scroll a line at a time, depending on the size of the list

Derived from

wxScrolledWindow

Methods

OnNameSize
OnSize
__init__
cleanup
getHeight
getNameValue
getValueWidth
getWidth
initSash
propertySelected
refreshSplitter
resizeNames


NameValueEditorScrollWin.OnNameSize

OnNameSize(self, event)

 


NameValueEditorScrollWin.OnSize

OnSize(self, event)

 


NameValueEditorScrollWin.__init__

__init__(self, parent)

 


NameValueEditorScrollWin.cleanup

cleanup(self)

 


NameValueEditorScrollWin.getHeight

getHeight(self)

 


NameValueEditorScrollWin.getNameValue

getNameValue(self, name)

 


NameValueEditorScrollWin.getValueWidth

getValueWidth(self)

 


NameValueEditorScrollWin.getWidth

getWidth(self)

 


NameValueEditorScrollWin.initSash

initSash(self)

 


NameValueEditorScrollWin.propertySelected

propertySelected(self, nameValue)

 Called when a new name value is selected


NameValueEditorScrollWin.refreshSplitter

refreshSplitter(self)

 


NameValueEditorScrollWin.resizeNames

resizeNames(self)

 


*

ParentTree

Specialised tree ctrl that displays parent child relationship of controls on the frame

Derived from

wxTreeCtrl

Methods

OnSelect
__init__
addChildren
cleanup
extendHelpUrl
refreshCtrl
selectItemGUIOnly
selectName
selectedName


ParentTree.OnSelect

OnSelect(self, event)

 Event triggered when the selection changes in the tree


ParentTree.__init__

__init__(self, parent)

 


ParentTree.addChildren

addChildren(self, parent, dict, designer)

 Recursive method to construct parent/child relationships in a tree


ParentTree.cleanup

cleanup(self)

 


ParentTree.extendHelpUrl

extendHelpUrl(self, url)

 


ParentTree.refreshCtrl

refreshCtrl(self, root, relDict, designer)

 


ParentTree.selectItemGUIOnly

selectItemGUIOnly(self, name)

 


ParentTree.selectName

selectName(self, name)

 


ParentTree.selectedName

selectedName(self)

 


*

PropNameValue

Name value for properties, usually Get/Set methods, but can also be routed to Companion methods

Derived from

NameValue

Methods

initFromComponent


PropNameValue.initFromComponent

initFromComponent(self)

 


*