kalarm/reminder.cpp

   1 /*
   2  *  reminder.cpp  -  reminder setting widget
   3  *  Program:  kalarm
   4  *  Copyright © 2003-2005,2007-2009 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 <QVBoxLayout>
  24 #include <QHBoxLayout>
  25
  26 #include <kglobal.h>
  27 #include <klocale.h>
  28 #include <kdialog.h>
  29 #include <kdatetime.h>
  30 #include <kdebug.h>
  31 #include <kcal/duration.h>
  32
  33 #include "preferences.h"
  34 #include "checkbox.h"
  35 #include "timeselector.h"
  36 #include "reminder.moc"
  37
  38
  39 // Collect these widget labels together to ensure consistent wording and
  40 // translations across different modules.
  41 QString Reminder::i18n_chk_FirstRecurrenceOnly()   { return i18nc("@option:check", "Reminder for first recurrence only"); }
  42
  43
  44 Reminder::Reminder(const QString& reminderWhatsThis, const QString& valueWhatsThis,
  45                    bool allowHourMinute, bool showOnceOnly, QWidget* parent)
  46         : QFrame(parent),
  47           mReadOnly(false),
  48           mOnceOnlyEnabled(showOnceOnly)
  49 {
  50         QVBoxLayout* topLayout = new QVBoxLayout(this);
  51         topLayout->setMargin(0);
  52         topLayout->setSpacing(KDialog::spacingHint());
  53
  54         mTime = new TimeSelector(i18nc("@option:check", "Reminder:"), i18nc("@label", "in advance"),
  55                                  reminderWhatsThis, valueWhatsThis, allowHourMinute, this);
  56         mTime->setFixedSize(mTime->sizeHint());
  57         connect(mTime, SIGNAL(toggled(bool)), SLOT(slotReminderToggled(bool)));
  58         connect(mTime, SIGNAL(valueChanged(const KCal::Duration&)), SIGNAL(changed()));
  59         topLayout->addWidget(mTime, 0, Qt::AlignLeft);
  60
  61         if (showOnceOnly)
  62         {
  63                 QHBoxLayout* layout = new QHBoxLayout();
  64                 layout->setMargin(0);
  65                 layout->addSpacing(3*KDialog::spacingHint());
  66                 topLayout->addLayout(layout);
  67                 mOnceOnly = new CheckBox(i18n_chk_FirstRecurrenceOnly(), this);
  68                 mOnceOnly->setFixedSize(mOnceOnly->sizeHint());
  69                 connect(mOnceOnly, SIGNAL(toggled(bool)), SIGNAL(changed()));
  70                 mOnceOnly->setWhatsThis(i18nc("@info:whatsthis", "Display the reminder only before the first time the alarm is scheduled"));
  71                 layout->addWidget(mOnceOnly);
  72                 layout->addStretch();
  73         }
  74         else
  75                 mOnceOnly = 0;
  76 }
  77
  78 /******************************************************************************
  79 *  Set the read-only status.
  80 */
  81 void Reminder::setReadOnly(bool ro)
  82 {
  83         if ((int)ro != (int)mReadOnly)
  84         {
  85                 mReadOnly = ro;
  86                 mTime->setReadOnly(mReadOnly);
  87                 if (mOnceOnly)
  88                         mOnceOnly->setReadOnly(mReadOnly);
  89         }
  90 }
  91
  92 bool Reminder::isReminder() const
  93 {
  94         return mTime->isChecked();
  95 }
  96
  97 bool Reminder::isOnceOnly() const
  98 {
  99         return mOnceOnly  &&  mOnceOnly->isEnabled()  &&  mOnceOnly->isChecked();
 100 }
 101
 102 void Reminder::setOnceOnly(bool onceOnly)
 103 {
 104         if (mOnceOnly)
 105                 mOnceOnly->setChecked(onceOnly);
 106 }
 107
 108 /******************************************************************************
 109 *  Specify whether the once-only checkbox is allowed to be enabled.
 110 */
 111 void Reminder::enableOnceOnly(bool enable)
 112 {
 113         if (mOnceOnly)
 114         {
 115                 mOnceOnlyEnabled = enable;
 116                 mOnceOnly->setEnabled(enable && mTime->isChecked());
 117         }
 118 }
 119
 120 void Reminder::setMaximum(int hourmin, int days)
 121 {
 122         mTime->setMaximum(hourmin, days);
 123 }
 124
 125 /******************************************************************************
 126  * Get the specified number of minutes in advance of the main alarm the
 127  * reminder is to be.
 128  */
 129 int Reminder::minutes() const
 130 {
 131         return mTime->period().asSeconds() / 60;
 132 }
 133
 134 /******************************************************************************
 135 *  Initialise the controls with a specified reminder time.
 136 */
 137 void Reminder::setMinutes(int minutes, bool dateOnly)
 138 {
 139         KCal::Duration period;
 140         if (minutes % (24*60))
 141                 period = KCal::Duration(minutes * 60, KCal::Duration::Seconds);
 142         else
 143                 period = KCal::Duration(minutes / (24*60), KCal::Duration::Days);
 144         mTime->setPeriod(period, dateOnly, Preferences::defaultReminderUnits());
 145 }
 146
 147 /******************************************************************************
 148 *  Set the advance reminder units to days if "Any time" is checked.
 149 */
 150 void Reminder::setDateOnly(bool dateOnly)
 151 {
 152         mTime->setDateOnly(dateOnly);
 153 }
 154
 155 /******************************************************************************
 156 *  Set the input focus on the count field.
 157 */
 158 void Reminder::setFocusOnCount()
 159 {
 160         mTime->setFocusOnCount();
 161 }
 162
 163 /******************************************************************************
 164 *  Called when the Reminder checkbox is toggled.
 165 */
 166 void Reminder::slotReminderToggled(bool on)
 167 {
 168         if (mOnceOnly)
 169                 mOnceOnly->setEnabled(on && mOnceOnlyEnabled);
 170 }
 171
 172 /******************************************************************************
 173 * Called when the start time relating to the reminder has changed.
 174 * Sets the default reminder time units appropriately, if no reminder time is
 175 * currently set.
 176 */
 177 void Reminder::setDefaultUnits(const KDateTime& dt)
 178 {
 179         if (mTime->isChecked())
 180                 return;   // don't change units if reminder is already set
 181         TimePeriod::Units units;
 182         TimePeriod::Units currentUnits = mTime->units();
 183         if (KDateTime::currentDateTime(dt.timeSpec()).daysTo(dt) < 7)
 184         {
 185                 if (currentUnits == TimePeriod::Minutes  ||  currentUnits == TimePeriod::HoursMinutes)
 186                         return;
 187                 units = (Preferences::defaultReminderUnits() == TimePeriod::Minutes)
 188                       ? TimePeriod::Minutes : TimePeriod::HoursMinutes;
 189         }
 190         else
 191         {
 192                 if (currentUnits == TimePeriod::Days  ||  currentUnits == TimePeriod::Weeks)
 193                         return;
 194                 units = TimePeriod::Days;
 195         }
 196         mTime->setUnits(units);
 197 }