kalarm/timeselector.cpp

   1 /*
   2  *  timeselector.cpp  -  widget to optionally set a time period
   3  *  Program:  kalarm
   4  *  Copyright © 2004-2016 by David Jarvie <djarvie@kde.org>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License along
  17  *  with this program; if not, write to the Free Software Foundation, Inc.,
  18  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #include "kalarm.h"
  22
  23 #include "checkbox.h"
  24 #include "combobox.h"
  25 #include "timeselector.h"
  26
  27 #include <QHBoxLayout>
  28 #include "kalarm_debug.h"
  29
  30 using namespace KCalCore;
  31
  32
  33 TimeSelector::TimeSelector(const QString& selectText, const QString& selectWhatsThis,
  34                            const QString& valueWhatsThis, bool allowHourMinute, QWidget* parent)
  35     : QFrame(parent),
  36       mSignWidget(Q_NULLPTR),
  37       mReadOnly(false)
  38 {
  39     QHBoxLayout* layout = new QHBoxLayout(this);
  40     layout->setMargin(0);
  41     mSelect = new CheckBox(selectText, this);
  42     mSelect->setFixedSize(mSelect->sizeHint());
  43     connect(mSelect, &CheckBox::toggled, this, &TimeSelector::selectToggled);
  44     mSelect->setWhatsThis(selectWhatsThis);
  45     layout->addWidget(mSelect);
  46
  47     QWidget* box = new QWidget(this);    // to group widgets for QWhatsThis text
  48     layout->addWidget(box);
  49     QHBoxLayout* boxLayout = new QHBoxLayout(box);
  50     boxLayout->setMargin(0);
  51     mPeriod = new TimePeriod(allowHourMinute, box);
  52     boxLayout->addWidget(mPeriod);
  53     mPeriod->setFixedSize(mPeriod->sizeHint());
  54     mPeriod->setSelectOnStep(false);
  55     connect(mPeriod, &TimePeriod::valueChanged, this, &TimeSelector::periodChanged);
  56     mSelect->setFocusWidget(mPeriod);
  57     mPeriod->setEnabled(false);
  58
  59     box->setWhatsThis(valueWhatsThis);
  60     layout->addStretch();
  61 }
  62
  63 /******************************************************************************
  64 * Create a ComboBox used to select the time period's sign.
  65 * The caller is responsible for populating the ComboBox and handling its value.
  66 */
  67 ComboBox* TimeSelector::createSignCombo()
  68 {
  69     delete mSignWidget;
  70     QWidget* p = mPeriod->parentWidget();
  71     mSignWidget = new ComboBox(p);
  72     mSignWidget = new ComboBox(p);
  73     mSignWidget->setEnabled(mPeriod->isEnabled());
  74     p->layout()->addWidget(mSignWidget);
  75     return mSignWidget;
  76 }
  77
  78 /******************************************************************************
  79 * Set the read-only status.
  80 */
  81 void TimeSelector::setReadOnly(bool ro)
  82 {
  83     if ((int)ro != (int)mReadOnly)
  84     {
  85         mReadOnly = ro;
  86         mSelect->setReadOnly(mReadOnly);
  87         mPeriod->setReadOnly(mReadOnly);
  88         if (mSignWidget)
  89             mSignWidget->setReadOnly(mReadOnly);
  90     }
  91 }
  92
  93 bool TimeSelector::isChecked() const
  94 {
  95     return mSelect->isChecked();
  96 }
  97
  98 void TimeSelector::setChecked(bool on)
  99 {
 100     if (on != mSelect->isChecked())
 101     {
 102         mSelect->setChecked(on);
 103         Q_EMIT valueChanged(period());
 104     }
 105 }
 106
 107 void TimeSelector::setMaximum(int hourmin, int days)
 108 {
 109     mPeriod->setMaximum(hourmin, days);
 110 }
 111
 112 void TimeSelector::setDateOnly(bool dateOnly)
 113 {
 114     mPeriod->setDateOnly(dateOnly);
 115 }
 116
 117 /******************************************************************************
 118  * Get the specified number of minutes.
 119  * Reply = 0 if unselected.
 120  */
 121 Duration TimeSelector::period() const
 122 {
 123     return mSelect->isChecked() ? mPeriod->period() : Duration(0);
 124 }
 125
 126 /******************************************************************************
 127 * Initialise the controls with a specified time period.
 128 * If minutes = 0, it will be deselected.
 129 * The time unit combo-box is initialised to 'defaultUnits', but if 'dateOnly'
 130 * is true, it will never be initialised to hours/minutes.
 131 */
 132 void TimeSelector::setPeriod(const Duration& period, bool dateOnly, TimePeriod::Units defaultUnits)
 133 {
 134     bool havePeriod = !period.isNull();
 135     mSelect->setChecked(havePeriod);
 136     mPeriod->setEnabled(havePeriod);
 137     if (mSignWidget)
 138         mSignWidget->setEnabled(havePeriod);
 139     mPeriod->setPeriod(period, dateOnly, defaultUnits);
 140 }
 141
 142 /******************************************************************************
 143 * Set the input focus on the count field.
 144 */
 145 void TimeSelector::setFocusOnCount()
 146 {
 147     mPeriod->setFocusOnCount();
 148 }
 149
 150 /******************************************************************************
 151 * Called when the TimeSelector checkbox is toggled.
 152 */
 153 void TimeSelector::selectToggled(bool on)
 154 {
 155     mPeriod->setEnabled(on);
 156     if (mSignWidget)
 157         mSignWidget->setEnabled(on);
 158     if (on)
 159         mPeriod->setFocus();
 160     Q_EMIT toggled(on);
 161     Q_EMIT valueChanged(period());
 162 }
 163
 164 /******************************************************************************
 165 * Called when the period value changes.
 166 */
 167 void TimeSelector::periodChanged(const Duration& period)
 168 {
 169     if (mSelect->isChecked())
 170         Q_EMIT valueChanged(period);
 171 }
 172
 173 // vim: et sw=4: