soundpicker.h

Go to the documentation of this file.

/*
 *  soundpicker.h  -  widget to select a sound file or a beep
 *  Program:  kalarm
 *  Copyright © 2002,2004-2012 by David Jarvie <djarvie@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef SOUNDPICKER_H
#define SOUNDPICKER_H

#include "preferences.h"

#include <kurl.h>
#include <QFrame>
#include <QString>

class KHBox;
class ComboBox;
class PushButton;


class SoundPicker : public QFrame
{
        Q_OBJECT
    public:
        explicit SoundPicker(QWidget* parent);
        void           set(Preferences::SoundType type, const QString& filename, float volume, float fadeVolume, int fadeSeconds, int repeatPause);
        bool           isReadOnly() const          { return mReadOnly; }
        void           setReadOnly(bool readOnly);
        void           showSpeak(bool show);
        Preferences::SoundType sound() const;
        KUrl           file() const;
        float          volume(float& fadeVolume, int& fadeSeconds) const;
        int            repeatPause() const;
        KUrl           fileSetting() const   { return mFile; }
        bool           repeatPauseSetting() const { return mRepeatPause; }
        static QString browseFile(QString& initialDir, const QString& initialFile = QString());

        static QString i18n_label_Sound();  // text of Sound label
        static QString i18n_combo_None();   // text of None combo box item
        static QString i18n_combo_Beep();   // text of Beep combo box item
        static QString i18n_combo_Speak();  // text of Speak combo box item
        static QString i18n_combo_File();   // text of File combo box item

    signals:
        void           changed();     // emitted when any contents change

    private slots:
        void           slotTypeSelected(int id);
        void           slotPickFile();
        void           setLastType();

    private:
        ComboBox*      mTypeCombo;
        KHBox*         mTypeBox;
        PushButton*    mFilePicker;
        KUrl           mFile;         // sound file to play when alarm is triggered
        float          mVolume;       // volume for file, or < 0 to not set volume
        float          mFadeVolume;   // initial volume for file, or < 0 for no fading
        int            mFadeSeconds;  // fade interval in seconds
        int            mRepeatPause;  // seconds to pause between repetitions of the sound file, or -1 if no repeat
        Preferences::SoundType mLastType;     // last selected sound option
        bool           mSpeakShowing; // Speak option is shown in combo box
        bool           mRevertType;   // reverting to last selected sound option
        bool           mReadOnly;
};

#endif // SOUNDPICKER_H

// vim: et sw=4: