API reference - Class QSound

Notation used in Ruby API documentation

Description: Binding of QSound

Class hierarchy: QSound » QObject

Public constructors

new QSoundnew(string filename,
QObject ptr parent = 0)
Constructor QSound::QSound(const QString &filename, QObject *parent)

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QSound::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QSound::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSound::eventFilter(QObject *, QEvent *)
[const]stringfileNameMethod QString QSound::fileName()
[const]boolisFinishedMethod bool QSound::isFinished()
[const]boolisFinished?Method bool QSound::isFinished()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]intloopsMethod int QSound::loops()
voidloops=(int arg1)Method void QSound::setLoops(int)
[const]intloopsRemainingMethod int QSound::loopsRemaining()
voidplayMethod void QSound::play()
voidsetLoops(int arg1)Method void QSound::setLoops(int)
voidstopMethod void QSound::stop()

Public static methods and constants

boolisAvailableStatic method bool QSound::isAvailable()
boolisAvailable?Static method bool QSound::isAvailable()
voidplay(string filename)Static method void QSound::play(const QString &filename)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QSound::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QSound::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QSound::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QSound::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QSound::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QSound::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QSound::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QSound::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QSound::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSound::timerEvent(QTimerEvent *)

Detailed description

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QSound::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QSound::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QSound::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QSound::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QSound::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QSound::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[const] string fileName

Description: Method QString QSound::fileName()

[static] bool isAvailable

Description: Static method bool QSound::isAvailable()

This method is static and can be called without an instance.

[static] bool isAvailable?

Description: Static method bool QSound::isAvailable()

This method is static and can be called without an instance.

[const] bool isFinished

Description: Method bool QSound::isFinished()

[const] bool isFinished?

Description: Method bool QSound::isFinished()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[const] int loops

Description: Method int QSound::loops()

void loops=(int arg1)

Description: Method void QSound::setLoops(int)

[const] int loopsRemaining

Description: Method int QSound::loopsRemaining()

[static] new QSound new(string filename,QObject ptr parent = 0)

Description: Constructor QSound::QSound(const QString &filename, QObject *parent)

This method creates an object of class QSound.

void play

Description: Method void QSound::play()

[static] void play(string filename)

Description: Static method void QSound::play(const QString &filename)

This method is static and can be called without an instance.

[const] int receivers(string signal)

Description: Method int QSound::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

[const] QObject ptr sender

Description: Method QObject *QSound::sender()

This method is protected and can only be called from inside a derived class.

void setLoops(int arg1)

Description: Method void QSound::setLoops(int)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

void stop

Description: Method void QSound::stop()

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QSound::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QSound::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QSound::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QSound::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QSound::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.