QTfrontend/ui/widget/FreqSpinBox.h
author wuzzy
Sun, 22 Dec 2013 08:37:10 -0500
changeset 9813 4132b0bfcac5
parent 9080 9b42757d7e71
child 9998 736015b847e3
permissions -rw-r--r--
add a preliminary description

/*
 * Hedgewars, a free turn based strategy game
 * Copyright (c) 2004-2013 Andrey Korotaev <unC0Rr@gmail.com>
 *
 * 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; version 2 of the License
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
 */

/**
 * @file
 * @brief FreqSpinBox class definition
 */

#ifndef HEDGEWARS_FREQSPINBOX_H
#define HEDGEWARS_FREQSPINBOX_H

#include <QObject>
#include <QSpinBox>

/**
 * <code>SpinBox</code> that returns its value as localized turn frequency.
 * 'Never', 'Every Turn', 'Every 2 Turns', etc.
 * @author unc0rr
 * @since  0.9.12
 */
class FreqSpinBox : public QSpinBox
{
        Q_OBJECT

    public:
        /**
         * @brief Class constructor.
         * @param parent parent widget.
         */
        FreqSpinBox(QWidget * parent);

    protected:
        /**
         * Returns it's value as localized frequency.
         * 'Never', 'Every Turn', 'Every 2 Turns', etc.
         * @param value integer value to be representing as string.
         * @return the turn frequence-like string representation.
         */
        QString textFromValue(int value) const;
};


#endif // HEDGEWARS_FREQSPINBOX_H