KFAction Class Reference

#include <format.h>

Inheritance diagram for KFAction:

Public Slots
virtual void	exec ()
virtual void	quit ()

Signals
void	done (KFAction *me, bool success)
void	error (const QString &msg, const QString &details)
void	status (const QString &msg, int progress)

Public Member Functions
	KFAction (QObject *parent=0L)
virtual	~KFAction ()

Detailed Description

Abstract base class of actions to be undertaken.

Basically you can create a KFActionStack (See below) and push a bunch of actions on it, then run exec() on the stack and wait for the done() signal.

Definition at line 66 of file format.h.

Constructor & Destructor Documentation

KFAction::KFAction

(

QObject *

parent = 0L

)

Definition at line 52 of file format.cpp.

KFAction::~KFAction ( )

virtual

Definition at line 58 of file format.cpp.

Member Function Documentation

void KFAction::done ( KFAction *  me, bool  success  )

signal

done() should always be emitted with this as first parameter, to avoid sender() magic and the like.

success indicates whether the action was successful.

void KFAction::error ( const QString &  msg, const QString &  details  )

signal

error() displays a box.

It interrupts the user's work and should be used with care.

void KFAction::exec ( )

virtualslot

Exec() should return quickly to ensire that the GUI thread stays alive.

quit() should abort the action.

Reimplemented in Ext2Filesystem, FATFilesystem, DDZeroOut, FDFormat, and KFActionQueue.

Definition at line 69 of file format.cpp.

void KFAction::quit ( )

virtualslot

Quit aborts the action.

No done() signal should be emitted.

Reimplemented in FloppyAction.

Definition at line 64 of file format.cpp.

void KFAction::status ( const QString &  msg, int  progress  )

signal

Emit this signal to inform the user of interesting changes; setting msg to an empty string doesn't change any visible user message.

progress indicates the action's progress (if that can be determined) and sending -1 leaves the visible indicator unchanged.

---

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

• format.h
• format.cpp