Package textInfos :: Class FieldCommand
[hide private]
[frames] | no frames]

Class FieldCommand

source code

object --+
         |
        FieldCommand

A command indicating a Field in a sequence of text and fields. When retrieving text with its associated fields, a TextInfo provides a sequence of text strings and FieldCommands. A command indicates the start or end of a control or that the formatting of the text has changed.

Instance Methods [hide private]
 
__init__(self, command, field)
Constructor.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, command, field)
(Constructor)

source code 

Constructor.

Parameters:
  • command - The command; one of: "controlStart", indicating the start of a ControlField; "controlEnd", indicating the end of a ControlField; or "formatChange", indicating a FormatField change.
  • field (Field) - The field associated with this command; may be None for controlEnd.
Overrides: object.__init__