SceneStateModel Class Reference

file
The optional file location
Declaration
Swift

var file: URL?
Show on GitHub
template
The optional template location
Declaration
Swift

var template: URL?
Show on GitHub
content
The raw content of the document
Declaration
Swift

var content: String = ""
Show on GitHub
song
The current Song
Declaration
Swift

var song: Song
Show on GitHub
preview
PDF preview related stuff
Declaration
Swift

var preview = PreviewState()
Show on GitHub
editorInternals
The internals of the Chord Provider editor
Declaration
Swift

var editorInternals = ChordProEditor.Internals()
Show on GitHub
settings
The settings for the scene
Declaration
Swift

var settings: AppSettings
Show on GitHub
status
The status of the View
Declaration
Swift

var status: Status = .loading
Show on GitHub
errorAlert
Show an Alert if we have an error
Declaration
Swift

var errorAlert: AlertMessage?
Show on GitHub

Song View options

showEditor
Bool to show the editor or not
Declaration
Swift

var showEditor: Bool = false
Show on GitHub
isAnimating
Bool that some animation is ongoing

Note
Used to hide the SongView during animation because of performance
Declaration
Swift

var isAnimating: Bool = false
Show on GitHub

Editor stuff

definition
All the values of a ChordDefinition

Note
Used for editing a chord
Declaration
Swift

var definition: ChordDefinition
Show on GitHub
cleanConfirmation
Bool to show the clean confirmation dialog
Declaration
Swift

var cleanConfirmation = false
Show on GitHub

Export Stuff


                    
                    
                    temporaryDirectoryURL

The temporary directory URL for processing files

Note

In its own directory so easier to debug

Declaration

Swift

let temporaryDirectoryURL = URL(fileURLWithPath: NSTemporaryDirectory(), isDirectory: true)
    .appendingPathComponent("ChordProviderTMP", isDirectory: true)

Show on GitHub

exportURL
The URL of the export PDF
Declaration
Swift

var exportURL: URL
Show on GitHub
exportSongToPDF()
Export the song to a PDF
Declaration
Swift

func exportSongToPDF() async throws -> Data
Show on GitHub
getMedia()
Get the optional media stored next to a song file
Declaration
Swift

func getMedia()
Show on GitHub

ChordPro CLI integration

sourceURL
The URL of the source file
Declaration
Swift

var sourceURL: URL
Show on GitHub
localSystemConfigURL
The optional local configuration (a config named chordpro.json next to a song)
Declaration
Swift

var localSystemConfigURL: URL?
Show on GitHub
localSongConfigURL
The optional local configuration (a config with the same base-name next to a song)
Declaration
Swift

var localSongConfigURL: URL?
Show on GitHub

Init

init(id:)
Init the class
Declaration
Swift

init(id: AppStateModel.AppStateID)
Show on GitHub

Chords Menu

chordsMenu
Chords menu
Declaration
Swift

var chordsMenu: some View
Show on GitHub
ChordsMenu
Chords menu
See more
Declaration
Swift

private struct ChordsMenu: View
Show on GitHub

Show Chords Button

showChordsButton
Show chords button
Declaration
Swift

var showChordsButton: some View
Show on GitHub
ShowChordsButton
Show chords button
See more
Declaration
Swift

private struct ShowChordsButton: View
Show on GitHub

Chords As Diagram Toggle

chordsAsDiagramToggle
Chords As Diagram Toggle
Declaration
Swift

var chordsAsDiagramToggle: some View
Show on GitHub
ChordsAsDiagramToggle
Chords As Diagram Toggle
See more
Declaration
Swift

private struct ChordsAsDiagramToggle: View
Show on GitHub

Song Paging Picker

songPagingPicker
Song Paging Picker
Declaration
Swift

var songPagingPicker: some View
Show on GitHub
SongPagingPicker
Song Paging Picker
See more
Declaration
Swift

private struct SongPagingPicker: View
Show on GitHub

Chords Position Picker

chordsPositionPicker
Chords Position Picker
Declaration
Swift

var chordsPositionPicker: some View
Show on GitHub
ChordsPositionPicker
Chords Position Picker
See more
Declaration
Swift

private struct ChordsPositionPicker: View
Show on GitHub

Root Picker

rootPicker(showAllOption:hideFlats:)
SwiftUI View with a Picker to select a Root value
Declaration
Swift

func rootPicker(showAllOption: Bool, hideFlats: Bool) -> some View
Show on GitHub
RootPicker
SwiftUI View with a Picker to select a Root value
See more
Declaration
Swift

struct RootPicker: View
Show on GitHub

Quality Picker

qualityPicker(showAll:)
SwiftUI View with a Picker to select a Quality value
Declaration
Swift

func qualityPicker(showAll: Bool = false) -> some View
Show on GitHub
QualityPicker
SwiftUI View with a Picker to select a Quality value
See more
Declaration
Swift

struct QualityPicker: View
Show on GitHub

Base Fret Picker

baseFretPicker
SwiftUI View with a Picker to select a baseFret value
Declaration
Swift

var baseFretPicker: some View
Show on GitHub
BaseFretPicker
SwiftUI View with a Picker to select a baseFret value
See more
Declaration
Swift

struct BaseFretPicker: View
Show on GitHub

Bass Picker

bassPicker
SwiftUI View with a Picker to select a Root value as bass note
Declaration
Swift

var bassPicker: some View
Show on GitHub
BassPicker
SwiftUI View with a Picker to select a Root value as bass note
See more
Declaration
Swift

struct BassPicker: View
Show on GitHub

Frets Picker

fretsPicker
SwiftUI View with a Picker to select fret values
Declaration
Swift

var fretsPicker: some View
Show on GitHub
FretsPicker
SwiftUI View with a Picker to select fret values
See more
Declaration
Swift

struct FretsPicker: View
Show on GitHub

Fingers Picker

fingersPicker
SwiftUI View with a Picker to select finger values
Declaration
Swift

var fingersPicker: some View
Show on GitHub
FingersPicker
SwiftUI View with a Picker to select finger values
See more
Declaration
Swift

struct FingersPicker: View
Show on GitHub

Scale Slider

scaleSlider
Scale Slider
Declaration
Swift

var scaleSlider: some View
Show on GitHub
ScaleSlider
Scale Slider
See more
Declaration
Swift

private struct ScaleSlider: View
Show on GitHub

Editor Button

showEditorButton
Show Editor Button
Declaration
Swift

var showEditorButton: some View
Show on GitHub
ShowEditorButton
Show Editor Button
See more
Declaration
Swift

private struct ShowEditorButton: View
Show on GitHub

Clean Source Button

cleanSourceButton
Clean Source Button
Declaration
Swift

var cleanSourceButton: some View
Show on GitHub
CleanSourceButton
Clean Source Button
See more
Declaration
Swift

private struct CleanSourceButton: View
Show on GitHub

Transpose Buttons

transposeUp
Transpose Up
Declaration
Swift

var transposeUp: some View
Show on GitHub
TransposeUp
Transpose Up
See more
Declaration
Swift

private struct TransposeUp: View
Show on GitHub
transposeDown
Transpose Down
Declaration
Swift

var transposeDown: some View
Show on GitHub
TransposeDown
Transpose Down
See more
Declaration
Swift

private struct TransposeDown: View
Show on GitHub

Transpose Menu

transposeMenu
Transpose Menu
Declaration
Swift

var transposeMenu: some View
Show on GitHub
TransposeMenu
Transpose Menu
See more
Declaration
Swift

private struct TransposeMenu: View
Show on GitHub

Instrument Picker

instrumentPicker
SwiftUI Picker to select a Instrument value
Declaration
Swift

var instrumentPicker: some View
Show on GitHub
InstrumentPicker
SwiftUI Picker to select a Instrument value
See more
Declaration
Swift

struct InstrumentPicker: View
Show on GitHub
Status
The status of a Scene View
See more
Declaration
Swift

enum Status
Show on GitHub