sf::ScriptEntry Class Reference

Script entry for the list contained by the manager. More...

#include <ScriptManager.h>

Inheritance diagram for sf::ScriptEntry:

Collaboration diagram for sf::ScriptEntry:

Public Types
enum	EBackgroundMode { bmNo = 0 , bmOnce , bmContinuous }
	Available background modes. More...

Public Member Functions
	ScriptEntry (ScriptManager *parent)
	Constructor.
bool	start ()
	Compiles and initializes the script.
void	stop ()
	Stops a script from running in the background.
const QKeySequence &	getKeySequence () const
void	setKeySequence (const QKeySequence &ks)
QString	getDisplayName () const
void	setDisplayName (const QString &name)
QString	getScriptName () const
void	setScriptName (const QString &name)
const QString &	getFilename () const
void	setFilename (const QString &name)
EBackgroundMode	getBackgroundMode () const
void	setBackgroundMode (EBackgroundMode bm)
void	setInterpreter (const QSharedPointer< ScriptInterpreter > &interpreter)
const QSharedPointer< ScriptInterpreter > &	getInterpreter () const
QString	getStateName () const
bool	isGlobal () const
	Sets the global shortcut global flag.
void	setGlobal (bool)
	Sets the global shortcut global flag.

Detailed Description

Script entry for the list contained by the manager.

Member Enumeration Documentation

EBackgroundMode

enum sf::ScriptEntry::EBackgroundMode

Available background modes.

Enumerator
bmNo	No background running of the script.
bmOnce	Run the script once.
bmContinuous	Run the script continuous

Constructor & Destructor Documentation

ScriptEntry()

sf::ScriptEntry::ScriptEntry ( ScriptManager *  parent )

inlineexplicit

Constructor.

Member Function Documentation

getBackgroundMode()

EBackgroundMode sf::ScriptEntry::getBackgroundMode ( ) const

inline

getDisplayName()

QString sf::ScriptEntry::getDisplayName

(

)

const

getFilename()

const QString & sf::ScriptEntry::getFilename ( ) const

inline

getInterpreter()

const QSharedPointer< ScriptInterpreter > & sf::ScriptEntry::getInterpreter ( ) const

inline

getKeySequence()

const QKeySequence & sf::ScriptEntry::getKeySequence

(

)

const

getScriptName()

QString sf::ScriptEntry::getScriptName

(

)

const

getStateName()

QString sf::ScriptEntry::getStateName

(

)

const

isGlobal()

bool sf::ScriptEntry::isGlobal

(

)

const

Sets the global shortcut global flag.

setBackgroundMode()

void sf::ScriptEntry::setBackgroundMode

(

EBackgroundMode

bm

)

setDisplayName()

void sf::ScriptEntry::setDisplayName

(

const QString &

name

)

setFilename()

void sf::ScriptEntry::setFilename

(

const QString &

name

)

setGlobal()

void sf::ScriptEntry::setGlobal

(

bool

)

Sets the global shortcut global flag.

setInterpreter()

void sf::ScriptEntry::setInterpreter ( const QSharedPointer< ScriptInterpreter > &  interpreter )

inline

setKeySequence()

void sf::ScriptEntry::setKeySequence

(

const QKeySequence &

ks

)

setScriptName()

void sf::ScriptEntry::setScriptName

(

const QString &

name

)

start()

bool sf::ScriptEntry::start

(

)

Compiles and initializes the script.

Returns

True on success.

stop()

void sf::ScriptEntry::stop

(

)

Stops a script from running in the background.

---

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

• ScriptManager.h