kde-playground/kdepimlibs/kabc/sound.h

/*
    This file is part of libkabc.
    Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KABC_SOUND_H
#define KABC_SOUND_H

#include "kabc_export.h"
#include <QtCore/QString>
#include <QtCore/QSharedDataPointer>

namespace KABC {

/** @short Class that holds a Sound clip for a contact.
 *
 *  The sound can be played doing something like this:
 *
 *  \code
 *    KTempFile tmp;
 *    if ( sound.isIntern() ) {
 *      tmp.file()->write( sound.data() );
 *      tmp.close();
 *      KAudioPlayer::play( tmp.name() );
 *    } else if( !sound.url().isEmpty() ) {
 *      QString tmpFile;
 *      if ( !KIO::NetAccess::download( KUrl( themeURL.url() ), tmpFile, 0 ) ) {
 *        KMessageBox::error( 0,
 *                            KIO::NetAccess::lastErrorString(),
 *                            i18n( "Failed to download sound file" ),
 *                            KMessageBox::Notify
 *                          );
 *        return;
 *      }
 *      KAudioPlayer::play( tmpFile );
 *    }
 *  \endcode
 *
 *  Unfortunately, KAudioPlayer::play is ASync, so to delete the temporary file
 *  the best you can really do is set a timer.
 *
 */
class KABC_EXPORT Sound
{
    friend KABC_EXPORT QDataStream &operator<<( QDataStream &, const Sound & );
    friend KABC_EXPORT QDataStream &operator>>( QDataStream &, Sound & );

  public:

    /**
     * Creates an empty sound object.
     */
    Sound();

    /**
     * Creates a sound object for the given url.
     *
     * @param url A url that describes the position of the sound file.
     */
    Sound( const QString &url );

    /**
     * Creates a sound object for the given data.
     *
     * @param data The raw data of the sound.
     */
    Sound( const QByteArray &data );

    /**
     * Copy constructor.
     */
    Sound( const Sound &other );

    /**
     * Destroys the sound object.
     */
    ~Sound();

    /**
     * Assignment operator.
     *
     * @param other The sound object to assign to @c this
     */
    Sound &operator=( const Sound &other );

    /**
     * Equality operator.
     *
     * @param other The object to compare with
     *
     * @return @c true if the two objects are equal, otherwise @c false
     */
    bool operator==( const Sound &other ) const;

    /**
     * Not-Equal operator.
     *
     * @param other The object to compare with
     *
     * @return @c true if the two objects are not equal, otherwise @c false
     */
    bool operator!=( const Sound &other ) const;

    /**
     * Sets a URL for the location of the sound file. When using this
     * function, isIntern() will return 'false' until you use
     * setData().
     *
     * @param url  The location URL of the sound file.
     */
    void setUrl( const QString &url );

    /**
     * Returns true, if the sound object is empty.
     */
    bool isEmpty() const;

    /**
     * Sets the raw data of the sound. When using this function,
     * isIntern() will return 'true' until you use setUrl().
     *
     * @param data  The raw data of the sound.
     */
    void setData( const QByteArray &data );

    /**
     * Returns whether the sound is described by a URL (extern) or
     * by the raw data (intern).
     * When this method returns 'true' you can use data() to
     * get the raw data. Otherwise you can request the URL of this
     * sound by url() and load the raw data from that location.
     */
    bool isIntern() const;

    /**
     * Returns the location URL of this sound.
     */
    QString url() const;

    /**
     * Returns the raw data of this sound.
     */
    QByteArray data() const;

    /**
     * Returns string representation of the sound.
     */
    QString toString() const;

  private:
    class Private;
    QSharedDataPointer<Private> d;
};

/**
 * Serializes the @p sound object into the @p stream.
 */
KABC_EXPORT QDataStream &operator<<( QDataStream &stream, const Sound &sound );

/**
 * Initializes the @p sound object from the @p stream.
 */
KABC_EXPORT QDataStream &operator>>( QDataStream &stream, Sound &sound );

}

#endif