specialactions.cpp

/*
 *  specialactions.cpp  -  widget to specify special alarm actions
 *  Program:  kalarm
 *  Copyright © 2004,2005,2007 by David Jarvie <software@astrojar.org.uk>
 *
 *  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.
 */
 
#include "kalarm.h"
 
#include <tqlabel.h>
#include <tqlayout.h>
#include <tqwhatsthis.h>
 
#include <klineedit.h>
#include <tdeapplication.h>
#include <tdeaboutdata.h>
#include <tdelocale.h>
#include <kdebug.h>
 
#include "functions.h"
#include "shellprocess.h"
#include "specialactions.moc"
 
 
/*=============================================================================
= Class SpecialActionsButton
= Button to display the Special Alarm Actions dialogue.
=============================================================================*/
 
SpecialActionsButton::SpecialActionsButton(const TQString& caption, TQWidget* parent, const char* name)
    : TQPushButton(caption, parent, name),
      mReadOnly(false)
{
    setToggleButton(true);
    setOn(false);
    connect(this, TQ_SIGNAL(clicked()), TQ_SLOT(slotButtonPressed()));
    TQWhatsThis::add(this,
          i18n("Specify actions to execute before and after the alarm is displayed."));
}
 
/******************************************************************************
*  Set the pre- and post-alarm actions.
*  The button's pressed state is set to reflect whether any actions are set.
*/
void SpecialActionsButton::setActions(const TQString& pre, const TQString& post)
{
    mPreAction  = pre;
    mPostAction = post;
    setOn(!mPreAction.isEmpty() || !mPostAction.isEmpty());
}
 
/******************************************************************************
*  Called when the OK button is clicked.
*  Display a font and colour selection dialog and get the selections.
*/
void SpecialActionsButton::slotButtonPressed()
{
    SpecialActionsDlg dlg(mPreAction, mPostAction,
                      i18n("Special Alarm Actions"), this, "actionsDlg");
    dlg.setReadOnly(mReadOnly);
    if (dlg.exec() == TQDialog::Accepted)
    {
        mPreAction  = dlg.preAction();
        mPostAction = dlg.postAction();
        emit selected();
    }
    setOn(!mPreAction.isEmpty() || !mPostAction.isEmpty());
}
 
 
/*=============================================================================
= Class SpecialActionsDlg
= Pre- and post-alarm actions dialogue.
=============================================================================*/
 
static const char SPEC_ACT_DIALOG_NAME[] = "SpecialActionsDialog";
 
 
SpecialActionsDlg::SpecialActionsDlg(const TQString& preAction, const TQString& postAction,
                                     const TQString& caption, TQWidget* parent, const char* name)
    : KDialogBase(parent, name, true, caption, Ok|Cancel, Ok, false)
{
    TQWidget* page = new TQWidget(this);
    setMainWidget(page);
    TQVBoxLayout* layout = new TQVBoxLayout(page, 0, spacingHint());
 
    mActions = new SpecialActions(page);
    mActions->setActions(preAction, postAction);
    layout->addWidget(mActions);
    layout->addSpacing(KDialog::spacingHint());
 
    TQSize s;
    if (KAlarm::readConfigWindowSize(SPEC_ACT_DIALOG_NAME, s))
        resize(s);
}
 
/******************************************************************************
*  Called when the OK button is clicked.
*/
void SpecialActionsDlg::slotOk()
{
    if (mActions->isReadOnly())
        reject();
    accept();
}
 
/******************************************************************************
*  Called when the dialog's size has changed.
*  Records the new size in the config file.
*/
void SpecialActionsDlg::resizeEvent(TQResizeEvent* re)
{
    if (isVisible())
        KAlarm::writeConfigWindowSize(SPEC_ACT_DIALOG_NAME, re->size());
    KDialog::resizeEvent(re);
}
 
 
/*=============================================================================
= Class SpecialActions
= Pre- and post-alarm actions widget.
=============================================================================*/
 
SpecialActions::SpecialActions(TQWidget* parent, const char* name)
    : TQWidget(parent, name),
      mReadOnly(false)
{
    TQBoxLayout* topLayout = new TQVBoxLayout(this, 0, KDialog::spacingHint());
 
    // Pre-alarm action
    TQLabel* label = new TQLabel(i18n("Pre-a&larm action:"), this);
    label->setFixedSize(label->sizeHint());
    topLayout->addWidget(label, 0, TQt::AlignAuto);
 
    mPreAction = new KLineEdit(this);
    label->setBuddy(mPreAction);
    TQWhatsThis::add(mPreAction,
          i18n("Enter a shell command to execute before the alarm is displayed.\n"
                   "Note that it is executed only when the alarm proper is displayed, not when a reminder or deferred alarm is displayed.\n"
               "N.B. KAlarm will wait for the command to complete before displaying the alarm."));
    topLayout->addWidget(mPreAction);
    topLayout->addSpacing(KDialog::spacingHint());
 
    // Post-alarm action
    label = new TQLabel(i18n("Post-alar&m action:"), this);
    label->setFixedSize(label->sizeHint());
    topLayout->addWidget(label, 0, TQt::AlignAuto);
 
    mPostAction = new KLineEdit(this);
    label->setBuddy(mPostAction);
    TQWhatsThis::add(mPostAction,
          i18n("Enter a shell command to execute after the alarm window is closed.\n"
               "Note that it is not executed after closing a reminder window. If you defer "
               "the alarm, it is not executed until the alarm is finally acknowledged or closed."));
    topLayout->addWidget(mPostAction);
}
 
void SpecialActions::setActions(const TQString& pre, const TQString& post)
{
    mPreAction->setText(pre);
    mPostAction->setText(post);
}
 
TQString SpecialActions::preAction() const
{
    return mPreAction->text();
}
 
TQString SpecialActions::postAction() const
{
    return mPostAction->text();
}
 
void SpecialActions::setReadOnly(bool ro)
{
    mReadOnly = ro;
    mPreAction->setReadOnly(mReadOnly);
    mPostAction->setReadOnly(mReadOnly);
}