class IPreformatted(IMinimalParagraphBase):
"""A preformatted text, similar to the <pre> tag in HTML."""
style = attr.Style(
title=u'Style',
description=(u'The paragraph style that is applied to the paragraph. '
u'See the ``paraStyle`` tag for creating a paragraph '
u'style.'),
default=SampleStyleSheet['Code'],
required=False)
text = attr.RawXMLContent(
title=u'Text',
description=(u'The text that will be layed out.'),
required=True)
maxLineLength = attr.Integer(
title=u'Max Line Length',
description=(u'The maximum number of characters on one line.'),
required=False)
newLineChars = attr.Text(
title=u'New Line Characters',
description=u'The characters placed at the beginning of a wrapped line',
required=False)
class IXPreformatted(IParagraphBase):
"""A preformatted text that allows paragraph markup."""
text = attr.RawXMLContent(
title=u'Text',
description=(u'The text that will be layed out.'),
required=True)
class IPreformatted(IMinimalParagraphBase):
"""A preformatted text, similar to the <pre> tag in HTML."""
text = attr.RawXMLContent(
title=u'Text',
description=(u'The text that will be layed out.'),
required=True)
class IXPreformatted(IParagraphBase):
"""A preformatted text that allows paragraph markup."""
style = attr.Style(
title=u'Style',
description=(u'The paragraph style that is applied to the paragraph. '
u'See the ``paraStyle`` tag for creating a paragraph '
u'style.'),
default=SampleStyleSheet['Normal'],
required=False)
text = attr.RawXMLContent(
title=u'Text',
description=(u'The text that will be layed out.'),
required=True)
class IDrawString(interfaces.IRMLDirectiveSignature):
"""Draws a simple string (left aligned) onto the canvas at the specified
location."""
x = attr.Measurement(
title=u'X-Coordinate',
description=(u'The X-coordinate of the lower-left position of the '
u'string.'),
required=True)
y = attr.Measurement(
title=u'Y-Coordinate',
description=(u'The Y-coordinate of the lower-left position of the '
u'string.'),
required=True)
text = attr.RawXMLContent(
title=u'Text',
description=(u'The string/text that is put onto the canvas.'),
required=True)
class ITableCell(interfaces.IRMLDirectiveSignature):
"""A table cell within a table."""
content = attr.RawXMLContent(
title=u'Content',
description=(u'The content of the cell; can be text or any flowable.'),
required=True)
fontName = attr.String(title=u'Font Name',
description=u'The name of the font for the cell.',
required=False)
fontSize = attr.Measurement(
title=u'Font Size',
description=u'The font size for the text of the cell.',
required=False)
leading = attr.Measurement(
title=u'Leading',
description=(u'The height of a single text line. It includes '
u'character height.'),
required=False)
fontColor = attr.Color(
title=u'Font Color',
description=u'The color in which the text will appear.',
required=False)
leftPadding = attr.Measurement(
title=u'Left Padding',
description=u'The size of the padding on the left side.',
required=False)
rightPadding = attr.Measurement(
title=u'Right Padding',
description=u'The size of the padding on the right side.',
required=False)
topPadding = attr.Measurement(
title=u'Top Padding',
description=u'The size of the padding on the top.',
required=False)
bottomPadding = attr.Measurement(
title=u'Bottom Padding',
description=u'The size of the padding on the bottom.',
required=False)
background = attr.Color(
title=u'Background Color',
description=u'The color to use as the background for the cell.',
required=False)
align = attr.Choice(title=u'Text Alignment',
description=u'The text alignment within the cell.',
choices=interfaces.ALIGN_TEXT_CHOICES,
required=False)
vAlign = attr.Choice(
title=u'Vertical Alignment',
description=u'The vertical alignment of the text within the cell.',
choices=interfaces.VALIGN_TEXT_CHOICES,
required=False)
lineBelowThickness = attr.Measurement(
title=u'Line Below Thickness',
description=u'The thickness of the line below the cell.',
required=False)
lineBelowColor = attr.Color(
title=u'Line Below Color',
description=u'The color of the line below the cell.',
required=False)
lineBelowCap = attr.Choice(
title=u'Line Below Cap',
description=u'The cap at the end of the line below the cell.',
choices=interfaces.CAP_CHOICES,
required=False)
lineBelowCount = attr.Integer(
title=u'Line Below Count',
description=(u'Describes whether the line below is a single (1) or '
u'double (2) line.'),
required=False)
lineBelowSpace = attr.Measurement(
title=u'Line Below Space',
description=u'The space of the line below the cell.',
required=False)
lineAboveThickness = attr.Measurement(
title=u'Line Above Thickness',
description=u'The thickness of the line above the cell.',
required=False)
lineAboveColor = attr.Color(
title=u'Line Above Color',
description=u'The color of the line above the cell.',
required=False)
lineAboveCap = attr.Choice(
title=u'Line Above Cap',
description=u'The cap at the end of the line above the cell.',
choices=interfaces.CAP_CHOICES,
required=False)
lineAboveCount = attr.Integer(
title=u'Line Above Count',
description=(u'Describes whether the line above is a single (1) or '
u'double (2) line.'),
required=False)
lineAboveSpace = attr.Measurement(
title=u'Line Above Space',
description=u'The space of the line above the cell.',
required=False)
lineLeftThickness = attr.Measurement(
title=u'Left Line Thickness',
description=u'The thickness of the line left of the cell.',
required=False)
lineLeftColor = attr.Color(
title=u'Left Line Color',
description=u'The color of the line left of the cell.',
required=False)
lineLeftCap = attr.Choice(
title=u'Line Left Cap',
description=u'The cap at the end of the line left of the cell.',
choices=interfaces.CAP_CHOICES,
required=False)
lineLeftCount = attr.Integer(
title=u'Line Left Count',
description=(u'Describes whether the left line is a single (1) or '
u'double (2) line.'),
required=False)
lineLeftSpace = attr.Measurement(
title=u'Line Left Space',
description=u'The space of the line left of the cell.',
required=False)
lineRightThickness = attr.Measurement(
title=u'Right Line Thickness',
description=u'The thickness of the line right of the cell.',
required=False)
lineRightColor = attr.Color(
title=u'Right Line Color',
description=u'The color of the line right of the cell.',
required=False)
lineRightCap = attr.Choice(
title=u'Line Right Cap',
description=u'The cap at the end of the line right of the cell.',
choices=interfaces.CAP_CHOICES,
required=False)
lineRightCount = attr.Integer(
title=u'Line Right Count',
description=(u'Describes whether the right line is a single (1) or '
u'double (2) line.'),
required=False)
lineRightSpace = attr.Measurement(
title=u'Line Right Space',
description=u'The space of the line right of the cell.',
required=False)
href = attr.Text(
title=u'Link URL',
description=u'When specified, the cell becomes a link to that URL.',
required=False)
destination = attr.Text(
title=u'Link Destination',
description=(u'When specified, the cell becomes a link to that '
u'destination.'),
required=False)
class IBaseLogCall(interfaces.IRMLDirectiveSignature):
message = attr.RawXMLContent(title=u'Message',
description=u'The message to be logged.',
required=True)