FolderExport Enumeration Reference


                    
                    
                    content(info:counter:songDisplayOptions:chordDisplayOptions:progress:)

Convert ChordPro files to a PDF

Declaration

Swift

static func content(
    info: PDFBuild.DocumentInfo,
    counter: PDFBuild.PageCounter,
    songDisplayOptions: Song.DisplayOptions,
    chordDisplayOptions: ChordDefinition.DisplayOptions,
    progress: @escaping (Double) -> Void
) -> Data

Parameters

`info`	The document info for the PDF
`counter`	The `PDFBuild.PageCounter` class
`options`	The chord display options
`progress`	A closure to observe the progress of PDF creation

Return Value

The PDF as Data and the PageCounter class with TOC info

Show on GitHub


                    
                    
                    Status

The status of the export

Declaration

Swift

enum Status

Show on GitHub


                    
                    
                    export(info:songDisplayOptions:chordDisplayOptions:)

Export a folder with ChordPro songs

Declaration

Swift

static func export(
    info: PDFBuild.DocumentInfo,
    songDisplayOptions: Song.DisplayOptions,
    chordDisplayOptions: ChordDefinition.DisplayOptions
) -> AsyncThrowingStream<Status, Error>

Parameters

`info`	The document info for the PDF
`songDisplayOptions`	The song display options
`chordDisplayOptions`	The chord display options

Return Value

A stream with progress indication and a document when finished

Show on GitHub


                    
                    
                    export(info:songDisplayOptions:chordDisplayOptions:progress:)

Export a folder with ChordPro songs

Declaration

Swift

static func export(
    info: PDFBuild.DocumentInfo,
    songDisplayOptions: Song.DisplayOptions,
    chordDisplayOptions: ChordDefinition.DisplayOptions,
    progress: @escaping (Double) -> Void
) async throws -> Data?

Parameters

`info`	The document info for the PDF
`songDisplayOptions`	The song display options
`chordDisplayOptions`	The chord display options
`progress`	A closure to observe the progress of PDF creation

Return Value

A PDFDocument if all well, else an error

Show on GitHub


                    
                    
                    files()

Get all ChordPro songs from a specific folder

Declaration

Swift

static func files() throws -> [FileBrowser.SongItem]

Return Value

All found songs in a SongItem array

Show on GitHub


                    
                    
                    toc(info:counter:)

Create a Table of Contents

Declaration

Swift

static func toc(info: PDFBuild.DocumentInfo, counter: PDFBuild.PageCounter) -> Data

Parameters

`info`	The document info for the PDF
`tocItems`	The items for the TOC

Return Value

The Table of Contents as Data

Show on GitHub