diff options
Diffstat (limited to 'doc/man/man3/tqsound.3qt')
| -rw-r--r-- | doc/man/man3/tqsound.3qt | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/doc/man/man3/tqsound.3qt b/doc/man/man3/tqsound.3qt index f960c5458..55de15e95 100644 --- a/doc/man/man3/tqsound.3qt +++ b/doc/man/man3/tqsound.3qt @@ -1,5 +1,5 @@ '\" t -.TH QSound 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQSound 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,19 +7,19 @@ .ad l .nh .SH NAME -QSound \- Access to the platform audio facilities +TQSound \- Access to the platform audio facilities .SH SYNOPSIS -\fC#include <ntqsound.h>\fR +\fC#include <tqsound.h>\fR .PP Inherits TQObject. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQSound\fR ( const TQString & filename, TQObject * parent = 0, const char * name = 0 )" +.BI "\fBTQSound\fR ( const TQString & filename, TQObject * parent = 0, const char * name = 0 )" .br .ti -1c -.BI "\fB~QSound\fR ()" +.BI "\fB~TQSound\fR ()" .br .ti -1c .BI "int \fBloops\fR () const" @@ -59,21 +59,21 @@ Inherits TQObject. .br .in -1c .SH DESCRIPTION -The QSound class provides access to the platform audio facilities. +The TQSound class provides access to the platform audio facilities. .PP Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most easily accomplished with a single call: .PP .nf .br - QSound::play("mysounds/bells.wav"); + TQSound::play("mysounds/bells.wav"); .br .fi .PP -A second API is provided in which a QSound object is created from a sound file and is played later: +A second API is provided in which a TQSound object is created from a sound file and is played later: .PP .nf .br - QSound bells("mysounds/bells.wav"); + TQSound bells("mysounds/bells.wav"); .br .br bells.play(); @@ -88,51 +88,51 @@ On X11 the Network Audio System is used if available, otherwise all operations w .PP On Macintosh, ironically, we use QT (QuickTime) for sound, this means all QuickTime formats are supported by Qt/Mac. .PP -The availability of sound can be tested with QSound::isAvailable(). +The availability of sound can be tested with TQSound::isAvailable(). .PP See also Multimedia Classes. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QSound::QSound ( const TQString & filename, TQObject * parent = 0, const char * name = 0 )" -Constructs a QSound that can quickly play the sound in a file named \fIfilename\fR. +.SH "TQSound::TQSound ( const TQString & filename, TQObject * parent = 0, const char * name = 0 )" +Constructs a TQSound that can quickly play the sound in a file named \fIfilename\fR. .PP This may use more memory than the static \fCplay\fR function. .PP The \fIparent\fR and \fIname\fR arguments (default 0) are passed on to the TQObject constructor. -.SH "QSound::~QSound ()" +.SH "TQSound::~TQSound ()" Destroys the sound object. If the sound is not finished playing stop() is called on it. .PP See also stop() and isFinished(). -.SH "bool QSound::available ()\fC [static]\fR" +.SH "bool TQSound::available ()\fC [static]\fR" Returns TRUE if sound support is available; otherwise returns FALSE. -.SH "TQString QSound::fileName () const" +.SH "TQString TQSound::fileName () const" Returns the filename associated with the sound. -.SH "bool QSound::isAvailable ()\fC [static]\fR" +.SH "bool TQSound::isAvailable ()\fC [static]\fR" Returns TRUE if sound facilities exist on the platform; otherwise returns FALSE. An application may choose either to notify the user if sound is crucial to the application or to operate silently without bothering the user. .PP -If no sound is available, all QSound operations work silently and quickly. -.SH "bool QSound::isFinished () const" +If no sound is available, all TQSound operations work silently and quickly. +.SH "bool TQSound::isFinished () const" Returns TRUE if the sound has finished playing; otherwise returns FALSE. .PP \fBWarning:\fR On Windows this function always returns TRUE for unlooped sounds. -.SH "int QSound::loops () const" +.SH "int TQSound::loops () const" Returns the number of times the sound will play. -.SH "int QSound::loopsRemaining () const" +.SH "int TQSound::loopsRemaining () const" Returns the number of times the sound will loop. This value decreases each time the sound loops. -.SH "void QSound::play ( const TQString & filename )\fC [static]\fR" +.SH "void TQSound::play ( const TQString & filename )\fC [static]\fR" Plays the sound in a file called \fIfilename\fR. .PP Example: sound/sound.cpp. -.SH "void QSound::play ()\fC [slot]\fR" +.SH "void TQSound::play ()\fC [slot]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Starts the sound playing. The function returns immediately. Depending on the platform audio facilities, other sounds may stop or may be mixed with the new sound. .PP The sound can be played again at any time, possibly mixing or replacing previous plays of the sound. -.SH "void QSound::setLoops ( int l )" +.SH "void TQSound::setLoops ( int l )" Sets the sound to repeat \fIl\fR times when it is played. Passing the value -1 will cause the sound to loop indefinitely. .PP See also loops(). -.SH "void QSound::stop ()\fC [slot]\fR" +.SH "void TQSound::stop ()\fC [slot]\fR" Stops the sound playing. .PP On Windows the current loop will finish if a sound is played in a loop. @@ -140,7 +140,7 @@ On Windows the current loop will finish if a sound is played in a loop. See also play(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsound.html +.BR http://doc.trolltech.com/tqsound.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |