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

NonGUIFrontend Class Reference

#include <nonguifrontend.h>

Inheritance diagram for NonGUIFrontend:

Frontend List of all members.

Public Member Functions

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

Detailed Description

Frontend for using the program through command line options.

Author:
Bjoern Erik Nilsen & Fredrik Berg Kjoelstad


Constructor & Destructor Documentation

NonGUIFrontend::NonGUIFrontend DomainFacade facadePtr  ) 
 

Constructs and initializes the object.

Parameters:
facadePtr pointer to the domain facade


Member Function Documentation

int NonGUIFrontend::askQuestion const char *  question  )  [virtual]
 

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

Implements Frontend.

void NonGUIFrontend::hideProgress  )  [virtual]
 

Function for hiding the progress info.

Implements Frontend.

bool NonGUIFrontend::isOperationAborted  )  [virtual]
 

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

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

Implements Frontend.

void NonGUIFrontend::processEvents  )  [virtual]
 

Function for processing events. This is useful on timeconsuming operations which aren't running in separate processes or threads. This function is actually not needed in this frontend.

Implements Frontend.

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

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

Implements Frontend.

int NonGUIFrontend::run int  argc,
char **  argv
[virtual]
 

The run function for starting the application.

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

Implements Frontend.

void NonGUIFrontend::setProgressInfo const char *  infoText  )  [virtual]
 

Function for changing the information to display to the user

Parameters:
infoText the text to display to the user

Implements Frontend.

void NonGUIFrontend::showProgress const char *  infoText,
unsigned int  numOperations
[virtual]
 

Function for displaying progress on timeconsuming operations.

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

Implements Frontend.

void NonGUIFrontend::updateProgress int  numOperationsDone  )  [virtual]
 

Function for updating the progress.

Parameters:
numOperationsDone the number of operations done

Implements Frontend.


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