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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
# Main objects
```{eval-rst}
.. autoapiclass:: pikepdf.Pdf
:members:
```
```{eval-rst}
.. function:: pikepdf.open
Alias for :meth:`pikepdf.Pdf.open`.
```
```{eval-rst}
.. function:: pikepdf.new
Alias for :meth:`pikepdf.Pdf.new`.
```
## Access modes
```{eval-rst}
.. autoapiclass:: pikepdf.ObjectStreamMode
:members:
```
```{eval-rst}
.. autoapiclass:: pikepdf.StreamDecodeLevel
:members:
```
```{eval-rst}
.. autoapiclass:: pikepdf.Encryption
:members:
```
## Object construction
```{eval-rst}
.. autoapiclass:: pikepdf.Object
:members:
:special-members:
```
```{eval-rst}
.. autoapiclass:: pikepdf.Name
:members: random
:special-members: __new__
```
```{eval-rst}
.. autoapiclass:: pikepdf.NamePath
```
```{eval-rst}
.. autoapiclass:: pikepdf.String
:members: __new__
```
```{eval-rst}
.. autoapiclass:: pikepdf.Array
:members: __new__
```
```{eval-rst}
.. autoapiclass:: pikepdf.Dictionary
:members: __new__
```
```{eval-rst}
.. autoapiclass:: pikepdf.Stream
:members: __new__
```
```{eval-rst}
.. autoapiclass:: pikepdf.Operator
:members: __new__
```
## Common PDF data structures
```{eval-rst}
.. autoapiclass:: pikepdf.Matrix
:members:
:special-members: __init__, __matmul__, __array__
```
```{eval-rst}
.. autoapiclass:: pikepdf.Rectangle
:members:
:special-members: __init__, __and__
```
## Content stream elements
```{eval-rst}
.. autoapiclass:: pikepdf.ContentStreamInstruction
:members:
```
```{eval-rst}
.. autoapiclass:: pikepdf.ContentStreamInlineImage
:members:
```
## Internal objects
These objects are returned by other pikepdf objects. They are part of the API,
but not intended to be created explicitly.
```{eval-rst}
.. autoapiclass:: pikepdf._core.PageList
:members:
```
```{eval-rst}
.. autoapiclass:: pikepdf._core._ObjectList
:members:
```
```{eval-rst}
.. autoapiclass:: pikepdf.ObjectType
:members:
```
## Jobs
```{eval-rst}
.. autoapiclass:: pikepdf.Job
:members:
:special-members: __init__
```
|
