API docs for “formless.annotate”

Line #	Kind	Name	Docs
22	Class	count	Undocumented
32	Class	InputError	A Typed instance was unable to coerce from a string to the
43	Class	ValidateError	A Binding instance was unable to coerce all it's arguments from a
72	Class	Typed	A typed value. Subclasses of Typed are constructed inside of
148	Class	String	A string that is expected to be reasonably short and contain no
173	Class	Text	A string that is likely to be of a significant length and
179	Class	Password	Password is used when asking a user for a new password. The renderer
187	Class	PasswordEntry	PasswordEntry is used to ask for an existing password. Typical use
193	Class	FileUpload	Undocumented
200	Class	Integer	Undocumented
219	Class	Real	Undocumented
234	Class	Boolean	Undocumented
243	Class	FixedDigitInteger	Undocumented
258	Class	Directory	Undocumented
272	Class	Choice	Allow the user to pick from a list of "choices", presented in a drop-down
336	Class	Radio	Type influencing presentation! horray!
343	Class	Any	Marker which indicates any object type.
348	Class	Object	Undocumented
361	Class	List	No class docstring; 1/5 methods documented
402	Class	Dictionary	Undocumented
406	Class	Table	Undocumented
410	Class	Request	Marker that indicates that an autocallable should be passed the
422	Class	Context	Marker that indicates that an autocallable should be passed the
434	Class	Button	Undocumented
439	Class	Compound	Undocumented
453	Class	Method	Undocumented
460	Class	Group	Undocumented
464	Function	autocallable	Describe a method in a TypedInterface as being callable through the
492	Class	Binding	Bindings bind a Typed instance to a name. When TypedInterface is subclassed,
550	Class	Argument	Undocumented
554	Class	Property	Undocumented
561	Class	MethodBinding	No class docstring; 1/4 methods documented
584	Class	ElementBinding	An ElementBinding binds a key to an element of a container.
594	Class	GroupBinding	A GroupBinding is a way of naming a group of other Bindings.
631	Function	caps	Undocumented
635	Function	nameToLabel	Undocumented
670	Function	labelAndDescriptionFromDocstring	Undocumented
683	Class	MetaTypedInterface	The metaclass for TypedInterface. When TypedInterface is subclassed,
851	Interface	TypedInterface	...

def autocallable(method, action=None, visible=False, **kw): (source)

Describe a method in a TypedInterface as being callable through the UI. The "action" paramter will be used to label the action button, or the user interface element which performs the method call.

Use this like a method adapter around a method in a TypedInterface:

>>> class IFoo(TypedInterface):
...     def doSomething():
...         '''Do Something
...         
...         Do some action bla bla'''
...         return None
...     doSomething = autocallable(doSomething, action="Do it!!")

Module f.annotate