Task to copy a file on disk. More...

#include <qgscopyfiletask.h>

Inheritance diagram for QgsCopyFileTask:

Public Member Functions
	QgsCopyFileTask (const QString &source, const QString &destination)
	Creates a task that copy source file to destination. More...

const QString &	destination () const
	It could be different from the original one. More...

const QString &	errorString () const
	Returns errorString if an error occurred, else returns null QString. More...

bool	run () override
	Performs the task's operation. More...

Public Member Functions inherited from QgsTask
	QgsTask (const QString &description=QString(), QgsTask::Flags flags=AllFlags)
	Constructor for QgsTask. More...

	~QgsTask () override

void	addSubTask (QgsTask *subTask, const QgsTaskList &dependencies=QgsTaskList(), SubTaskDependency subTaskDependency=SubTaskIndependent)
	Adds a subtask to this task. More...

bool	canCancel () const
	Returns `true` if the task can be canceled. More...

virtual void	cancel ()
	Notifies the task that it should terminate. More...

QList< QgsMapLayer * >	dependentLayers () const
	Returns the list of layers on which the task depends. More...

QString	description () const
	Returns the task's description. More...

qint64	elapsedTime () const
	Returns the elapsed time since the task commenced, in milliseconds. More...

Flags	flags () const
	Returns the flags associated with the task. More...

void	hold ()
	Places the task on hold. More...

bool	isActive () const
	Returns `true` if the task is active, ie it is not complete and has not been canceled. More...

double	progress () const
	Returns the task's progress (between 0.0 and 100.0) More...

void	setDependentLayers (const QList< QgsMapLayer * > &dependentLayers)
	Sets a list of layers on which the task depends. More...

void	setDescription (const QString &description)
	Sets the task's description. More...

TaskStatus	status () const
	Returns the current task status. More...

void	unhold ()
	Releases the task from being held. More...

bool	waitForFinished (int timeout=30000)
	Blocks the current thread until the task finishes or a maximum of timeout milliseconds. More...

Additional Inherited Members
Public Types inherited from QgsTask
enum	Flag { CanCancel = 1 << 1 , CancelWithoutPrompt = 1 << 2 , Hidden = 1 << 3 , Silent = 1 << 4 , AllFlags = CanCancel }
	Task flags. More...

enum	SubTaskDependency { SubTaskIndependent = 0 , ParentDependsOnSubTask }
	Controls how subtasks relate to their parent task. More...

enum	TaskStatus { Queued , OnHold , Running , Complete , Terminated }
	Status of tasks. More...

Signals inherited from QgsTask
void	begun ()
	Will be emitted by task to indicate its commencement. More...

void	progressChanged (double progress)
	Will be emitted by task when its progress changes. More...

void	statusChanged (int status)
	Will be emitted by task when its status changes. More...

void	taskCompleted ()
	Will be emitted by task to indicate its successful completion. More...

void	taskTerminated ()
	Will be emitted by task if it has terminated for any reason other then completion (e.g., when a task has been canceled or encountered an internal error). More...

Protected Slots inherited from QgsTask
void	setProgress (double progress)
	Sets the task's current progress. More...

Protected Member Functions inherited from QgsTask
virtual void	finished (bool result)
	If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination). More...

bool	isCanceled () const
	Will return `true` if task should terminate ASAP. More...

virtual bool	run ()=0
	Performs the task's operation. More...

Detailed Description

Task to copy a file on disk.

Since: QGIS 3.22

Definition at line 27 of file qgscopyfiletask.h.

Constructor & Destructor Documentation

◆ QgsCopyFileTask()

QgsCopyFileTask::QgsCopyFileTask	(	const QString &	source,
		const QString &	destination
	)

Creates a task that copy source file to destination.

Definition at line 22 of file qgscopyfiletask.cpp.

Member Function Documentation

◆ destination()

const QString & QgsCopyFileTask::destination ( ) const

It could be different from the original one.

If original destination was a directory the returned destination is now the absolute file path of the copied file

Definition at line 100 of file qgscopyfiletask.cpp.

◆ errorString()

const QString & QgsCopyFileTask::errorString ( ) const

Returns errorString if an error occurred, else returns null QString.

Definition at line 95 of file qgscopyfiletask.cpp.

◆ run()

bool QgsCopyFileTask::run ( )

overridevirtual

Performs the task's operation.

This method will be called when the task commences (ie via calling start() ), and subclasses should implement the operation they wish to perform in the background within this method.

A task must return a boolean value to indicate whether the task was completed successfully or terminated before completion.

Implements QgsTask.

Definition at line 28 of file qgscopyfiletask.cpp.

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

/build/qgis-3.28.0+99sid/src/core/qgscopyfiletask.h
/build/qgis-3.28.0+99sid/src/core/qgscopyfiletask.cpp

Public Member Functions