#include <kgrsounds.h>

Inheritance diagram for KGrSounds:

Public Member Functions
	KGrSounds ()

	~KGrSounds ()

int	loadSound (const QString &fileName)

int	play (int effect)

void	reset ()

void	setEffectsVolume (double volume)

void	setMusicVolume (double volume)

void	setMuted (bool mute)

void	setTimedSound (int i)

void	setVolume (int effect, qreal volume)

void	stop (int token)

void	stopAllSounds ()

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

Definition at line 28 of file kgrsounds.h.

Constructor & Destructor Documentation

KGrSounds::KGrSounds ( )

Construct the KGrSounds class.

Definition at line 23 of file kgrsounds.cpp.

KGrSounds::~KGrSounds ( )

Definition at line 30 of file kgrsounds.cpp.

Member Function Documentation

int KGrSounds::loadSound ( const QString & fileName )

Load a sound sample.

A token is returned to use to play back the sample.

Definition at line 34 of file kgrsounds.cpp.

int KGrSounds::play ( int effect )

Play a sound effect.

This method returns a token that can be used to stop the sound if it is still playing. Trying to stop a completed sound has no effect.

Definition at line 60 of file kgrsounds.cpp.

void KGrSounds::reset ( )

Stop sound and discard the loaded sound effects.

Definition at line 54 of file kgrsounds.cpp.

void KGrSounds::setEffectsVolume ( double volume )

Set volume for the sound effects.

Parameters

volume the playing volume. 0.0 means mute, 1.0 means full volume.

void KGrSounds::setMusicVolume ( double volume )

Set volume for the background music.

Parameters

volume the playing volume. 0.0 means mute, 1.0 means full volume.

void KGrSounds::setMuted ( bool mute )

Definition at line 91 of file kgrsounds.cpp.

void KGrSounds::setTimedSound ( int i )

Set up a sound to have its latest start-time recorded.

Definition at line 42 of file kgrsounds.cpp.

void KGrSounds::setVolume	(	int	effect,
		qreal	volume
	)

Change the volume of one type of sound (e.g.

footstep) by a given factor.

Parameters

volume 0.0 for mute, > 1.0 to increase, < 1.0 to decrease.

Definition at line 99 of file kgrsounds.cpp.

void KGrSounds::stop ( int token )

Stop playing the sound associated with the given token.

Definition at line 84 of file kgrsounds.cpp.

void KGrSounds::stopAllSounds ( )

Stop all sounds currently playing.

Definition at line 47 of file kgrsounds.cpp.

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

kgoldrunner

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

kgoldrunner

kdegames API Reference

Search