Add References and Set a License - macOS Swift App

This tutorial shows how to create a project, add references, and set the license in a Swift macOS App application using the LEADTOOLS SDK.

Overview  
Summary This tutorial covers how to set your LEADTOOLS license in a Swift macOS App application.
Completion Time 20 minutes
Project Download tutorial project (14 KB)
Platform Swift macOS App Application
IDE Xcode
Runtime License Download LEADTOOLS
Try it in another language

Required Knowledge

Before any functionality from the SDK can be leveraged, a valid runtime license will have to be set.

For instructions on how to obtain a runtime license refer to Obtaining a License.

Create the Project

Launch Xcode and select Create a new Xcode project.

Screenshot of the Xcode launch screen.

Next, select macOS at the top and App under the Application section, then click Next.

Screenshot of template selection screen.

In the next section, fill in the following and click Next:

Note

TheOrganization IdentifierandProduct Namecombine to make theBundle Identifier, which must be unique.

Screenshot of options screen.

Lastly, select the location to save the new project to and click Create.

Screenshot of project save location.

Add the LEADTOOLS Framework Packages

To leverage the LEADTOOLS SDK in a Swift macOS App project, references to the LEADTOOLS Framework files will be needed.

Framework files can be added by one of the following two methods:

The LEADTOOLS Frameworks can be found here: <INSTALL_DIR>/LEADTOOLS22/Bin/Xcode/Frameworks/macOS

Once a framework file is added, a new folder called Frameworks will be added to the Project Navigator, containing the added framework files.

Screenshot of the Frameworks and Libraries section.

To allow Xcode to utilize these Framework files, a few more steps are required.

If done correctly the entry should look something like this:

Next, find the entry called Objective-C Bridging Header, under the Swift Compiler - General section. Also, double-click to the right of it and type in the following and hit entry:

Right-click on the blue file in the Project Manager and select New File.... In the new window select Header File from the macOS and Source sections and click Next. At the top change the Save As: name to Leadtools-Bridging-Header.h, which is the same name as the one provided in the Objective-C Bridging Header entry above and MUST match. Then click the check box under the Targets section, as shown in the screenshot below, and click Create.

Screenshot showing how to add the Header File.

The new .h file will be displayed upon creation. Between the #defineand#endif section, list the framework .h files containing the API needed for the project.

For the purposes of this tutorial, only the main leadtools.h file is needed, so list it as follows:

#import <Leadtools/Leadtools.h> 

Note

All framework imports will follow the same structure, IE: for leadtools.codecs it would be #import <Leadtools.Codecs/Leadtools.Codecs.h>.

Screenshot of the imports.

Once finished click Project -> Build, or Command B, to build the project. If done correctly everything should build without error, if you have any errors double check the paths and file names provided in the prior sections.

Given this is a macOS App project, it is by default sandboxed and not allowed to access files outside of the Documents folder. Since we need to access the license file in the LEADTOOLS folder we need to remove the sandbox limitation. To do so, open Add_References_and_Set_a_License.entitlements and set App Sandbox to NO.

Screenshot of entitlements file.

Add the Set License Code

With the project created and the frameworks installed, coding can begin.

Open the ViewController.swift file. Below the existing viewDidLoad()andrepresendedObject sections, create a new override func called viewDidAppear(). Like the above viewDidLoad(), these are different states in the app loading process. Within this function call SetLicense() in order to properly display license status messages in the App UI.

override func viewDidLoad() { 
	super.viewDidLoad() 
 
	// Do any additional setup after loading the view. 
} 
 
override var representedObject: Any? { 
	didSet { 
	// Update the view, if already loaded. 
	} 
} 
 
override func viewDidAppear() { 
	SetLicense() 
} 

Next, create a new standard func called showAlert(message: String, title: String). This function is called from the SetLicense function and is responsible for displaying pop-up style messages in the App UI.

func showAlert(message: String, title: String) { 
	let alert = NSAlert() 
	alert.messageText = title 
	alert.informativeText = message 
	alert.addButton(withTitle: "OK") 
	alert.alertStyle = .warning 
	 
	if let window = view.window ?? NSApplication.shared.windows.first { 
		alert.beginSheetModal(for: window) { modalResponse in 
			if modalResponse == .alertFirstButtonReturn { 
				print("Alert Dismissed") 
			} 
	    } 
	} 
} 

Finally, create a new func called SetLicense() and call it inside the viewDidAppear function, as shown above. Add the following code to properly set your LEADTOOLS license.

func SetLicense() { 
	let license = "/path/to/LEADTOOLS22/Support/Common/License/Leadtools.lic" 
	let keyFile = String("\(license).key") 
	do { 
		let key = try String(contentsOfFile: keyFile) 
		try LTRasterSupport.setLicense(file: license, developerKey: key) 
	} catch { 
		print("Unable to read contents of .key file.\n\(error.localizedDescription)") 
	} 
	 
	if LTRasterSupport.kernelExpired { 
		showAlert(message: "License file invalid or expired.", title: "Leadtools License") 
		print("License file invalid or expired.") 
	} else { 
		showAlert(message: "License file set successfully!", title: "Leadtools License") 
		print("License file set successfully!") 
	} 
} 

Run the Project

Clean the project to clear any errors by selecting Product -> Clean Build Folder or Shift + Command + K.

Run the project by selecting Product -> Run or Command + R.

If the steps were followed correctly, the app will launch and a message will display in the Output window stating License file set successfully

Displayed output message.

Wrap-up

This tutorial showed how to create a new Swift macOS App project, add LEADTOOLS Frameworks and Header files, and set the license.

This is the basis for all Swift macOS App applications leveraging the LEADTOOLS SDK. All functionality in the SDK is unlocked via setting a license. The setLicense() function must be called before calling any other LEADTOOLS SDK functions.

Once the SDK is purchased, the evaluation license can be replaced with a valid runtime license to disable the Nag Message.

See Also

Help Version 22.0.2022.9.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.


Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.