#include <fm.h>

Inheritance diagram for FM:

Signals
void	cloudItemReady (FMH::MODEL item, QUrl path)

void	cloudServerContentReady (FMStatic::PATH_CONTENT list)

void	dirCreated (FMH::MODEL dir)

void	loadProgress (int percent)

void	newItem (FMH::MODEL item, QUrl path)

void	pathContentChanged (QUrl path)

void	pathContentItemsChanged (QVector< QPair< FMH::MODEL, FMH::MODEL > > items)

void	pathContentItemsReady (FMStatic::PATH_CONTENT list)

void	pathContentItemsRemoved (FMStatic::PATH_CONTENT list)

void	pathContentReady (QUrl path)

void	warningMessage (QString message)

Public Slots
bool	copy (const QList< QUrl > &urls, const QUrl &where)

bool	cut (const QList< QUrl > &urls, const QUrl &where)

void	getCloudItem (const QVariantMap &item)

void	openCloudItem (const QVariantMap &item)

Public Member Functions
	FM (QObject *parent=nullptr)

Q_INVOKABLE void	createCloudDir (const QString &path, const QString &name)

bool	getCloudServerContent (const QUrl &server, const QStringList &filters=QStringList(), const int &depth=0)

void	getPathContent (const QUrl &path, const bool &hidden=false, const bool &onlyDirs=false, const QStringList &filters=QStringList(), const QDirIterator::IteratorFlags &iteratorFlags=QDirIterator::NoIteratorFlags)

QString	resolveLocalCloudPath (const QString &path)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static QString	resolveUserCloudCachePath (const QString &server, const QString &user)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

The FM class stands for File Management, and exposes methods for file listing, browsing and handling, with syncing and tagging integration if such components were enabled with the build flags COMPONENT_SYNCING and COMPONENT_TAGGING.

Warning: File syncing support with webDAV cloud providers, such as NextCloud, is still work in progress.

Definition at line 103 of file fm.h.

Constructor & Destructor Documentation

◆ FM()

FM::FM ( QObject * parent = nullptr )

Creates the instance.

Definition at line 213 of file fm.cpp.

Member Function Documentation

◆ cloudItemReady

void FM::cloudItemReady	(	FMH::MODEL	item,
		QUrl	path )

signal

Emitted for every single item that becomes available, from the requested remote server location.

Parameters

item	the item data
path	the URL of the remote location initially requested

◆ cloudServerContentReady

void FM::cloudServerContentReady ( FMStatic::PATH_CONTENT list )

signal

Emitted once the requested contents of the server are ready.

Parameters

list	the contents packaged in a list, with the file information

◆ copy

bool FM::copy	(	const QList< QUrl > &	urls,
		const QUrl &	where )

slot

Copy a set of file URLs to a new destination.

Parameters

urls	the list of file URLs to be copied.
where	the new location to copy the files

Definition at line 448 of file fm.cpp.

◆ createCloudDir()

void FM::createCloudDir	(	const QString &	path,
		const QString &	name )

Creates a directory in the server.

This only works if the syncing component has been enabled COMPONENT_SYNCING.

Parameters

path	the server location where to create the new directory
name	directory name

Definition at line 400 of file fm.cpp.

◆ cut

bool FM::cut	(	const QList< QUrl > &	urls,
		const QUrl &	where )

slot

Cut a set of file URLs to a new destination.

Parameters

urls	the list of file URLs to be cut.
where	the new location to paste the files

Definition at line 443 of file fm.cpp.

◆ dirCreated

void FM::dirCreated ( FMH::MODEL dir )

signal

Emitted when a directory has been created in the remote server in the current location.

Parameters

dir	the information of the newly created directory

◆ getCloudItem

void FM::getCloudItem ( const QVariantMap & item )

slot

Download a remote server entry.

Parameters

item	the item data.

Definition at line 419 of file fm.cpp.

◆ getCloudServerContent()

bool FM::getCloudServerContent	(	const QUrl &	server,
		const QStringList &	filters = QStringList(),
		const int &	depth = 0 )

Given a server URL address retrieve its contents.

This only works if the syncing component has been enabled with COMPONENT_SYNCING

See also: cloudServerContentReady

Parameters

server	the server URL
filters	the list of string filters to be applied
depth	how deep in the directory three to go, for example, `1` keeps the retrieval in the first level or current directory.

Returns: whether the operation was successful.

Definition at line 366 of file fm.cpp.

◆ getPathContent()

void FM::getPathContent	(	const QUrl &	path,
		const bool &	hidden = false,
		const bool &	onlyDirs = false,
		const QStringList &	filters = QStringList(),
		const QDirIterator::IteratorFlags &	iteratorFlags = QDirIterator::NoIteratorFlags )

Given a path URL retrieve the contents information packaged as a model.

This method is asynchronous and once items become ready the signals will be emitted, such as, pathContentItemsReady or pathContentReady

Parameters

path	the directory path
hidden	whether to pack hidden files
onlyDirs	whether to only pack directories
filters	the list of string filters to be applied
iteratorFlags	the directory iterator flags, for reference check QDirIterator documentation

Definition at line 350 of file fm.cpp.

◆ loadProgress

void FM::loadProgress ( int percent )

signal

Emitted with the progress of the listing.

Parameters

percent the progress percent form 0 to 100

◆ newItem

void FM::newItem	(	FMH::MODEL	item,
		QUrl	path )

signal

Emitted when a new item is available in the remote server in the current location.

Parameters

item	the new item information
path	the path location of the new item

◆ openCloudItem

void FM::openCloudItem ( const QVariantMap & item )

slot

Open a given remote item in an external application.

If the item does not exists in the system local cache, then it is downloaded first.

Parameters

item	the item data. This is exposed this way for convenience of usage from QML, where the item entry from the model will become a QVariantMap.

Definition at line 410 of file fm.cpp.

◆ pathContentChanged

void FM::pathContentChanged ( QUrl path )

signal

Emitted when the contents of the current location has changed, either by some new entries being added or removed.

Parameters

path	the requested location which has changed

◆ pathContentItemsChanged

void FM::pathContentItemsChanged ( QVector< QPair< FMH::MODEL, FMH::MODEL > > items )

signal

Emitted when the current location entries have changed.

Parameters

items the list of pair of entries that have changed, where first is the old version and second is the new version.

◆ pathContentItemsReady

void FM::pathContentItemsReady ( FMStatic::PATH_CONTENT list )

signal

Emitted when a set of entries for the current location are ready.

Parameters

list	the contents packaged in a list, with the file information

◆ pathContentItemsRemoved

void FM::pathContentItemsRemoved ( FMStatic::PATH_CONTENT list )

signal

Emitted when a set of entries in the current location have been removed.

Parameters

list	the removed contents packaged in a list, with the file information

◆ pathContentReady

void FM::pathContentReady ( QUrl path )

signal

Emitted once the contents of the current location are ready and the listing has finished.

Parameters

path	the requested location path

◆ resolveLocalCloudPath()

QString FM::resolveLocalCloudPath ( const QString & path )

Given a remote server address URL, resolve it to the local cache URL.

This only works if the syncing component has been enabled COMPONENT_SYNCING=ON

Parameters

path	the remote Server address

Returns: the resolved server path as a local URL

Definition at line 433 of file fm.cpp.

◆ resolveUserCloudCachePath()

QString FM::resolveUserCloudCachePath	(	const QString &	server,
		const QString &	user )

static

Given the server address and the user name, resolve a local path for the cache of the files.

Parameters

server	the remove server address
user	the user name of the server

Returns

Definition at line 427 of file fm.cpp.

◆ warningMessage

void FM::warningMessage ( QString message )

signal

Emitted when there is an error.

Parameters

message the error message

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

fm.h
fm.cpp

Class Picker

Quick Links

About MauiKit File Browsing

FM

Signals

Public Slots

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FM()

Member Function Documentation

◆ cloudItemReady

◆ cloudServerContentReady

◆ copy

◆ createCloudDir()

◆ cut

◆ dirCreated

◆ getCloudItem

◆ getCloudServerContent()

◆ getPathContent()

◆ loadProgress

◆ newItem

◆ openCloudItem

◆ pathContentChanged

◆ pathContentItemsChanged

◆ pathContentItemsReady

◆ pathContentItemsRemoved

◆ pathContentReady

◆ resolveLocalCloudPath()

◆ resolveUserCloudCachePath()

◆ warningMessage