KDE PIM / Developers / API Docs / kpilot / kpilot

ActionQueue Class Reference

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

#include <syncStack.h>

Inherits SyncAction.

List of all members.

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes


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(KPilotDeviceLink*) signal with the exec() slot -- or something to that effect. The ActionQueue will then run all the actions in the queue in sequence.


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().

void ActionQueue::queueInit bool  checkUser = false  ) 
 

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).

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

When one action finishes, start the next one.


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