Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

Frontend Class Reference

#include <frontend.h>

Inheritance diagram for Frontend:

NonGUIFrontend QtFrontend List of all members.

Public Member Functions

virtual int run (int argc, char **argv)=0
virtual void showProgress (const char *infoText, unsigned int numOperations=0)=0
virtual void hideProgress ()=0
virtual void updateProgress (int numOperationsDone)=0
virtual void setProgressInfo (const char *infoText)=0
virtual bool isOperationAborted ()=0
virtual void processEvents ()=0
virtual void reportError (const char *message, int id)=0
virtual int askQuestion (const char *question)=0

Detailed Description

The frontend interface to be used by the implemented frontend.

Author:
Bjoern Erik Nilsen & Fredrik Berg Kjoelstad


Member Function Documentation

virtual int Frontend::askQuestion const char *  question  )  [pure virtual]
 

Abstract function for asking the user a yes/no question.

Parameters:
question the question to ask
Returns:
0 if the user answer yes, 1 if no

Implemented in NonGUIFrontend, and QtFrontend.

virtual void Frontend::hideProgress  )  [pure virtual]
 

Abstract function for hiding the progress info.

Implemented in NonGUIFrontend, and QtFrontend.

virtual bool Frontend::isOperationAborted  )  [pure virtual]
 

Abstract function for checking if the user has aborted the operation (eg pressed cancel)

Returns:
true if the the operation is aborted, false otherwise

Implemented in NonGUIFrontend, and QtFrontend.

virtual void Frontend::processEvents  )  [pure virtual]
 

Abstract function for processing GUI events. This is useful on timeconsuming operations which aren't running in separate processes or threads.

Implemented in NonGUIFrontend, and QtFrontend.

virtual void Frontend::reportError const char *  message,
int  id
[pure virtual]
 

Abstract function for reporting an error to the user. It has two categories of errors; warning and critical.

Parameters:
message the error message to display to the user
id kind of error; 0 for warning, 1 for critical

Implemented in NonGUIFrontend, and QtFrontend.

virtual int Frontend::run int  argc,
char **  argv
[pure virtual]
 

Abstract function for starting the application through the frontend.

Parameters:
argc the argc argument from the environment through main.
argv the argv arguments from the environment through main.
Returns:
the return status on exit

Implemented in NonGUIFrontend, and QtFrontend.

virtual void Frontend::setProgressInfo const char *  infoText  )  [pure virtual]
 

Abstract function for changing the information to display to the user

Parameters:
infoText the text to display to the user

Implemented in NonGUIFrontend, and QtFrontend.

virtual void Frontend::showProgress const char *  infoText,
unsigned int  numOperations = 0
[pure virtual]
 

Abstract function for displaying progress on timeconsuming operations.

Parameters:
infoText the text to display to the user
numOperations the number of calculated operations to do

Implemented in NonGUIFrontend, and QtFrontend.

virtual void Frontend::updateProgress int  numOperationsDone  )  [pure virtual]
 

Abstract function for updating the progress.

Parameters:
numOperationsDone the number of operations done

Implemented in NonGUIFrontend, and QtFrontend.


The documentation for this class was generated from the following file:
Generated on Thu May 19 01:51:21 2005 for stopmotion.kdevelop by  doxygen 1.4.2