Module fpdf.enums

Classes

class AccessPermission (value, names=None, *, module=None, qualname=None, type=None, start=1)

Permission flags will translate as an integer on the encryption dictionary

Expand source code

class AccessPermission(IntFlag):
    "Permission flags will translate as an integer on the encryption dictionary"

    PRINT_LOW_RES = 0b000000000100
    "Print the document"

    MODIFY = 0b000000001000
    "Modify the contents of the document"

    COPY = 0b000000010000
    "Copy or extract text and graphics from the document"

    ANNOTATION = 0b000000100000
    "Add or modify text annotations"

    FILL_FORMS = 0b000100000000
    "Fill in existing interactive form fields"

    COPY_FOR_ACCESSIBILITY = 0b001000000000
    "Extract text and graphics in support of accessibility to users with disabilities"

    ASSEMBLE = 0b010000000000
    "Insert, rotate or delete pages and create bookmarks or thumbnail images"

    PRINT_HIGH_RES = 0b100000000000
    "Print document at the highest resolution"

    @classmethod
    def all(cls):
        "All flags enabled"
        result = 0
        for permission in list(AccessPermission):
            result = result | permission
        return result

    @classmethod
    def none(cls):
        "All flags disabled"
        return 0

Ancestors

• enum.IntFlag
• builtins.int
• enum.Flag
• enum.Enum

Class variables

var ANNOTATION

Add or modify text annotations

var ASSEMBLE

Insert, rotate or delete pages and create bookmarks or thumbnail images

var COPY

Copy or extract text and graphics from the document

var COPY_FOR_ACCESSIBILITY

Extract text and graphics in support of accessibility to users with disabilities

var FILL_FORMS

Fill in existing interactive form fields

var MODIFY

Modify the contents of the document

var PRINT_HIGH_RES

Print document at the highest resolution

var PRINT_LOW_RES

Print the document

Static methods

def all()

All flags enabled

Expand source code

@classmethod
def all(cls):
    "All flags enabled"
    result = 0
    for permission in list(AccessPermission):
        result = result | permission
    return result

def none()

All flags disabled

Expand source code

@classmethod
def none(cls):
    "All flags disabled"
    return 0

class Align (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines how to render text in a cell

Expand source code

class Align(CoerciveEnum):
    "Defines how to render text in a cell"

    C = intern("CENTER")
    "Center text horizontally"

    X = intern("X_CENTER")
    "Center text horizontally around current x position"

    L = intern("LEFT")
    "Left-align text"

    R = intern("RIGHT")
    "Right-align text"

    J = intern("JUSTIFY")
    "Justify text"

    @classmethod
    def coerce(cls, value):
        if value == "":
            return cls.L
        return super(cls, cls).coerce(value)

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var C

Center text horizontally

var J

Justify text

var L

Left-align text

var R

Right-align text

var X

Center text horizontally around current x position

Inherited members

• CoerciveEnum:
  • coerce

class AnnotationFlag (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class AnnotationFlag(CoerciveIntEnum):
    INVISIBLE = 1
    """
    If set, do not display the annotation if it does not belong to one of the
    standard annotation types and no annotation handler is available.
    """
    HIDDEN = 2
    "If set, do not display or print the annotation or allow it to interact with the user"
    PRINT = 4
    "If set, print the annotation when the page is printed."
    NO_ZOOM = 8
    "If set, do not scale the annotation’s appearance to match the magnification of the page."
    NO_ROTATE = 16
    "If set, do not rotate the annotation’s appearance to match the rotation of the page."
    NO_VIEW = 32
    "If set, do not display the annotation on the screen or allow it to interact with the user"
    READ_ONLY = 64
    """
    If set, do not allow the annotation to interact with the user.
    The annotation may be displayed or printed but should not respond to mouse clicks.
    """
    LOCKED = 128
    """
    If set, do not allow the annotation to be deleted or its properties
    (including position and size) to be modified by the user.
    """
    TOGGLE_NO_VIEW = 256
    "If set, invert the interpretation of the NoView flag for certain events."
    LOCKED_CONTENTS = 512
    "If set, do not allow the contents of the annotation to be modified by the user."

Ancestors

• CoerciveIntEnum
• enum.IntEnum
• builtins.int
• enum.Enum

Class variables

var HIDDEN

If set, do not display or print the annotation or allow it to interact with the user

var INVISIBLE

If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available.

var LOCKED

If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user.

var LOCKED_CONTENTS

If set, do not allow the contents of the annotation to be modified by the user.

var NO_ROTATE

If set, do not rotate the annotation’s appearance to match the rotation of the page.

var NO_VIEW

If set, do not display the annotation on the screen or allow it to interact with the user

var NO_ZOOM

If set, do not scale the annotation’s appearance to match the magnification of the page.

var PRINT

If set, print the annotation when the page is printed.

var READ_ONLY

If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed but should not respond to mouse clicks.

var TOGGLE_NO_VIEW

If set, invert the interpretation of the NoView flag for certain events.

Inherited members

• CoerciveIntEnum:
  • coerce

class AnnotationName (value, names=None, *, module=None, qualname=None, type=None, start=1)

The name of an icon that shall be used in displaying the annotation

Expand source code

class AnnotationName(CoerciveEnum):
    "The name of an icon that shall be used in displaying the annotation"

    NOTE = Name("Note")
    COMMENT = Name("Comment")
    HELP = Name("Help")
    PARAGRAPH = Name("Paragraph")
    NEW_PARAGRAPH = Name("NewParagraph")
    INSERT = Name("Insert")

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var COMMENT

var HELP

var INSERT

var NEW_PARAGRAPH

var NOTE

var PARAGRAPH

Inherited members

• CoerciveEnum:
  • coerce

class BlendMode (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of the named standard named blend functions supported by PDF.

Expand source code

class BlendMode(CoerciveEnum):
    "An enumeration of the named standard named blend functions supported by PDF."

    NORMAL = Name("Normal")
    '''"Selects the source color, ignoring the backdrop."'''
    MULTIPLY = Name("Multiply")
    '''"Multiplies the backdrop and source color values."'''
    SCREEN = Name("Screen")
    """
    "Multiplies the complements of the backdrop and source color values, then
    complements the result."
    """
    OVERLAY = Name("Overlay")
    """
    "Multiplies or screens the colors, depending on the backdrop color value. Source
    colors overlay the backdrop while preserving its highlights and shadows. The
    backdrop color is not replaced but is mixed with the source color to reflect the
    lightness or darkness of the backdrop."
    """
    DARKEN = Name("Darken")
    '''"Selects the darker of the backdrop and source colors."'''
    LIGHTEN = Name("Lighten")
    '''"Selects the lighter of the backdrop and source colors."'''
    COLOR_DODGE = Name("ColorDodge")
    """
    "Brightens the backdrop color to reflect the source color. Painting with black
     produces no changes."
    """
    COLOR_BURN = Name("ColorBurn")
    """
    "Darkens the backdrop color to reflect the source color. Painting with white
     produces no change."
    """
    HARD_LIGHT = Name("HardLight")
    """
    "Multiplies or screens the colors, depending on the source color value. The effect
    is similar to shining a harsh spotlight on the backdrop."
    """
    SOFT_LIGHT = Name("SoftLight")
    """
    "Darkens or lightens the colors, depending on the source color value. The effect is
    similar to shining a diffused spotlight on the backdrop."
    """
    DIFFERENCE = Name("Difference")
    '''"Subtracts the darker of the two constituent colors from the lighter color."'''
    EXCLUSION = Name("Exclusion")
    """
    "Produces an effect similar to that of the Difference mode but lower in contrast.
    Painting with white inverts the backdrop color; painting with black produces no
    change."
    """
    HUE = Name("Hue")
    """
    "Creates a color with the hue of the source color and the saturation and luminosity
    of the backdrop color."
    """
    SATURATION = Name("Saturation")
    """
    "Creates a color with the saturation of the source color and the hue and luminosity
    of the backdrop color. Painting with this mode in an area of the backdrop that is
    a pure gray (no saturation) produces no change."
    """
    COLOR = Name("Color")
    """
    "Creates a color with the hue and saturation of the source color and the luminosity
    of the backdrop color. This preserves the gray levels of the backdrop and is
    useful for coloring monochrome images or tinting color images."
    """
    LUMINOSITY = Name("Luminosity")
    """
    "Creates a color with the luminosity of the source color and the hue and saturation
    of the backdrop color. This produces an inverse effect to that of the Color mode."
    """

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var COLOR

"Creates a color with the hue and saturation of the source color and the luminosity of the backdrop color. This preserves the gray levels of the backdrop and is useful for coloring monochrome images or tinting color images."

var COLOR_BURN

"Darkens the backdrop color to reflect the source color. Painting with white produces no change."

var COLOR_DODGE

"Brightens the backdrop color to reflect the source color. Painting with black produces no changes."

var DARKEN

"Selects the darker of the backdrop and source colors."

var DIFFERENCE

"Subtracts the darker of the two constituent colors from the lighter color."

var EXCLUSION

"Produces an effect similar to that of the Difference mode but lower in contrast. Painting with white inverts the backdrop color; painting with black produces no change."

var HARD_LIGHT

"Multiplies or screens the colors, depending on the source color value. The effect is similar to shining a harsh spotlight on the backdrop."

var HUE

"Creates a color with the hue of the source color and the saturation and luminosity of the backdrop color."

var LIGHTEN

"Selects the lighter of the backdrop and source colors."

var LUMINOSITY

"Creates a color with the luminosity of the source color and the hue and saturation of the backdrop color. This produces an inverse effect to that of the Color mode."

var MULTIPLY

"Multiplies the backdrop and source color values."

var NORMAL

"Selects the source color, ignoring the backdrop."

var OVERLAY

"Multiplies or screens the colors, depending on the backdrop color value. Source colors overlay the backdrop while preserving its highlights and shadows. The backdrop color is not replaced but is mixed with the source color to reflect the lightness or darkness of the backdrop."

var SATURATION

"Creates a color with the saturation of the source color and the hue and luminosity of the backdrop color. Painting with this mode in an area of the backdrop that is a pure gray (no saturation) produces no change."

var SCREEN

"Multiplies the complements of the backdrop and source color values, then complements the result."

var SOFT_LIGHT

"Darkens or lightens the colors, depending on the source color value. The effect is similar to shining a diffused spotlight on the backdrop."

Inherited members

• CoerciveEnum:
  • coerce

class CharVPos (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines the vertical position of text relative to the line.

Expand source code

class CharVPos(CoerciveEnum):
    "Defines the vertical position of text relative to the line."
    SUP = intern("SUP")
    "Superscript"

    SUB = intern("SUB")
    "Subscript"

    NOM = intern("NOM")
    "Nominator of a fraction"

    DENOM = intern("DENOM")
    "Denominator of a fraction"

    LINE = intern("LINE")
    "Default line position"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var DENOM

Denominator of a fraction

var LINE

Default line position

var NOM

Nominator of a fraction

var SUB

Subscript

var SUP

Superscript

Inherited members

• CoerciveEnum:
  • coerce

class ClippingPathIntersectionRule (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of the PDF drawing directives that define a path as a clipping path.

Expand source code

class ClippingPathIntersectionRule(CoerciveEnum):
    "An enumeration of the PDF drawing directives that define a path as a clipping path."

    NONZERO = "W"
    """
    "The nonzero winding number rule determines whether a given point is inside a path
    by conceptually drawing a ray from that point to infinity in any direction and
    then examining the places where a segment of the path crosses the ray. Starting
    with a count of 0, the rule adds 1 each time a path segment crosses the ray from
    left to right and subtracts 1 each time a segment crosses from right to left.
    After counting all the crossings, if the result is 0, the point is outside the
    path; otherwise, it is inside."
    """
    EVENODD = "W*"
    """
    "An alternative to the nonzero winding number rule is the even-odd rule. This rule
    determines whether a point is inside a path by drawing a ray from that point in
    any direction and simply counting the number of path segments that cross the ray,
    regardless of direction. If this number is odd, the point is inside; if even, the
    point is outside. This yields the same results as the nonzero winding number rule
    for paths with simple shapes, but produces different results for more complex
    shapes."""

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var EVENODD

"An alternative to the nonzero winding number rule is the even-odd rule. This rule determines whether a point is inside a path by drawing a ray from that point in any direction and simply counting the number of path segments that cross the ray, regardless of direction. If this number is odd, the point is inside; if even, the point is outside. This yields the same results as the nonzero winding number rule for paths with simple shapes, but produces different results for more complex shapes.

var NONZERO

"The nonzero winding number rule determines whether a given point is inside a path by conceptually drawing a ray from that point to infinity in any direction and then examining the places where a segment of the path crosses the ray. Starting with a count of 0, the rule adds 1 each time a path segment crosses the ray from left to right and subtracts 1 each time a segment crosses from right to left. After counting all the crossings, if the result is 0, the point is outside the path; otherwise, it is inside."

Inherited members

• CoerciveEnum:
  • coerce

class CoerciveEnum (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration that provides a helper to coerce strings into enumeration members.

Expand source code

class CoerciveEnum(Enum):
    "An enumeration that provides a helper to coerce strings into enumeration members."

    @classmethod
    def coerce(cls, value):
        """
        Attempt to coerce `value` into a member of this enumeration.

        If value is already a member of this enumeration it is returned unchanged.
        Otherwise, if it is a string, attempt to convert it as an enumeration value. If
        that fails, attempt to convert it (case insensitively, by upcasing) as an
        enumeration name.

        If all different conversion attempts fail, an exception is raised.

        Args:
            value (Enum, str): the value to be coerced.

        Raises:
            ValueError: if `value` is a string but neither a member by name nor value.
            TypeError: if `value`'s type is neither a member of the enumeration nor a
                string.
        """

        if isinstance(value, cls):
            return value

        if isinstance(value, str):
            try:
                return cls(value)
            except ValueError:
                pass
            try:
                return cls[value.upper()]
            except KeyError:
                pass

            raise ValueError(f"{value} is not a valid {cls.__name__}")

        raise TypeError(f"{value} cannot convert to a {cls.__name__}")

Ancestors

• enum.Enum

Subclasses

• Align
• AnnotationName
• BlendMode
• CharVPos
• ClippingPathIntersectionRule
• Corner
• FileAttachmentAnnotationName
• IntersectionRule
• PageLayout
• PageMode
• PathPaintRule
• RenderStyle
• TextMarkupType
• WrapMode
• XPos
• YPos

Static methods

def coerce(value)

Attempt to coerce value into a member of this enumeration.

If value is already a member of this enumeration it is returned unchanged. Otherwise, if it is a string, attempt to convert it as an enumeration value. If that fails, attempt to convert it (case insensitively, by upcasing) as an enumeration name.

If all different conversion attempts fail, an exception is raised.

Args

value : Enum, str

the value to be coerced.

Raises

ValueError

if value is a string but neither a member by name nor value.

TypeError

if value's type is neither a member of the enumeration nor a string.

Expand source code

@classmethod
def coerce(cls, value):
    """
    Attempt to coerce `value` into a member of this enumeration.

    If value is already a member of this enumeration it is returned unchanged.
    Otherwise, if it is a string, attempt to convert it as an enumeration value. If
    that fails, attempt to convert it (case insensitively, by upcasing) as an
    enumeration name.

    If all different conversion attempts fail, an exception is raised.

    Args:
        value (Enum, str): the value to be coerced.

    Raises:
        ValueError: if `value` is a string but neither a member by name nor value.
        TypeError: if `value`'s type is neither a member of the enumeration nor a
            string.
    """

    if isinstance(value, cls):
        return value

    if isinstance(value, str):
        try:
            return cls(value)
        except ValueError:
            pass
        try:
            return cls[value.upper()]
        except KeyError:
            pass

        raise ValueError(f"{value} is not a valid {cls.__name__}")

    raise TypeError(f"{value} cannot convert to a {cls.__name__}")

class CoerciveIntEnum (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration that provides a helper to coerce strings and integers into enumeration members.

Expand source code

class CoerciveIntEnum(IntEnum):
    """
    An enumeration that provides a helper to coerce strings and integers into
    enumeration members.
    """

    @classmethod
    def coerce(cls, value):
        """
        Attempt to coerce `value` into a member of this enumeration.

        If value is already a member of this enumeration it is returned unchanged.
        Otherwise, if it is a string, attempt to convert it (case insensitively, by
        upcasing) as an enumeration name. Otherwise, if it is an int, attempt to
        convert it as an enumeration value.

        Otherwise, an exception is raised.

        Args:
            value (IntEnum, str, int): the value to be coerced.

        Raises:
            ValueError: if `value` is an int but not a member of this enumeration.
            ValueError: if `value` is a string but not a member by name.
            TypeError: if `value`'s type is neither a member of the enumeration nor an
                int or a string.
        """
        if isinstance(value, cls):
            return value

        if isinstance(value, str):
            try:
                return cls[value.upper()]
            except KeyError:
                raise ValueError(f"{value} is not a valid {cls.__name__}") from None

        if isinstance(value, int):
            return cls(value)

        raise TypeError(f"{value} cannot convert to a {cls.__name__}")

Ancestors

• enum.IntEnum
• builtins.int
• enum.Enum

Subclasses

• AnnotationFlag
• StrokeCapStyle
• StrokeJoinStyle
• TextMode

Static methods

def coerce(value)

Attempt to coerce value into a member of this enumeration.

If value is already a member of this enumeration it is returned unchanged. Otherwise, if it is a string, attempt to convert it (case insensitively, by upcasing) as an enumeration name. Otherwise, if it is an int, attempt to convert it as an enumeration value.

Otherwise, an exception is raised.

Args

value : IntEnum, str, int

the value to be coerced.

Raises

ValueError

if value is an int but not a member of this enumeration.

ValueError

if value is a string but not a member by name.

TypeError

if value's type is neither a member of the enumeration nor an int or a string.

Expand source code

@classmethod
def coerce(cls, value):
    """
    Attempt to coerce `value` into a member of this enumeration.

    If value is already a member of this enumeration it is returned unchanged.
    Otherwise, if it is a string, attempt to convert it (case insensitively, by
    upcasing) as an enumeration name. Otherwise, if it is an int, attempt to
    convert it as an enumeration value.

    Otherwise, an exception is raised.

    Args:
        value (IntEnum, str, int): the value to be coerced.

    Raises:
        ValueError: if `value` is an int but not a member of this enumeration.
        ValueError: if `value` is a string but not a member by name.
        TypeError: if `value`'s type is neither a member of the enumeration nor an
            int or a string.
    """
    if isinstance(value, cls):
        return value

    if isinstance(value, str):
        try:
            return cls[value.upper()]
        except KeyError:
            raise ValueError(f"{value} is not a valid {cls.__name__}") from None

    if isinstance(value, int):
        return cls(value)

    raise TypeError(f"{value} cannot convert to a {cls.__name__}")

class CoerciveIntFlag (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumerated constants that can be combined using the bitwise operators, with a helper to coerce strings and integers into enumeration members.

Expand source code

class CoerciveIntFlag(IntFlag):
    """
    Enumerated constants that can be combined using the bitwise operators,
    with a helper to coerce strings and integers into enumeration members.
    """

    @classmethod
    def coerce(cls, value):
        """
        Attempt to coerce `value` into a member of this enumeration.
        If value is already a member of this enumeration it is returned unchanged.
        Otherwise, if it is a string, attempt to convert it (case insensitively, by
        upcasing) as an enumeration name. Otherwise, if it is an int, attempt to
        convert it as an enumeration value.
        Otherwise, an exception is raised.
        Args:
            value (IntEnum, str, int): the value to be coerced.
        Raises:
            ValueError: if `value` is an int but not a member of this enumeration.
            ValueError: if `value` is a string but not a member by name.
            TypeError: if `value`'s type is neither a member of the enumeration nor an
                int or a string.
        """
        if isinstance(value, cls):
            return value

        if isinstance(value, str):
            try:
                flags = cls[value[0].upper()]
                for char in value[1:]:
                    flags = flags | cls[char.upper()]
                return flags
            except KeyError:
                raise ValueError(f"{value} is not a valid {cls.__name__}") from None

        if isinstance(value, int):
            return cls(value)

        raise TypeError(f"{value} cannot convert to a {cls.__name__}")

Ancestors

• enum.IntFlag
• builtins.int
• enum.Flag
• enum.Enum

Subclasses

• TextEmphasis

Static methods

def coerce(value)

Attempt to coerce value into a member of this enumeration. If value is already a member of this enumeration it is returned unchanged. Otherwise, if it is a string, attempt to convert it (case insensitively, by upcasing) as an enumeration name. Otherwise, if it is an int, attempt to convert it as an enumeration value. Otherwise, an exception is raised.

Args

value : IntEnum, str, int

the value to be coerced.

Raises

ValueError

if value is an int but not a member of this enumeration.

ValueError

if value is a string but not a member by name.

TypeError

if value's type is neither a member of the enumeration nor an int or a string.

Expand source code

@classmethod
def coerce(cls, value):
    """
    Attempt to coerce `value` into a member of this enumeration.
    If value is already a member of this enumeration it is returned unchanged.
    Otherwise, if it is a string, attempt to convert it (case insensitively, by
    upcasing) as an enumeration name. Otherwise, if it is an int, attempt to
    convert it as an enumeration value.
    Otherwise, an exception is raised.
    Args:
        value (IntEnum, str, int): the value to be coerced.
    Raises:
        ValueError: if `value` is an int but not a member of this enumeration.
        ValueError: if `value` is a string but not a member by name.
        TypeError: if `value`'s type is neither a member of the enumeration nor an
            int or a string.
    """
    if isinstance(value, cls):
        return value

    if isinstance(value, str):
        try:
            flags = cls[value[0].upper()]
            for char in value[1:]:
                flags = flags | cls[char.upper()]
            return flags
        except KeyError:
            raise ValueError(f"{value} is not a valid {cls.__name__}") from None

    if isinstance(value, int):
        return cls(value)

    raise TypeError(f"{value} cannot convert to a {cls.__name__}")

class Corner (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class Corner(CoerciveEnum):
    TOP_RIGHT = "TOP_RIGHT"
    TOP_LEFT = "TOP_LEFT"
    BOTTOM_RIGHT = "BOTTOM_RIGHT"
    BOTTOM_LEFT = "BOTTOM_LEFT"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var BOTTOM_LEFT

var BOTTOM_RIGHT

var TOP_LEFT

var TOP_RIGHT

Inherited members

• CoerciveEnum:
  • coerce

class EncryptionMethod (value, names=None, *, module=None, qualname=None, type=None, start=1)

Algorithm to be used to encrypt the document

Expand source code

class EncryptionMethod(Enum):
    "Algorithm to be used to encrypt the document"

    NO_ENCRYPTION = 0
    RC4 = 1
    AES_128 = 2

Ancestors

• enum.Enum

Class variables

var AES_128

var NO_ENCRYPTION

var RC4

class FileAttachmentAnnotationName (value, names=None, *, module=None, qualname=None, type=None, start=1)

The name of an icon that shall be used in displaying the annotation

Expand source code

class FileAttachmentAnnotationName(CoerciveEnum):
    "The name of an icon that shall be used in displaying the annotation"

    PUSH_PIN = Name("PushPin")
    GRAPH_PUSH_PIN = Name("GraphPushPin")
    PAPERCLIP_TAG = Name("PaperclipTag")

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var GRAPH_PUSH_PIN

var PAPERCLIP_TAG

var PUSH_PIN

Inherited members

• CoerciveEnum:
  • coerce

class FontDescriptorFlags (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of the flags for the unsigned 32-bit integer entry in the font descriptor specifying various characteristics of the font. Bit positions are numbered from 1 (low-order) to 32 (high-order).

Expand source code

class FontDescriptorFlags(Flag):
    """An enumeration of the flags for the unsigned 32-bit integer entry in the font descriptor specifying various
    characteristics of the font. Bit positions are numbered from 1 (low-order) to 32 (high-order).
    """

    FIXED_PITCH = 0x0000001
    """
    "All glyphs have the same width (as opposed to proportional or
    variable-pitch fonts, which have different widths."
    """

    SYMBOLIC = 0x0000004
    """
    "Font contains glyphs outside the Adobe standard Latin character set.
    This flag and the Nonsymbolic flag shall not both be set or both be clear."
    """

    ITALIC = 0x0000040
    """
    "Glyphs have dominant vertical strokes that are slanted."
    """

    FORCE_BOLD = 0x0040000
    """
    "The flag shall determine whether bold glyphs shall be painted with extra pixels even at very
    small text sizes by a conforming reader. If set, features of bold glyphs may be thickened at
    small text sizes."
    """

Ancestors

• enum.Flag
• enum.Enum

Class variables

var FIXED_PITCH

"All glyphs have the same width (as opposed to proportional or variable-pitch fonts, which have different widths."

var FORCE_BOLD

"The flag shall determine whether bold glyphs shall be painted with extra pixels even at very small text sizes by a conforming reader. If set, features of bold glyphs may be thickened at small text sizes."

var ITALIC

"Glyphs have dominant vertical strokes that are slanted."

var SYMBOLIC

"Font contains glyphs outside the Adobe standard Latin character set. This flag and the Nonsymbolic flag shall not both be set or both be clear."

class IntersectionRule (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration representing the two possible PDF intersection rules.

The intersection rule is used by the renderer to determine which points are considered to be inside the path and which points are outside the path. This primarily affects fill rendering and clipping paths.

Expand source code

class IntersectionRule(CoerciveEnum):
    """
    An enumeration representing the two possible PDF intersection rules.

    The intersection rule is used by the renderer to determine which points are
    considered to be inside the path and which points are outside the path. This
    primarily affects fill rendering and clipping paths.
    """

    NONZERO = "nonzero"
    """
    "The nonzero winding number rule determines whether a given point is inside a path
    by conceptually drawing a ray from that point to infinity in any direction and
    then examining the places where a segment of the path crosses the ray. Starting
    with a count of 0, the rule adds 1 each time a path segment crosses the ray from
    left to right and subtracts 1 each time a segment crosses from right to left.
    After counting all the crossings, if the result is 0, the point is outside the
    path; otherwise, it is inside."
    """
    EVENODD = "evenodd"
    """
    "An alternative to the nonzero winding number rule is the even-odd rule. This rule
    determines whether a point is inside a path by drawing a ray from that point in
    any direction and simply counting the number of path segments that cross the ray,
    regardless of direction. If this number is odd, the point is inside; if even, the
    point is outside. This yields the same results as the nonzero winding number rule
    for paths with simple shapes, but produces different results for more complex
    shapes."
    """

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var EVENODD

"An alternative to the nonzero winding number rule is the even-odd rule. This rule determines whether a point is inside a path by drawing a ray from that point in any direction and simply counting the number of path segments that cross the ray, regardless of direction. If this number is odd, the point is inside; if even, the point is outside. This yields the same results as the nonzero winding number rule for paths with simple shapes, but produces different results for more complex shapes."

var NONZERO

"The nonzero winding number rule determines whether a given point is inside a path by conceptually drawing a ray from that point to infinity in any direction and then examining the places where a segment of the path crosses the ray. Starting with a count of 0, the rule adds 1 each time a path segment crosses the ray from left to right and subtracts 1 each time a segment crosses from right to left. After counting all the crossings, if the result is 0, the point is outside the path; otherwise, it is inside."

Inherited members

• CoerciveEnum:
  • coerce

class PDFStyleKeys (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of the graphics state parameter dictionary keys.

Expand source code

class PDFStyleKeys(Enum):
    "An enumeration of the graphics state parameter dictionary keys."

    FILL_ALPHA = Name("ca")
    BLEND_MODE = Name("BM")  # shared between stroke and fill
    STROKE_ALPHA = Name("CA")
    STROKE_ADJUSTMENT = Name("SA")
    STROKE_WIDTH = Name("LW")
    STROKE_CAP_STYLE = Name("LC")
    STROKE_JOIN_STYLE = Name("LJ")
    STROKE_MITER_LIMIT = Name("ML")
    STROKE_DASH_PATTERN = Name("D")  # array of array, number, e.g. [[1 1] 0]

Ancestors

• enum.Enum

Class variables

var BLEND_MODE

var FILL_ALPHA

var STROKE_ADJUSTMENT

var STROKE_ALPHA

var STROKE_CAP_STYLE

var STROKE_DASH_PATTERN

var STROKE_JOIN_STYLE

var STROKE_MITER_LIMIT

var STROKE_WIDTH

class PageLayout (value, names=None, *, module=None, qualname=None, type=None, start=1)

Specify the page layout shall be used when the document is opened

Expand source code

class PageLayout(CoerciveEnum):
    "Specify the page layout shall be used when the document is opened"

    SINGLE_PAGE = Name("SinglePage")
    "Display one page at a time"

    ONE_COLUMN = Name("OneColumn")
    "Display the pages in one column"

    TWO_COLUMN_LEFT = Name("TwoColumnLeft")
    "Display the pages in two columns, with odd-numbered pages on the left"

    TWO_COLUMN_RIGHT = Name("TwoColumnRight")
    "Display the pages in two columns, with odd-numbered pages on the right"

    TWO_PAGE_LEFT = Name("TwoPageLeft")
    "Display the pages two at a time, with odd-numbered pages on the left"

    TWO_PAGE_RIGHT = Name("TwoPageRight")
    "Display the pages two at a time, with odd-numbered pages on the right"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var ONE_COLUMN

Display the pages in one column

var SINGLE_PAGE

Display one page at a time

var TWO_COLUMN_LEFT

Display the pages in two columns, with odd-numbered pages on the left

var TWO_COLUMN_RIGHT

Display the pages in two columns, with odd-numbered pages on the right

var TWO_PAGE_LEFT

Display the pages two at a time, with odd-numbered pages on the left

var TWO_PAGE_RIGHT

Display the pages two at a time, with odd-numbered pages on the right

Inherited members

• CoerciveEnum:
  • coerce

class PageMode (value, names=None, *, module=None, qualname=None, type=None, start=1)

Specifying how to display the document on exiting full-screen mode

Expand source code

class PageMode(CoerciveEnum):
    "Specifying how to display the document on exiting full-screen mode"

    USE_NONE = Name("UseNone")
    "Neither document outline nor thumbnail images visible"

    USE_OUTLINES = Name("UseOutlines")
    "Document outline visible"

    USE_THUMBS = Name("UseThumbs")
    "Thumbnail images visible"

    FULL_SCREEN = Name("FullScreen")
    "Full-screen mode, with no menu bar, window controls, or any other window visible"

    USE_OC = Name("UseOC")
    "Optional content group panel visible"

    USE_ATTACHMENTS = Name("UseAttachments")
    "Attachments panel visible"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var FULL_SCREEN

Full-screen mode, with no menu bar, window controls, or any other window visible

var USE_ATTACHMENTS

Attachments panel visible

var USE_NONE

Neither document outline nor thumbnail images visible

var USE_OC

Optional content group panel visible

var USE_OUTLINES

Document outline visible

var USE_THUMBS

Thumbnail images visible

Inherited members

• CoerciveEnum:
  • coerce

class PathPaintRule (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of the PDF drawing directives that determine how the renderer should paint a given path.

Expand source code

class PathPaintRule(CoerciveEnum):
    """
    An enumeration of the PDF drawing directives that determine how the renderer should
    paint a given path.
    """

    # the auto-close paint rules are omitted here because it's easier to just emit
    # close operators when appropriate, programmatically
    STROKE = "S"
    '''"Stroke the path."'''

    FILL_NONZERO = "f"
    """
    "Fill the path, using the nonzero winding number rule to determine the region to
    fill. Any subpaths that are open are implicitly closed before being filled."
    """

    FILL_EVENODD = "f*"
    """
    "Fill the path, using the even-odd rule to determine the region to fill. Any
    subpaths that are open are implicitly closed before being filled."
    """

    STROKE_FILL_NONZERO = "B"
    """
    "Fill and then stroke the path, using the nonzero winding number rule to determine
    the region to fill. This operator produces the same result as constructing two
    identical path objects, painting the first with `FILL_NONZERO` and the second with
    `STROKE`."
    """

    STROKE_FILL_EVENODD = "B*"
    """
    "Fill and then stroke the path, using the even-odd rule to determine the region to
    fill. This operator produces the same result as `STROKE_FILL_NONZERO`, except that
    the path is filled as if with `FILL_EVENODD` instead of `FILL_NONZERO`."
    """

    DONT_PAINT = "n"
    """
    "End the path object without filling or stroking it. This operator is a
    path-painting no-op, used primarily for the side effect of changing the current
    clipping path."
    """

    AUTO = "auto"
    """
    Automatically determine which `PathPaintRule` should be used.

    PaintedPath will select one of the above `PathPaintRule`s based on the resolved
    set/inherited values of its style property.
    """

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var AUTO

Automatically determine which PathPaintRule should be used.

PaintedPath will select one of the above PathPaintRules based on the resolved set/inherited values of its style property.

var DONT_PAINT

"End the path object without filling or stroking it. This operator is a path-painting no-op, used primarily for the side effect of changing the current clipping path."

var FILL_EVENODD

"Fill the path, using the even-odd rule to determine the region to fill. Any subpaths that are open are implicitly closed before being filled."

var FILL_NONZERO

"Fill the path, using the nonzero winding number rule to determine the region to fill. Any subpaths that are open are implicitly closed before being filled."

var STROKE

"Stroke the path."

var STROKE_FILL_EVENODD

"Fill and then stroke the path, using the even-odd rule to determine the region to fill. This operator produces the same result as STROKE_FILL_NONZERO, except that the path is filled as if with FILL_EVENODD instead of FILL_NONZERO."

var STROKE_FILL_NONZERO

"Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill. This operator produces the same result as constructing two identical path objects, painting the first with FILL_NONZERO and the second with STROKE."

Inherited members

• CoerciveEnum:
  • coerce

class RenderStyle (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines how to render shapes

Expand source code

class RenderStyle(CoerciveEnum):
    "Defines how to render shapes"

    D = intern("DRAW")
    """
    Draw lines.
    Line color can be controlled with `fpdf.fpdf.FPDF.set_draw_color()`.
    Line thickness can be controlled with `fpdf.fpdf.FPDF.set_line_width()`.
    """

    F = intern("FILL")
    """
    Fill areas.
    Filling color can be controlled with `fpdf.fpdf.FPDF.set_fill_color()`.
    """

    DF = intern("DRAW_FILL")
    "Draw lines and fill areas"

    @property
    def operator(self):
        return {self.D: "S", self.F: "f", self.DF: "B"}[self]

    @property
    def is_draw(self):
        return self in (self.D, self.DF)

    @property
    def is_fill(self):
        return self in (self.F, self.DF)

    @classmethod
    def coerce(cls, value):
        if not value:
            return cls.D
        if value == "FD":
            value = "DF"
        return super(cls, cls).coerce(value)

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var D

Draw lines. Line color can be controlled with FPDF.set_draw_color(). Line thickness can be controlled with FPDF.set_line_width().

var DF

Draw lines and fill areas

var F

Fill areas. Filling color can be controlled with FPDF.set_fill_color().

Instance variables

var is_draw

Expand source code

@property
def is_draw(self):
    return self in (self.D, self.DF)

var is_fill

Expand source code

@property
def is_fill(self):
    return self in (self.F, self.DF)

var operator

Expand source code

@property
def operator(self):
    return {self.D: "S", self.F: "f", self.DF: "B"}[self]

Inherited members

• CoerciveEnum:
  • coerce

class SignatureFlag (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class SignatureFlag(IntEnum):
    SIGNATURES_EXIST = 1
    "If set, the document contains at least one signature field."
    APPEND_ONLY = 2
    """
    If set, the document contains signatures that may be invalidated
    if the file is saved (written) in a way that alters its previous contents,
    as opposed to an incremental update.
    """

Ancestors

• enum.IntEnum
• builtins.int
• enum.Enum

Class variables

var APPEND_ONLY

If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update.

var SIGNATURES_EXIST

If set, the document contains at least one signature field.

class StrokeCapStyle (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of values defining how the end of a stroke should be rendered.

This affects the ends of the segments of dashed strokes, as well.

Expand source code

class StrokeCapStyle(CoerciveIntEnum):
    """
    An enumeration of values defining how the end of a stroke should be rendered.

    This affects the ends of the segments of dashed strokes, as well.
    """

    BUTT = 0
    """
    "The stroke is squared off at the endpoint of the path. There is no projection
    beyond the end of the path."
    """
    ROUND = 1
    """
    "A semicircular arc with a diameter equal to the line width is drawn around the
    endpoint and filled in."
    """
    SQUARE = 2
    """
    "The stroke continues beyond the endpoint of the path for a distance equal to half
    the line width and is squared off."
    """

Ancestors

• CoerciveIntEnum
• enum.IntEnum
• builtins.int
• enum.Enum

Class variables

var BUTT

"The stroke is squared off at the endpoint of the path. There is no projection beyond the end of the path."

var ROUND

"A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in."

var SQUARE

"The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off."

Inherited members

• CoerciveIntEnum:
  • coerce

class StrokeJoinStyle (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration of values defining how the corner joining two path components should be rendered.

Expand source code

class StrokeJoinStyle(CoerciveIntEnum):
    """
    An enumeration of values defining how the corner joining two path components should
    be rendered.
    """

    MITER = 0
    """
    "The outer edges of the strokes for the two segments are extended until they meet at
    an angle, as in a picture frame. If the segments meet at too sharp an angle
    (as defined by the miter limit parameter), a bevel join is used instead."
    """
    ROUND = 1
    """
    "An arc of a circle with a diameter equal to the line width is drawn around the
    point where the two segments meet, connecting the outer edges of the strokes for
    the two segments. This pieslice-shaped figure is filled in, pro- ducing a rounded
    corner."
    """
    BEVEL = 2
    """
    "The two segments are finished with butt caps and the resulting notch beyond the
    ends of the segments is filled with a triangle."
    """

Ancestors

• CoerciveIntEnum
• enum.IntEnum
• builtins.int
• enum.Enum

Class variables

var BEVEL

"The two segments are finished with butt caps and the resulting notch beyond the ends of the segments is filled with a triangle."

var MITER

"The outer edges of the strokes for the two segments are extended until they meet at an angle, as in a picture frame. If the segments meet at too sharp an angle (as defined by the miter limit parameter), a bevel join is used instead."

var ROUND

"An arc of a circle with a diameter equal to the line width is drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments. This pieslice-shaped figure is filled in, pro- ducing a rounded corner."

Inherited members

• CoerciveIntEnum:
  • coerce

class TextEmphasis (value, names=None, *, module=None, qualname=None, type=None, start=1)

Indicates use of bold / italics / underline. This enum values can be combined with & and | operators: style = B | I

Expand source code

class TextEmphasis(CoerciveIntFlag):
    """
    Indicates use of bold / italics / underline.
    This enum values can be combined with & and | operators:
        style = B | I
    """

    B = 1
    "Bold"

    I = 2
    "Italics"

    U = 4
    "Underline"

    @property
    def style(self):
        return "".join(
            name for name, value in self.__class__.__members__.items() if value & self
        )

    @classmethod
    def coerce(cls, value):
        if isinstance(value, str):
            if value == "":
                return 0
            if value.upper() == "BOLD":
                return cls.B
            if value.upper() == "ITALICS":
                return cls.I
            if value.upper() == "UNDERLINE":
                return cls.U
        return super(cls, cls).coerce(value)

Ancestors

• CoerciveIntFlag
• enum.IntFlag
• builtins.int
• enum.Flag
• enum.Enum

Class variables

var B

Bold

var I

Italics

var U

Underline

Instance variables

var style

Expand source code

@property
def style(self):
    return "".join(
        name for name, value in self.__class__.__members__.items() if value & self
    )

Inherited members

• CoerciveIntFlag:
  • coerce

class TextMarkupType (value, names=None, *, module=None, qualname=None, type=None, start=1)

Subtype of a text markup annotation

Expand source code

class TextMarkupType(CoerciveEnum):
    "Subtype of a text markup annotation"

    HIGHLIGHT = Name("Highlight")

    UNDERLINE = Name("Underline")

    SQUIGGLY = Name("Squiggly")

    STRIKE_OUT = Name("StrikeOut")

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var HIGHLIGHT

var SQUIGGLY

var STRIKE_OUT

var UNDERLINE

Inherited members

• CoerciveEnum:
  • coerce

class TextMode (value, names=None, *, module=None, qualname=None, type=None, start=1)

Values described in PDF spec section 'Text Rendering Mode'

Expand source code

class TextMode(CoerciveIntEnum):
    "Values described in PDF spec section 'Text Rendering Mode'"
    FILL = 0
    STROKE = 1
    FILL_STROKE = 2
    INVISIBLE = 3
    FILL_CLIP = 4
    STROKE_CLIP = 5
    FILL_STROKE_CLIP = 6
    CLIP = 7

Ancestors

• CoerciveIntEnum
• enum.IntEnum
• builtins.int
• enum.Enum

Class variables

var CLIP

var FILL

var FILL_CLIP

var FILL_STROKE

var FILL_STROKE_CLIP

var INVISIBLE

var STROKE

var STROKE_CLIP

Inherited members

• CoerciveIntEnum:
  • coerce

class WrapMode (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines how to break and wrap lines in multi-line text.

Expand source code

class WrapMode(CoerciveEnum):
    "Defines how to break and wrap lines in multi-line text."
    WORD = intern("WORD")
    "Wrap by word"

    CHAR = intern("CHAR")
    "Wrap by character"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var CHAR

Wrap by character

var WORD

Wrap by word

Inherited members

• CoerciveEnum:
  • coerce

class XPos (value, names=None, *, module=None, qualname=None, type=None, start=1)

Positional values in horizontal direction for use after printing text.

Expand source code

class XPos(CoerciveEnum):
    "Positional values in horizontal direction for use after printing text."

    LEFT = intern("LEFT")  # self.x
    "left end of the cell"

    RIGHT = intern("RIGHT")  # self.x + w
    "right end of the cell (default)"

    START = intern("START")
    "left start of actual text"

    END = intern("END")
    "right end of actual text"

    WCONT = intern("WCONT")
    "for write() to continue next (slightly left of END)"

    CENTER = intern("CENTER")
    "center of actual text"

    LMARGIN = intern("LMARGIN")  # self.l_margin
    "left page margin (start of printable area)"

    RMARGIN = intern("RMARGIN")  # self.w - self.r_margin
    "right page margin (end of printable area)"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var CENTER

center of actual text

var END

right end of actual text

var LEFT

left end of the cell

var LMARGIN

left page margin (start of printable area)

var RIGHT

right end of the cell (default)

var RMARGIN

right page margin (end of printable area)

var START

left start of actual text

var WCONT

for write() to continue next (slightly left of END)

Inherited members

• CoerciveEnum:
  • coerce

class YPos (value, names=None, *, module=None, qualname=None, type=None, start=1)

Positional values in vertical direction for use after printing text

Expand source code

class YPos(CoerciveEnum):
    "Positional values in vertical direction for use after printing text"

    TOP = intern("TOP")  # self.y
    "top of the first line (default)"

    LAST = intern("LAST")
    "top of the last line (same as TOP for single-line text)"

    NEXT = intern("NEXT")  # LAST + h
    "top of next line (bottom of current text)"

    TMARGIN = intern("TMARGIN")  # self.t_margin
    "top page margin (start of printable area)"

    BMARGIN = intern("BMARGIN")  # self.h - self.b_margin
    "bottom page margin (end of printable area)"

Ancestors

• CoerciveEnum
• enum.Enum

Class variables

var BMARGIN

bottom page margin (end of printable area)

var LAST

top of the last line (same as TOP for single-line text)

var NEXT

top of next line (bottom of current text)

var TMARGIN

top page margin (start of printable area)

var TOP

top of the first line (default)

Inherited members

• CoerciveEnum:
  • coerce