wxoo.configui.specifier
index
p:\wxproperties\wxoo\configui\specifier.py

A (localized) token representing an action

 
Modules
       
basicproperty.basic
basicproperty.common
wxoo.debug
basictypes.list_types
basicproperty.propertied
wxoo.configui.registry

 
Classes
       
ListOf(rlist)
listof_Specifiers
Propertied(object)
Specifier
SpecifierSet

 
class Specifier(Propertied)
    Specifier "description" of an action used to configure the UI
 
The specifier is a holder for information about an action,
not an action itself.  It is designed to be edited by the
programmer and/or translator at design-time.
 
Each specifier declares an ID, which is used to match it
with both Menu and Toolbar items and to the programmatic
action which implements the associated functionality.
 
The purpose of using a specifier, rather than adding
the details to the action is to allow the action to be
shared among multiple localizations.  The specifier contains
all of the user-visible metadata, which allows a translator
to replace the specifier with a localized version which
uses the same ID as the original.
 
 
Method resolution order:
Specifier
Propertied
object

Methods defined here:
GetAction(self)
Retrieve the action associated with this specifier
GetCommandId(self)
Get the wxWindows command ID for this action
OnTrigger(self, event)
The action has been triggered
 
Need to figure out the context for the action :(

Data and other attributes defined here:
ID = <StringProperty 'ID'>
The application-wide specifier string for this action
description = <StringProperty 'description'>
Description for use in status bars
helpText = <StringProperty 'helpText'>
Context-sensitive and generic help description
icon = <BasicProperty 'icon'>
Standard (32x32) bitmap for use in menus and toolbars
longName = <StringProperty 'longName'>
Long name, for use in tooltips and documentation titles
shortName = <StringProperty 'shortName'>
Short name, for use in menus and labels
smallIcon = <BasicProperty 'smallIcon'>
Small (16x15) bitmap for use in menus and toolbars

Methods inherited from Propertied:
__init__(self, *arguments, **namedarguments)
Propertied object initialisation, allows passing in initial values for properties by name
__str__(self)
Get a friendly representation of the object
clone(self, **newValues)
Clone this object, with optional new property values
 
This method calls the __init__ method of your class with
the current property values of your class.  Providing newValues
(a dictionary) overrides property settings with new values.
getCloneProperties(self)
Get properties dictionary (key:value) for use in cloning of the instance
 
By default you get getProperties()' values, with an
attempt made to use the property's name, then the property's
direct "__get__" method.
toString(self, indentation='', alreadyDone=None, indentString=' ')
Get a nicely formatted representation of this object
 
This version assumes that getProperties returns
the list of properties which should be presented,
it recursively calls it's children with greater
indents to get their representations.
 
indentation -- current string indentation level
alreadyDone -- set of object ids which are already finished
 
XXX Needs a far better API, likely a stand-alone class
        without the automatic inheritance problems here :(

Class methods inherited from Propertied:
getProperties(cls) from type
Get the BasicProperty properties for a particular object's class

Data and other attributes inherited from Propertied:
__dict__ = <dictproxy object at 0x027F8350>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Propertied' objects>
list of weak references to the object (if defined)

 
class SpecifierSet(Propertied)
    A collection of Specifiers
 
 
Method resolution order:
SpecifierSet
Propertied
object

Methods defined here:
BuildMapping(self)
Build an ID:specifier mapping for an application to use
GetAction(self, ID)
Get a specifier by ID

Data and other attributes defined here:
children = <ListProperty 'children'>
The list of Specifiers
name = <StringProperty 'name'>
Name of the particular action set

Methods inherited from Propertied:
__init__(self, *arguments, **namedarguments)
Propertied object initialisation, allows passing in initial values for properties by name
__str__(self)
Get a friendly representation of the object
clone(self, **newValues)
Clone this object, with optional new property values
 
This method calls the __init__ method of your class with
the current property values of your class.  Providing newValues
(a dictionary) overrides property settings with new values.
getCloneProperties(self)
Get properties dictionary (key:value) for use in cloning of the instance
 
By default you get getProperties()' values, with an
attempt made to use the property's name, then the property's
direct "__get__" method.
toString(self, indentation='', alreadyDone=None, indentString=' ')
Get a nicely formatted representation of this object
 
This version assumes that getProperties returns
the list of properties which should be presented,
it recursively calls it's children with greater
indents to get their representations.
 
indentation -- current string indentation level
alreadyDone -- set of object ids which are already finished
 
XXX Needs a far better API, likely a stand-alone class
        without the automatic inheritance problems here :(

Class methods inherited from Propertied:
getProperties(cls) from type
Get the BasicProperty properties for a particular object's class

Data and other attributes inherited from Propertied:
__dict__ = <dictproxy object at 0x027A8DB0>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Propertied' objects>
list of weak references to the object (if defined)

 
class listof_Specifiers(ListOf)
    
Method resolution order:
listof_Specifiers
ListOf
rlist
list
object

Data and other attributes defined here:
dataType = 'list.configui.Specifier'

Methods inherited from ListOf:
beforeAdd(self, value)
Called before all attempts to add an item

Methods inherited from rlist:
__iadd__ = extend(self, value)
extend with value checking
__init__(self, value=None)
Initialize the restricted list object
__setitem__(self, index, value)
__setitem__ with value checking
__setslice__(self, start, stop, value)
__setslice__ with value checking
append(self, value)
append with value checking
beforeMultipleAdd(self, value)
Called before attempts to add more than one item (beforeAdd has already be called for each item)
extend(self, value)
extend with value checking
insert(self, index, value)
insert with value checking

Data and other attributes inherited from rlist:
__dict__ = <dictproxy object at 0x027F82F0>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'rlist' objects>
list of weak references to the object (if defined)

Methods inherited from list:
__add__(...)
x.__add__(y) <==> x+y
__contains__(...)
x.__contains__(y) <==> y in x
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__delslice__(...)
x.__delslice__(i, j) <==> del x[i:j]
 
Use of negative indices is not supported.
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__imul__(...)
x.__imul__(y) <==> x*=y
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__mul__(...)
x.__mul__(n) <==> x*n
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__rmul__(...)
x.__rmul__(n) <==> n*x
count(...)
L.count(value) -> integer -- return number of occurrences of value
index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value
pop(...)
L.pop([index]) -> item -- remove and return item at index (default last)
remove(...)
L.remove(value) -- remove first occurrence of value
reverse(...)
L.reverse() -- reverse *IN PLACE*
sort(...)
L.sort(cmpfunc=None) -- stable sort *IN PLACE*; cmpfunc(x, y) -> -1, 0, 1

Data and other attributes inherited from list:
__new__ = <built-in method __new__ of type object at 0x1E0C3C78>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
Functions
       
_(value)
Stand-in for gettext module
getDefaultLongName(self, client, property)
Get a default long name (the short name)