File: models.md

package info (click to toggle)
pikepdf 10.3.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 9,136 kB
  • sloc: python: 14,167; cpp: 5,287; makefile: 260; sh: 82
file content (107 lines) | stat: -rw-r--r-- 1,978 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# Support models

Support models are abstracts over "raw" objects within a Pdf. For example, a page
in a PDF is a Dictionary with set to `/Type` of `/Page`. The Dictionary in
that case is the "raw" object. Upon establishing what type of object it is, we
can wrap it with a support model that adds features to ensure consistency with
the PDF specification.

In version 2.x, did not apply support models to "raw" objects automatically.
Version 3.x automatically applies support models to `/Page` objects.

```{eval-rst}
.. autoapiclass:: pikepdf.ObjectHelper
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.Page
    :members:
    :inherited-members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.PdfImage
    :inherited-members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.PdfInlineImage
```

```{eval-rst}
.. autoapiclass:: pikepdf.models.PdfMetadata
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.models.Encryption
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.models.Outline
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.models.OutlineItem
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.Permissions
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.models.EncryptionMethod
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.models.EncryptionInfo
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.AcroForm
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.AcroFormField
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.Annotation
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf._core.Attachments
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.AttachedFileSpec
    :members:
    :inherited-members:
    :special-members: __init__
```

```{eval-rst}
.. autoapiclass:: pikepdf._core.AttachedFile
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.NameTree
    :members:
```

```{eval-rst}
.. autoapiclass:: pikepdf.NumberTree
    :members:
```