CMakeSongbookProcess Class Reference

CMakeSongbookProcess calls songbook's external processes. More...

#include <make-songbook-process.hh>

List of all members.

Public Slots
void	execute ()
void	setCommand (const QString &command)
void	setStartMessage (const QString &message)
void	setSuccessMessage (const QString &message)
void	setErrorMessage (const QString &message)
void	setUrlToOpen (const QUrl &url)

Signals
void	aboutToStart ()
void	message (const QString &message, int timeout)
void	readOnStandardOutput (const QString &output)
void	readOnStandardError (const QString &error)

Public Member Functions
	CMakeSongbookProcess (QObject *parent=0)
	Constructor.
virtual	~CMakeSongbookProcess ()
	Destructor.
QString	command () const
const QString &	startMessage () const
const QString &	successMessage () const
const QString &	errorMessage () const
const QUrl &	urlToOpen () const

Properties
QString	command
QString	program
QStringList	arguments
QString	startMessage
QString	successMessage
QString	errorMessage
QUrl	urlToOpen

---

Detailed Description

CMakeSongbookProcess calls songbook's external processes.

Three processes can be called:

• the build command (make)
• the clean command (make clean)
• the cleanall command (make cleanall)

These commands are defined in preferences.hh. For Linux platforms, it directly uses makefile (with or without arguments). For MacOS and Windows platforms, it uses specific scripts that are respectively located into windows/ and macos/ subdirectories of the songbook directory.

---

Member Function Documentation

void CMakeSongbookProcess::aboutToStart ( )

signal

This signal is emitted before the process is executed.

See also:

execute

QString CMakeSongbookProcess::command

(

)

const

Returns the whole command to be executed.

See also:

setCommand

const QString& CMakeSongbookProcess::errorMessage

(

)

const

Returns the message that is displayed when the process exits with failure.

See also:

setErrorMessage

void CMakeSongbookProcess::execute ( )

slot

Execute the process once all parameters have been set. The signal aboutToStart is emitted before the execution.

See also:

aboutToStart

void CMakeSongbookProcess::message ( const QString &  message, int  timeout  )

signal

Emits a message when the process starts and exits after a delay of timeout.

See also:

startMessage, successMessage, errorMessage

void CMakeSongbookProcess::readOnStandardError ( const QString &  error )

signal

This signal is emitted when information is available on error output.

See also:

readOnStandardOutput

void CMakeSongbookProcess::readOnStandardOutput ( const QString &  output )

signal

This signal is emitted when information is available on standard output.

See also:

readOnStandardError

void CMakeSongbookProcess::setCommand ( const QString &  command )

slot

Sets the command that should be executed. For instance: "make songbook.pdf".

See also:

command, program, arguments

void CMakeSongbookProcess::setErrorMessage ( const QString &  message )

slot

Sets the message that should displayed when the process exits with failure. The message is displayed within the status bar.

See also:

errorMessage, setStartMessage, setSuccessMessage

void CMakeSongbookProcess::setStartMessage ( const QString &  message )

slot

Sets the message that should displayed when the process starts. The message is displayed within the status bar.

See also:

startMessage, setSuccessMessage, setErrorMessage

void CMakeSongbookProcess::setSuccessMessage ( const QString &  message )

slot

Sets the message that should displayed when the process successfully exits. The message is displayed within the status bar.

See also:

successMessage, setStartMessage, setErrorMessage

void CMakeSongbookProcess::setUrlToOpen ( const QUrl &  url )

slot

Sets an url that should be opened after the process successfully exits. The message is displayed within the status bar.

See also:

urlToOpen

const QString& CMakeSongbookProcess::startMessage

(

)

const

Returns the message that is displayed when the process starts.

See also:

setStartMessage

const QString& CMakeSongbookProcess::successMessage

(

)

const

Returns the message that is displayed when the process successfully exits.

See also:

setSuccessMessage

const QUrl& CMakeSongbookProcess::urlToOpen

(

)

const

Returns the url that should be opened when the process successfully exits.

See also:

setUrlToOpen

---

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

• src/make-songbook-process.hh
• src/make-songbook-process.cc