Go to the latest version of this document.

# ``twisted`.`python`.`formmethod`.`Flags``

class documentation

`class Flags(Argument): (source)`

Known subclasses: `twisted.python.formmethod.CheckGroup`

Constructor: `Flags(name, flags, default, shortDesc, ...)`

View In Hierarchy

The result of a checkbox group or multi-menu. The flags should be a list of tuples of tag, value, and description. The tag will be the value returned if the user hits "Submit", and the description is the bale for the enumerated type. default is a list of all the values (second elements in flags). If no defaults are specified, initially nothing will be selected. Several items may be selected at once.

Method | `__init__` | Undocumented
Method | `coerce` | Convert the value to the correct format.
Instance Variable | `flags` | Undocumented

Inherited from `Argument`:

Method | `addHints` | Undocumented
Method | `getHint` | Undocumented
Method | `getLongDescription` | Undocumented
Method | `getShortDescription` | Undocumented
Class Variable | `defaultDefault` | Undocumented
Instance Variable | `allowNone` | Undocumented
Instance Variable | `default` | Undocumented
Instance Variable | `hints` | Undocumented
Instance Variable | `longDesc` | Undocumented
Instance Variable | `name` | Undocumented
Instance Variable | `shortDesc` | Undocumented

def __init__(self, name, flags=(), default=(), shortDesc=None, longDesc=None, hints=None, allowNone=1): (source)
overrides `twisted.python.formmethod.Argument.__init__`

Undocumented

def coerce(self, inFlagKeys): (source)
overrides `twisted.python.formmethod.Argument.coerce`

Convert the value to the correct format.

flags = (source)

Undocumented