kpilot/kpilot

ActionQueue Class Reference

#include <syncStack.h>

Inheritance diagram for ActionQueue:

SyncAction List of all members.

Detailed Description

The ActionQueue is a meta-action, which handles running a bunch of SyncActions in sequence.

It is a SyncAction itself, so it can even be queued on another ActionQueue.

An ActionQueue is constructed with a device. As usual, you should connect the device's deviceReady(KPilotLink*) signal with the exec() slot -- or something to that effect. The ActionQueue will then run all the actions in the queue in sequence.

Definition at line 61 of file syncStack.h.


Public Types

enum  InitFlags { queueNone = 0, queueCheckUser }

Public Member Functions

 ActionQueue (KPilotLink *device)
virtual ~ActionQueue ()
bool isEmpty () const
void addAction (SyncAction *a)
void queueInit (InitFlags checkUser=queueNone)
void queueConduits (const QStringList &conduits, const SyncAction::SyncMode &e, bool local=false)
void queueInstaller (const QString &dir)
void queueCleanup ()

Protected Slots

void actionCompleted (SyncAction *)

Protected Member Functions

void clear ()
SyncActionnextAction ()
virtual bool exec ()

Protected Attributes

bool fReady
QString fInstallerDir
QStringList fInstallerFiles
QStringList fConduits

Member Enumeration Documentation

Enum values for queueInit(), specifying what standard actions to queue automatically.

Definition at line 97 of file syncStack.h.


Constructor & Destructor Documentation

ActionQueue::ActionQueue ( KPilotLink device  ) 

Constructor.

Pass in a KPilot device link for it to act on. It is legal to pass in 0 (NULL) as a device.

Definition at line 280 of file syncStack.cc.


Member Function Documentation

void ActionQueue::addAction ( SyncAction a  )  [inline]

You can push your own actions onto the stack, but you should only do so if you don't call prepare().

Definition at line 81 of file syncStack.h.

void ActionQueue::queueInit ( InitFlags  checkUser = queueNone  ) 

Call these queue*() functions to append standard functional blocks.

You should at least call queueInit() and queueCleanup() to add the welcome and cleanup actions to the queue (unless you do that yourself.)

For queueInit, checkUser causes a CheckUser action to be queued automatically. For queueConduits, whatever is relevant for the conduits can be used, usually things in the FlagMask and ActionMask. The list of conduits in conduits is queued automatically. For queueInstaller, the directory dir is used as a source of files to install (checked at exec() time).

Definition at line 294 of file syncStack.cc.

void ActionQueue::actionCompleted ( SyncAction  )  [protected, slot]

When one action finishes, start the next one.

Definition at line 351 of file syncStack.cc.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys