WIP

techprimate · Apr 22, 2024 · 42d171e · 42d171e
1 parent 40d9e47
commit 42d171e
Show file tree

Hide file tree

Showing 96 changed files with 2,345 additions and 2,136 deletions.
diff --git a/Documentation/Usage.md b/Documentation/Usage.md
@@ -504,7 +504,7 @@ Also each cell can have a `margin` which is the distance between the cell frame
 document.add(table: table)
 ```
 
-## Multi-Column Sections
+### Multi-Column Sections
 
 A multi-column section is a nested container. You create the section with an amount of columns and their relative width, add objects to each column and then add the whole section to the document.
 

diff --git a/Shared/Examples/TableOfContentsExampleFactory.swift b/Shared/Examples/TableOfContentsExampleFactory.swift
@@ -7,27 +7,32 @@
 //
 
 #if os(iOS)
-import UIKit
+    import UIKit
 #elseif os(macOS)
-import AppKit
+    import AppKit
 #endif
 import TPPDF
 
 class TableOfContentsExampleFactory: ExampleFactory {
-
     func generateDocument() -> [PDFDocument] {
         let document = PDFDocument(format: .a4)
 
         // Define doccument wide styles
-        let titleStyle = document.add(style: PDFTextStyle(name: "Title",
-                                                          font: Font.boldSystemFont(ofSize: 50.0),
-                                                          color: Color(red: 0.171875, green: 0.2421875, blue: 0.3125, alpha: 1.0)))
-        let headingStyle1 = document.add(style: PDFTextStyle(name: "Heading 1",
-                                                             font: Font.systemFont(ofSize: 15),
-                                                             color: Color.black))
-        let headingStyle2 = document.add(style: PDFTextStyle(name: "Heading 2",
-                                                             font: Font.systemFont(ofSize: 10),
-                                                             color: Color.black))
+        let titleStyle = document.add(style: PDFTextStyle(
+            name: "Title",
+            font: Font.boldSystemFont(ofSize: 50.0),
+            color: Color(red: 0.171875, green: 0.2421875, blue: 0.3125, alpha: 1.0)
+        ))
+        let headingStyle1 = document.add(style: PDFTextStyle(
+            name: "Heading 1",
+            font: Font.systemFont(ofSize: 15),
+            color: Color.black
+        ))
+        let headingStyle2 = document.add(style: PDFTextStyle(
+            name: "Heading 2",
+            font: Font.systemFont(ofSize: 10),
+            color: Color.black
+        ))
 
         // Add a string using the title style
         document.add(.contentCenter, textObject: PDFSimpleText(text: "TPPDF", style: titleStyle))
@@ -69,7 +74,7 @@ class TableOfContentsExampleFactory: ExampleFactory {
         document.add(space: 10)
 
         document.add(text: LoremIpsum.get(words: 10))
-        
+
         return [document]
     }
 }
diff --git a/Source/API/Delegation/PDFGeneratorImageDelegate.swift b/Source/API/Delegation/PDFGeneratorImageDelegate.swift
@@ -7,12 +7,14 @@
 
 import CoreGraphics
 
+/// Protocol used to delegate drawing of images
 public protocol PDFGeneratorImageDelegate: AnyObject {
+    /**
+     * Called directly before a ``PDFImage`` is drawn into the graphics context
+     *
+     * As the `image` is a reference object, it is possible to read and manipulate the object before rendering.
+     *
+     * One use-case could be overlaying the ``PDFImage/image`` with a watermark, after it final frame is calculated.
+     */
     func generator(willBeginDrawingImage image: PDFImage, with context: PDFContext, in frame: CGRect)
 }
-
-public extension PDFGeneratorImageDelegate {
-
-    func generator(willBeginDrawingImage image: PDFImage, with context: PDFContext, in frame: CGRect) {}
-
-}