Skip to content

Commit 7c7c7e5

Browse files
FredHappyfaceFredHappyface
committed
split gimpiobase enums to separate class
1 parent b78fe74 commit 7c7c7e5

File tree

9 files changed

+377
-321
lines changed

9 files changed

+377
-321
lines changed

‎documentation/reference/gimpformats/GimpIOBase.md‎

Lines changed: 30 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@
55
> Auto-generated documentation for [gimpformats.GimpIOBase](../../../gimpformats/GimpIOBase.py) module.
66
77
- [Gimpiobase](#gimpiobase)
8-
- [ColorMode](#colormode)
9-
- [CompositeMode](#compositemode)
10-
- [CompositeSpace](#compositespace)
11-
- [CompressionMode](#compressionmode)
12-
- [GimpBlendMode](#gimpblendmode)
138
- [GimpIOBase](#gimpiobase)
149
- [GimpIOBase().__repr__](#gimpiobase()__repr__)
1510
- [GimpIOBase().__str__](#gimpiobase()__str__)
@@ -39,74 +34,11 @@
3934
- [GimpUserUnits().decode](#gimpuserunits()decode)
4035
- [GimpUserUnits().encode](#gimpuserunits()encode)
4136
- [GimpUserUnits().full_repr](#gimpuserunits()full_repr)
42-
- [ImageProperties](#imageproperties)
43-
- [TagColor](#tagcolor)
44-
- [Units](#units)
4537
- [camel_to_pascal_with_spaces](#camel_to_pascal_with_spaces)
4638

47-
## ColorMode
48-
49-
[Show source in GimpIOBase.py:26](../../../gimpformats/GimpIOBase.py#L26)
50-
51-
#### Signature
52-
53-
```python
54-
class ColorMode(Enum): ...
55-
```
56-
57-
58-
59-
## CompositeMode
60-
61-
[Show source in GimpIOBase.py:39](../../../gimpformats/GimpIOBase.py#L39)
62-
63-
#### Signature
64-
65-
```python
66-
class CompositeMode(Enum): ...
67-
```
68-
69-
70-
71-
## CompositeSpace
72-
73-
[Show source in GimpIOBase.py:46](../../../gimpformats/GimpIOBase.py#L46)
74-
75-
#### Signature
76-
77-
```python
78-
class CompositeSpace(Enum): ...
79-
```
80-
81-
82-
83-
## CompressionMode
84-
85-
[Show source in GimpIOBase.py:64](../../../gimpformats/GimpIOBase.py#L64)
86-
87-
#### Signature
88-
89-
```python
90-
class CompressionMode(Enum): ...
91-
```
92-
93-
94-
95-
## GimpBlendMode
96-
97-
[Show source in GimpIOBase.py:71](../../../gimpformats/GimpIOBase.py#L71)
98-
99-
#### Signature
100-
101-
```python
102-
class GimpBlendMode(Enum): ...
103-
```
104-
105-
106-
10739
## GimpIOBase
10840

109-
[Show source in GimpIOBase.py:180](../../../gimpformats/GimpIOBase.py#L180)
41+
[Show source in GimpIOBase.py:34](../../../gimpformats/GimpIOBase.py#L34)
11042

11143
#### Signature
11244

@@ -117,7 +49,7 @@ class GimpIOBase:
11749

11850
### GimpIOBase().__repr__
11951

120-
[Show source in GimpIOBase.py:712](../../../gimpformats/GimpIOBase.py#L712)
52+
[Show source in GimpIOBase.py:566](../../../gimpformats/GimpIOBase.py#L566)
12153

12254
Get a textual representation of this object.
12355

@@ -129,7 +61,7 @@ def __repr__(self) -> str: ...
12961

13062
### GimpIOBase().__str__
13163

132-
[Show source in GimpIOBase.py:708](../../../gimpformats/GimpIOBase.py#L708)
64+
[Show source in GimpIOBase.py:562](../../../gimpformats/GimpIOBase.py#L562)
13365

13466
Get a textual representation of this object.
13567

@@ -141,7 +73,7 @@ def __str__(self) -> str: ...
14173

14274
### GimpIOBase()._colormapDecode
14375

144-
[Show source in GimpIOBase.py:340](../../../gimpformats/GimpIOBase.py#L340)
76+
[Show source in GimpIOBase.py:194](../../../gimpformats/GimpIOBase.py#L194)
14577

14678
_colormapDecode_.
14779

@@ -159,7 +91,7 @@ def _colormapDecode(self, data: bytearray | IO, index: int = 0) -> None: ...
15991

16092
### GimpIOBase()._guidelinesDecode
16193

162-
[Show source in GimpIOBase.py:288](../../../gimpformats/GimpIOBase.py#L288)
94+
[Show source in GimpIOBase.py:142](../../../gimpformats/GimpIOBase.py#L142)
16395

16496
Decode guidelines.
16597

@@ -171,7 +103,7 @@ def _guidelinesDecode(self, data: bytearray) -> None: ...
171103

172104
### GimpIOBase()._itemPathDecode
173105

174-
[Show source in GimpIOBase.py:298](../../../gimpformats/GimpIOBase.py#L298)
106+
[Show source in GimpIOBase.py:152](../../../gimpformats/GimpIOBase.py#L152)
175107

176108
Decode item path.
177109

@@ -183,7 +115,7 @@ def _itemPathDecode(self, data: bytearray) -> None: ...
183115

184116
### GimpIOBase()._parasitesDecode
185117

186-
[Show source in GimpIOBase.py:271](../../../gimpformats/GimpIOBase.py#L271)
118+
[Show source in GimpIOBase.py:125](../../../gimpformats/GimpIOBase.py#L125)
187119

188120
Decode list of parasites.
189121

@@ -195,7 +127,7 @@ def _parasitesDecode(self, data: bytearray) -> int: ...
195127

196128
### GimpIOBase()._parasitesEncode
197129

198-
[Show source in GimpIOBase.py:281](../../../gimpformats/GimpIOBase.py#L281)
130+
[Show source in GimpIOBase.py:135](../../../gimpformats/GimpIOBase.py#L135)
199131

200132
Encode list of parasites.
201133

@@ -207,7 +139,7 @@ def _parasitesEncode(self) -> bytearray: ...
207139

208140
### GimpIOBase()._propertiesDecode
209141

210-
[Show source in GimpIOBase.py:686](../../../gimpformats/GimpIOBase.py#L686)
142+
[Show source in GimpIOBase.py:540](../../../gimpformats/GimpIOBase.py#L540)
211143

212144
Decode a list of properties.
213145

@@ -223,7 +155,7 @@ def _propertiesDecode(self, ioBuf: IO) -> int: ...
223155

224156
### GimpIOBase()._propertiesEncode
225157

226-
[Show source in GimpIOBase.py:699](../../../gimpformats/GimpIOBase.py#L699)
158+
[Show source in GimpIOBase.py:553](../../../gimpformats/GimpIOBase.py#L553)
227159

228160
Encode a list of properties.
229161

@@ -235,7 +167,7 @@ def _propertiesEncode(self) -> bytearray: ...
235167

236168
### GimpIOBase()._propertyDecode
237169

238-
[Show source in GimpIOBase.py:385](../../../gimpformats/GimpIOBase.py#L385)
170+
[Show source in GimpIOBase.py:239](../../../gimpformats/GimpIOBase.py#L239)
239171

240172
Decode a single property.
241173

@@ -252,7 +184,7 @@ def _propertyDecode(self, prop: int, data: bytearray) -> int: ...
252184

253185
### GimpIOBase()._propertyEncode
254186

255-
[Show source in GimpIOBase.py:496](../../../gimpformats/GimpIOBase.py#L496)
187+
[Show source in GimpIOBase.py:350](../../../gimpformats/GimpIOBase.py#L350)
256188

257189
Encode a single property.
258190

@@ -271,7 +203,7 @@ def _propertyEncode(self, prop: int) -> bytearray: ...
271203

272204
### GimpIOBase()._samplePointsDecode
273205

274-
[Show source in GimpIOBase.py:373](../../../gimpformats/GimpIOBase.py#L373)
206+
[Show source in GimpIOBase.py:227](../../../gimpformats/GimpIOBase.py#L227)
275207

276208
Decode a series of points.
277209

@@ -283,7 +215,7 @@ def _samplePointsDecode(self, data: bytearray) -> None: ...
283215

284216
### GimpIOBase()._userUnitsDecode
285217

286-
[Show source in GimpIOBase.py:367](../../../gimpformats/GimpIOBase.py#L367)
218+
[Show source in GimpIOBase.py:221](../../../gimpformats/GimpIOBase.py#L221)
287219

288220
Decode a set of user-defined measurement units.
289221

@@ -295,7 +227,7 @@ def _userUnitsDecode(self, data: bytearray) -> None: ...
295227

296228
### GimpIOBase()._vectorsDecode
297229

298-
[Show source in GimpIOBase.py:308](../../../gimpformats/GimpIOBase.py#L308)
230+
[Show source in GimpIOBase.py:162](../../../gimpformats/GimpIOBase.py#L162)
299231

300232
Decode vectors.
301233

@@ -307,7 +239,7 @@ def _vectorsDecode(self, data: bytearray) -> None: ...
307239

308240
### GimpIOBase().activeVector
309241

310-
[Show source in GimpIOBase.py:322](../../../gimpformats/GimpIOBase.py#L322)
242+
[Show source in GimpIOBase.py:176](../../../gimpformats/GimpIOBase.py#L176)
311243

312244
Get the vector that is currently active.
313245

@@ -324,7 +256,7 @@ def activeVector(self) -> GimpVector: ...
324256

325257
### GimpIOBase().doc
326258

327-
[Show source in GimpIOBase.py:249](../../../gimpformats/GimpIOBase.py#L249)
259+
[Show source in GimpIOBase.py:103](../../../gimpformats/GimpIOBase.py#L103)
328260

329261
#### Signature
330262

@@ -335,7 +267,7 @@ def doc(self) -> GimpIOBase: ...
335267

336268
### GimpIOBase().expanded
337269

338-
[Show source in GimpIOBase.py:327](../../../gimpformats/GimpIOBase.py#L327)
270+
[Show source in GimpIOBase.py:181](../../../gimpformats/GimpIOBase.py#L181)
339271

340272
Is the group layer expanded.
341273

@@ -348,7 +280,7 @@ def expanded(self) -> bool: ...
348280

349281
### GimpIOBase().expanded
350282

351-
[Show source in GimpIOBase.py:332](../../../gimpformats/GimpIOBase.py#L332)
283+
[Show source in GimpIOBase.py:186](../../../gimpformats/GimpIOBase.py#L186)
352284

353285
Is the group layer expanded.
354286

@@ -361,7 +293,7 @@ def expanded(self, expanded: bool) -> None: ...
361293

362294
### GimpIOBase().full_repr
363295

364-
[Show source in GimpIOBase.py:723](../../../gimpformats/GimpIOBase.py#L723)
296+
[Show source in GimpIOBase.py:577](../../../gimpformats/GimpIOBase.py#L577)
365297

366298
Get a textual representation of this object.
367299

@@ -373,7 +305,7 @@ def full_repr(self, indent: int = 0) -> str: ...
373305

374306
### GimpIOBase().pointerSize
375307

376-
[Show source in GimpIOBase.py:223](../../../gimpformats/GimpIOBase.py#L223)
308+
[Show source in GimpIOBase.py:77](../../../gimpformats/GimpIOBase.py#L77)
377309

378310
Determine the size of the "pointer" datatype based on the document version.
379311

@@ -390,7 +322,7 @@ def pointerSize(self) -> int: ...
390322

391323
### GimpIOBase().root
392324

393-
[Show source in GimpIOBase.py:256](../../../gimpformats/GimpIOBase.py#L256)
325+
[Show source in GimpIOBase.py:110](../../../gimpformats/GimpIOBase.py#L110)
394326

395327
Get the root of the file object tree (Which is the same as self.doc).
396328

@@ -403,7 +335,7 @@ def root(self) -> GimpIOBase: ...
403335

404336
### GimpIOBase().tattoo
405337

406-
[Show source in GimpIOBase.py:261](../../../gimpformats/GimpIOBase.py#L261)
338+
[Show source in GimpIOBase.py:115](../../../gimpformats/GimpIOBase.py#L115)
407339

408340
Gimp nomenclature for the item's unique id.
409341

@@ -416,7 +348,7 @@ def tattoo(self) -> Any | None: ...
416348

417349
### GimpIOBase().tattoo
418350

419-
[Show source in GimpIOBase.py:266](../../../gimpformats/GimpIOBase.py#L266)
351+
[Show source in GimpIOBase.py:120](../../../gimpformats/GimpIOBase.py#L120)
420352

421353
Gimp nomenclature for the item's unique id.
422354

@@ -431,7 +363,7 @@ def tattoo(self, tattoo: Any | None) -> None: ...
431363

432364
## GimpUserUnits
433365

434-
[Show source in GimpIOBase.py:800](../../../gimpformats/GimpIOBase.py#L800)
366+
[Show source in GimpIOBase.py:654](../../../gimpformats/GimpIOBase.py#L654)
435367

436368
User-defined measurement units.
437369

@@ -444,7 +376,7 @@ class GimpUserUnits:
444376

445377
### GimpUserUnits().__str__
446378

447-
[Show source in GimpIOBase.py:847](../../../gimpformats/GimpIOBase.py#L847)
379+
[Show source in GimpIOBase.py:701](../../../gimpformats/GimpIOBase.py#L701)
448380

449381
Get a textual representation of this object.
450382

@@ -456,7 +388,7 @@ def __str__(self) -> str: ...
456388

457389
### GimpUserUnits().decode
458390

459-
[Show source in GimpIOBase.py:812](../../../gimpformats/GimpIOBase.py#L812)
391+
[Show source in GimpIOBase.py:666](../../../gimpformats/GimpIOBase.py#L666)
460392

461393
Decode a byte buffer.
462394

@@ -479,7 +411,7 @@ def decode(self, data: bytearray, index: int = 0) -> int: ...
479411

480412
### GimpUserUnits().encode
481413

482-
[Show source in GimpIOBase.py:835](../../../gimpformats/GimpIOBase.py#L835)
414+
[Show source in GimpIOBase.py:689](../../../gimpformats/GimpIOBase.py#L689)
483415

484416
Convert this object to raw bytearray.
485417

@@ -491,7 +423,7 @@ def encode(self) -> bytearray: ...
491423

492424
### GimpUserUnits().full_repr
493425

494-
[Show source in GimpIOBase.py:851](../../../gimpformats/GimpIOBase.py#L851)
426+
[Show source in GimpIOBase.py:705](../../../gimpformats/GimpIOBase.py#L705)
495427

496428
Get a textual representation of this object.
497429

@@ -503,45 +435,9 @@ def full_repr(self, indent: int = 0) -> str: ...
503435

504436

505437

506-
## ImageProperties
507-
508-
[Show source in GimpIOBase.py:136](../../../gimpformats/GimpIOBase.py#L136)
509-
510-
#### Signature
511-
512-
```python
513-
class ImageProperties(Enum): ...
514-
```
515-
516-
517-
518-
## TagColor
519-
520-
[Show source in GimpIOBase.py:52](../../../gimpformats/GimpIOBase.py#L52)
521-
522-
#### Signature
523-
524-
```python
525-
class TagColor(Enum): ...
526-
```
527-
528-
529-
530-
## Units
531-
532-
[Show source in GimpIOBase.py:32](../../../gimpformats/GimpIOBase.py#L32)
533-
534-
#### Signature
535-
536-
```python
537-
class Units(Enum): ...
538-
```
539-
540-
541-
542438
## camel_to_pascal_with_spaces
543439

544-
[Show source in GimpIOBase.py:21](../../../gimpformats/GimpIOBase.py#L21)
440+
[Show source in GimpIOBase.py:29](../../../gimpformats/GimpIOBase.py#L29)
545441

546442
#### Signature
547443

0 commit comments

Comments
 (0)