Interface to platform-specific file exchange functionality. More...

#include <FileExchange_Abstract.h>

Inheritance diagram for Platform::FileExchange_Abstract:

Public Types
enum	FileFunction : quint8
	Functions and types of a file that this app handles.

Public Slots
virtual void	onGUISetupCompleted ()=0
	GUI setup completed.

virtual void	processFileOpenRequest (const QString &path)
	Determine file function and emit openFileRequest()

void	processFileOpenRequest (const QByteArray &path)
	Determine file function and emit openFileRequest()

void	processText (const QString &text)
	Process text.

bool	processTextQuiet (const QString &text)
	Process text.

Signals
void	openFileRequest (QString fileName, QString info, Platform::FileExchange_Abstract::FileFunction fileFunction)
	Emitted when platform asks this app to open a file.

void	openWaypointRequest (GeoMaps::Waypoint waypoint)
	Emitted when platform asks this app to show a waypoint.

void	resolveURL (QString url, QString site)
	Emitted when Google Maps URL needs to be resolved.

void	unableToProcessText (QString text)
	Emitted when processText was unable to parse a text item.

Public Member Functions
	FileExchange_Abstract (QObject *parent=nullptr)
	Standard constructor.

virtual Q_INVOKABLE void	importContent ()=0
	Import content from file.

virtual Q_INVOKABLE QString	shareContent (const QByteArray &content, const QString &mimeType, const QString &fileNameTemplate)=0
	Share content.

virtual Q_INVOKABLE QString	viewContent (const QByteArray &content, const QString &mimeType, const QString &fileNameTemplate)=0
	View content.

Public Member Functions inherited from GlobalObject
	GlobalObject (QObject *parent=nullptr)
	Standard constructor.

	~GlobalObject () override=default
	Standard deconstructor.

Additional Inherited Members
Static Public Member Functions inherited from GlobalObject
static void	clear ()
	Deletes all globally defined objects.

static Q_INVOKABLE bool	canConstruct ()
	Indicates if the static methods are ready to be used.

static Q_INVOKABLE Navigation::Clock *	clock ()
	Pointer to appplication-wide static Navigation::Clock instance.

static Q_INVOKABLE DataManagement::DataManager *	dataManager ()
	Pointer to appplication-wide static GeoMaps::DataManager instance.

static Q_INVOKABLE DemoRunner *	demoRunner ()
	Pointer to appplication-wide static DemoRunner instance.

static Q_INVOKABLE Traffic::FlarmnetDB *	flarmnetDB ()
	Pointer to appplication-wide static FlarmnetDB instance.

static Q_INVOKABLE Platform::FileExchange_Abstract *	fileExchange ()
	Pointer to appplication-wide static FileExchange instance.

static Q_INVOKABLE GeoMaps::GeoMapProvider *	geoMapProvider ()
	Pointer to appplication-wide static GeoMaps::GeoMapProvider instance.

static Q_INVOKABLE GlobalSettings *	globalSettings ()
	Pointer to appplication-wide static Settings instance.

static Q_INVOKABLE Librarian *	librarian ()
	Pointer to appplication-wide static librarian instance.

static Q_INVOKABLE Platform::PlatformAdaptor_Abstract *	platformAdaptor ()
	Pointer to appplication-wide static PlatformAdaptor instance.

static Q_INVOKABLE Sensors *	sensors ()
	Pointer to appplication-wide static Navigation::Clock instance.

static Q_INVOKABLE Navigation::Navigator *	navigator ()
	Pointer to appplication-wide static Navigation::Navigator instance.

static Q_INVOKABLE Traffic::PasswordDB *	passwordDB ()
	Pointer to appplication-wide static PasswordDB instance.

static Q_INVOKABLE Positioning::PositionProvider *	positionProvider ()
	Pointer to appplication-wide static PositionProvider instance.

static Q_INVOKABLE NOTAM::NOTAMProvider *	notamProvider ()
	Pointer to appplication-wide static notification manager instance.

static Q_INVOKABLE Notifications::NotificationManager *	notificationManager ()
	Pointer to appplication-wide static notification manager instance.

static Q_INVOKABLE QNetworkAccessManager *	networkAccessManager ()
	Pointer to appplication-wide static QNetworkAccessManager instance.

static Q_INVOKABLE DataManagement::SSLErrorHandler *	sslErrorHandler ()
	Pointer to appplication-wide static QNetworkAccessManager instance.

static Q_INVOKABLE Traffic::TrafficDataProvider *	trafficDataProvider ()
	Pointer to appplication-wide static TrafficDataProvider instance.

static Q_INVOKABLE GeoMaps::WaypointLibrary *	waypointLibrary ()
	Pointer to appplication-wide static WaypointLibrary instance.

static Q_INVOKABLE Weather::WeatherDataProvider *	weatherDataProvider ()
	Pointer to appplication-wide static WeatherDataProvider instance.

Protected Member Functions inherited from GlobalObject
virtual void	deferredInitialization ()
	Non-constructor initialization.

Detailed Description

Interface to platform-specific file exchange functionality.

This pure virtual class is an interface to file exchange functionality that need platform-specific code to operate. The files FileExchange_XXX.(h|cpp) implement a child class FileExchange that contains the actual implementation.

If supported by the platform, child classes need to react to requests by the platform to open a file (e.g. a GeoJSON file containing a flight route). Once a request is received, the method processFileRequest() should be called.

Definition at line 40 of file FileExchange_Abstract.h.

Constructor & Destructor Documentation

◆ FileExchange_Abstract()

Platform::FileExchange_Abstract::FileExchange_Abstract ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent Standard QObject parent pointer

Member Function Documentation

◆ importContent()

virtual Q_INVOKABLE void Platform::FileExchange_Abstract::importContent ( )

pure virtual

Import content from file.

On desktop systems, this method is supposed to open a file dialog to import a file. On mobile systems, this method is supposed to do nothing.

Implemented in Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, and Platform::FileExchange.

◆ onGUISetupCompleted

virtual void Platform::FileExchange_Abstract::onGUISetupCompleted ( )

pure virtualslot

GUI setup completed.

This method is must called as soon as the GUI setup is completed. On Android, this method will start looking for file import requests from the OS. On Desktop system, this method does nothing.

◆ openFileRequest

void Platform::FileExchange_Abstract::openFileRequest	(	QString	fileName,
		QString	info,
		Platform::FileExchange_Abstract::FileFunction	fileFunction )

signal

Emitted when platform asks this app to open a file.

This signal is emitted whenever the platform-dependent code receives information that enroute is requested to open a file.

Parameters

fileName	Path of the file on the local file system
info	Additional information about the file, as a translated, human-readable string in HTML format.
fileFunction	Function and file type.

◆ openWaypointRequest

void Platform::FileExchange_Abstract::openWaypointRequest ( GeoMaps::Waypoint waypoint )

signal

Emitted when platform asks this app to show a waypoint.

This signal is emitted whenever the platform-dependent code receives information that enroute is requested to show a waypoint.

Parameters

waypoint Waypoint to be shown

◆ processFileOpenRequest [1/2]

void Platform::FileExchange_Abstract::processFileOpenRequest ( const QByteArray & path )

slot

Determine file function and emit openFileRequest()

Overloaded function for convenience

Parameters

path	QByteArray containing an UTF8-Encoded strong

◆ processFileOpenRequest [2/2]

virtual void Platform::FileExchange_Abstract::processFileOpenRequest ( const QString & path )

virtualslot

Determine file function and emit openFileRequest()

This helper function is called by platform-dependent code whenever the app is asked to open a file. It will look at the file, determine the file function and emit the signal openFileRequest() as appropriate.

Parameters

path File name

◆ processText

void Platform::FileExchange_Abstract::processText ( const QString & text )

slot

Process text.

This helper function is called by platform-dependent code whenever text is passed to the app (e.g. via drag-and-drop or via an Android intent). It will look at the text, determine the text function and emit signals as appropriate.

Parameters

text Text

◆ processTextQuiet

bool Platform::FileExchange_Abstract::processTextQuiet ( const QString & text )

slot

Process text.

This helper function analyses the text and checks if it can be interpreted as containing geographic coordinates. If so, it emits the signal openWaypointRequest() and returns true. Otherwise, it returns false.

Parameters

text Text

Returns: True if the text can be interpreted as containing geographic coordinates

◆ resolveURL

void Platform::FileExchange_Abstract::resolveURL	(	QString	url,
		QString	site )

signal

Emitted when Google Maps URL needs to be resolved.

This signal is emitted if the method processText encounters a URL of type https://maps.app.goo.gl/SOMECODE. The GUI will then open the page URLResolver.

◆ shareContent()

virtual Q_INVOKABLE QString Platform::FileExchange_Abstract::shareContent	(	const QByteArray &	content,
		const QString &	mimeType,
		const QString &	fileNameTemplate )

pure virtual

Share content.

On desktop systems, this method is supposed to show a file dialog to save the file. On mobile devices, this method is supposed to open a dialog that allows to chose the method to send this file (e-mail, dropbox, signal chat, …)

Parameters

content	File content
mimeType	the mimeType of the content
fileNameTemplate	A string of the form "EDTF - EDTG", without suffix of path. This can be used, e.g. as the name of the attachment when sending files by e-mail.

Returns: Empty string on success, the string "abort" on abort, and a translated error message otherwise

Implemented in Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, and Platform::FileExchange.

◆ viewContent()

virtual Q_INVOKABLE QString Platform::FileExchange_Abstract::viewContent	(	const QByteArray &	content,
		const QString &	mimeType,
		const QString &	fileNameTemplate )

pure virtual

View content.

This method is supposed open the content in an appropriate app. Example: if the content is GeoJSON, the content might be opened in Google Earth, or in a mobile mapping application.

Parameters

content	content text
mimeType	the mimeType of the content
fileNameTemplate	A string of the form "FlightRoute-%1.geojson".

Returns: Empty string on success, a translated error message otherwise

Implemented in Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, and Platform::FileExchange.

The documentation for this class was generated from the following file:

/home/runner/work/enroute/enroute/src/platform/FileExchange_Abstract.h

Public Types

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileExchange_Abstract()

Member Function Documentation

◆ importContent()

◆ onGUISetupCompleted

◆ openFileRequest

◆ openWaypointRequest

◆ processFileOpenRequest [1/2]

◆ processFileOpenRequest [2/2]

◆ processText

◆ processTextQuiet

◆ resolveURL

◆ shareContent()

◆ viewContent()