lmms::gui::FileSearchJob Class Reference

#include <FileSearchJob.h>

Inheritance diagram for lmms::gui::FileSearchJob:

Classes
struct	Task
	Represents a search task to be carried out by the search job. More...

Signals
void	foundMatch (const QString &path)
	Emitted when the search job has found a matching path.
void	started ()
	Emitted when the search job has started searching.
void	finished ()
	Emitted when the search job has finished searching.

Public Member Functions
	FileSearchJob (QObject *parent=nullptr)
	Create a search job with the given parent (if any).
	~FileSearchJob ()
	Stop processing and destroys the object.
	FileSearchJob (const FileSearchJob &)=delete
	FileSearchJob (FileSearchJob &&)=delete
FileSearchJob &	operator= (const FileSearchJob &)=delete
FileSearchJob &	operator= (FileSearchJob &&)=delete
void	search (Task task)

Private Member Functions
void	runSearch (Task task)

Private Attributes
std::future< void >	m_task
std::atomic_flag	m_stop = ATOMIC_FLAG_INIT

Detailed Description

The FileSearchJob class allows for searching for files on the filesystem. Searching occurs on a background thread, and results are emitted as a Qt slot back to the user.

Constructor & Destructor Documentation

FileSearchJob() [1/3]

lmms::gui::FileSearchJob::FileSearchJob

(

QObject *

parent = nullptr

)

Create a search job with the given parent (if any).

~FileSearchJob()

lmms::gui::FileSearchJob::~FileSearchJob

(

)

Stop processing and destroys the object.

FileSearchJob() [2/3]

lmms::gui::FileSearchJob::FileSearchJob ( const FileSearchJob & )

delete

FileSearchJob() [3/3]

lmms::gui::FileSearchJob::FileSearchJob ( FileSearchJob && )

delete

Member Function Documentation

finished

void lmms::gui::FileSearchJob::finished ( )

signal

Emitted when the search job has finished searching.

foundMatch

void lmms::gui::FileSearchJob::foundMatch ( const QString & path )

signal

Emitted when the search job has found a matching path.

operator=() [1/2]

FileSearchJob & lmms::gui::FileSearchJob::operator= ( const FileSearchJob & )

delete

operator=() [2/2]

FileSearchJob & lmms::gui::FileSearchJob::operator= ( FileSearchJob && )

delete

runSearch()

void lmms::gui::FileSearchJob::runSearch ( Task task )

private

search()

void lmms::gui::FileSearchJob::search

(

Task

task

)

Commit to searching with the given task. Cancels any previous search. Callers can connect to the provided signals to interact with the search and its progress.

started

void lmms::gui::FileSearchJob::started ( )

signal

Emitted when the search job has started searching.

Member Data Documentation

m_stop

std::atomic_flag lmms::gui::FileSearchJob::m_stop = ATOMIC_FLAG_INIT

private

m_task

std::future<void> lmms::gui::FileSearchJob::m_task

private

---

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

• include/FileSearchJob.h
• src/gui/FileSearchJob.cpp