Module `fpdf.actions`

Classes

class Action (next_action: Action | None = None)

Expand source code Browse git

class Action(ABC):
    def __init__(self, next_action: Optional["Action"] = None) -> None:
        """
        Args:
            next (PDFObject | str): optional reference to another Action to trigger after this one
        """
        self.next = next_action

    def serialize(
        self,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        raise NotImplementedError

    def _serialize(
        self,
        key_values: Optional[dict[str, object]] = None,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        if key_values is None:
            key_values = {}
        if self.next:
            key_values["Next"] = self.next
        obj_dict = build_obj_dict(key_values, _security_handler, _obj_id)
        return create_dictionary_string(obj_dict, field_join=" ")

Helper class that provides a standard way to create an ABC using inheritance.

Args

next : PDFObject | str: optional reference to another Action to trigger after this one

Ancestors

abc.ABC

Methods

def serialize(self) ‑> str

Expand source code Browse git

def serialize(
    self,
    _security_handler: Optional["StandardSecurityHandler"] = None,
    _obj_id: Optional[int] = None,
) -> str:
    raise NotImplementedError

class GoToAction (dest: str | Destination, next_action: Action | None = None)

Expand source code Browse git

class GoToAction(Action):
    def __init__(
        self, dest: Union[str, "Destination"], next_action: Optional[Action] = None
    ) -> None:
        super().__init__(next_action)
        if isinstance(dest, str) and dest.startswith("#"):
            dest = PDFString(dest[1:], encrypt=True)
        self.dest = dest

    def serialize(
        self,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        return super()._serialize(
            {"s": "/GoTo", "d": self.dest},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )

Helper class that provides a standard way to create an ABC using inheritance.

Args

next : PDFObject | str: optional reference to another Action to trigger after this one

Ancestors

Action
abc.ABC

Methods

def serialize(self) ‑> str

Expand source code Browse git

def serialize(
    self,
    _security_handler: Optional["StandardSecurityHandler"] = None,
    _obj_id: Optional[int] = None,
) -> str:
    return super()._serialize(
        {"s": "/GoTo", "d": self.dest},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )

class GoToRemoteAction (file: str, dest: Destination, next_action: Action | None = None)

Expand source code Browse git

class GoToRemoteAction(Action):
    def __init__(
        self, file: str, dest: "Destination", next_action: Optional[Action] = None
    ) -> None:
        super().__init__(next_action)
        self.file = file
        self.dest = dest

    def serialize(
        self,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        return super()._serialize(
            {"s": "/GoToR", "f": PDFString(self.file, encrypt=True), "d": self.dest},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )

Helper class that provides a standard way to create an ABC using inheritance.

Args

next : PDFObject | str: optional reference to another Action to trigger after this one

Ancestors

Action
abc.ABC

Methods

def serialize(self) ‑> str

Expand source code Browse git

def serialize(
    self,
    _security_handler: Optional["StandardSecurityHandler"] = None,
    _obj_id: Optional[int] = None,
) -> str:
    return super()._serialize(
        {"s": "/GoToR", "f": PDFString(self.file, encrypt=True), "d": self.dest},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )

class LaunchAction (file: str, next_action: Action | None = None)

Expand source code Browse git

class LaunchAction(Action):
    "As of 2022, this does not seem honored by neither Adobe Acrobat nor Sumatra readers."

    def __init__(self, file: str, next_action: Optional[Action] = None) -> None:
        super().__init__(next_action)
        self.file = file

    def serialize(
        self,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        return super()._serialize(
            {"s": "/Launch", "f": PDFString(self.file, encrypt=True)},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )

As of 2022, this does not seem honored by neither Adobe Acrobat nor Sumatra readers.

Args

next : PDFObject | str: optional reference to another Action to trigger after this one

Ancestors

Action
abc.ABC

Methods

def serialize(self) ‑> str

Expand source code Browse git

def serialize(
    self,
    _security_handler: Optional["StandardSecurityHandler"] = None,
    _obj_id: Optional[int] = None,
) -> str:
    return super()._serialize(
        {"s": "/Launch", "f": PDFString(self.file, encrypt=True)},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )

class NamedAction (action_name: str, next_action: Action | None = None)

Expand source code Browse git

class NamedAction(Action):
    def __init__(self, action_name: str, next_action: Optional[Action] = None) -> None:
        super().__init__(next_action)
        if action_name not in ("NextPage", "PrevPage", "FirstPage", "LastPage"):
            warnings.warn("Non-standard named action added")
        self.action_name = action_name

    def serialize(
        self,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        return super()._serialize(
            {"s": "/Named", "n": f"/{self.action_name}"},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )

Helper class that provides a standard way to create an ABC using inheritance.

Args

next : PDFObject | str: optional reference to another Action to trigger after this one

Ancestors

Action
abc.ABC

Methods

def serialize(self) ‑> str

Expand source code Browse git

def serialize(
    self,
    _security_handler: Optional["StandardSecurityHandler"] = None,
    _obj_id: Optional[int] = None,
) -> str:
    return super()._serialize(
        {"s": "/Named", "n": f"/{self.action_name}"},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )

class URIAction (uri: str, next_action: Action | None = None)

Expand source code Browse git

class URIAction(Action):
    def __init__(self, uri: str, next_action: Optional[Action] = None) -> None:
        super().__init__(next_action)
        self.uri = uri

    def serialize(
        self,
        _security_handler: Optional["StandardSecurityHandler"] = None,
        _obj_id: Optional[int] = None,
    ) -> str:
        return super()._serialize(
            {"s": "/URI", "u_r_i": PDFString(self.uri, encrypt=True)},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )

Helper class that provides a standard way to create an ABC using inheritance.

Args

next : PDFObject | str: optional reference to another Action to trigger after this one

Ancestors

Action
abc.ABC

Methods

def serialize(self) ‑> str

Expand source code Browse git

def serialize(
    self,
    _security_handler: Optional["StandardSecurityHandler"] = None,
    _obj_id: Optional[int] = None,
) -> str:
    return super()._serialize(
        {"s": "/URI", "u_r_i": PDFString(self.uri, encrypt=True)},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )