templatelistview.cpp

/*
 *  templatelistview.cpp  -  widget showing list of alarm templates
 *  Program:  kalarm
 *  Copyright (C) 2004, 2005 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 <tdelocale.h>
#include <kdebug.h>
 
#include "alarmcalendar.h"
#include "functions.h"
#include "templatelistview.moc"
 
 
/*=============================================================================
=  Class: TemplateListView
=  Displays the list of outstanding alarms.
=============================================================================*/
TQValueList<EventListViewBase*>  TemplateListView::mInstanceList;
 
 
TemplateListView::TemplateListView(bool includeCmdAlarms, const TQString& whatsThisText, TQWidget* parent, const char* name)
    : EventListViewBase(parent, name),
      mWhatsThisText(whatsThisText),
      mIconColumn(0),
      mNameColumn(1),
      mExcludeCmdAlarms(!includeCmdAlarms)
{
    addColumn(TQString());          // icon column
    addLastColumn(i18n("Name"));
    setSorting(mNameColumn);           // sort initially by name
    setColumnAlignment(mIconColumn, TQt::AlignHCenter);
    setColumnWidthMode(mIconColumn, TQListView::Maximum);
 
    mInstanceList.append(this);
}
 
TemplateListView::~TemplateListView()
{
    mInstanceList.remove(this);
}
 
/******************************************************************************
*  Add all the templates to the list.
*/
void TemplateListView::populate()
{
    TQValueList<KAEvent> templates = KAlarm::templateList();
    for (TQValueList<KAEvent>::Iterator it = templates.begin();  it != templates.end();  ++it)
        addEntry(*it);
}
 
/******************************************************************************
*  Create a new list item for addEntry().
*/
EventListViewItemBase* TemplateListView::createItem(const KAEvent& event)
{
    return new TemplateListViewItem(this, event);
}
 
/******************************************************************************
*  Returns the TQWhatsThis text for a specified column.
*/
TQString TemplateListView::whatsThisText(int column) const
{
    if (column == mIconColumn)
        return i18n("Alarm type");
    if (column == mNameColumn)
        return i18n("Name of the alarm template");
    return mWhatsThisText;
}
 
 
/*=============================================================================
=  Class: TemplateListViewItem
=  Contains the details of one alarm for display in the TemplateListView.
=============================================================================*/
 
TemplateListViewItem::TemplateListViewItem(TemplateListView* parent, const KAEvent& event)
    : EventListViewItemBase(parent, event)
{
    setLastColumnText();     // set the template name column text
 
    int index;
    switch (event.action())
    {
        case KAAlarm::FILE:     index = 2;  break;
        case KAAlarm::COMMAND:  index = 3;  break;
        case KAAlarm::EMAIL:    index = 4;  break;
        case KAAlarm::MESSAGE:
        default:                index = 1;  break;
    }
    mIconOrder.sprintf("%01u", index);
    setPixmap(templateListView()->iconColumn(), *eventIcon());
}
 
/******************************************************************************
*  Return the alarm summary text.
*/
TQString TemplateListViewItem::lastColumnText() const
{
    return event().templateName();
}
 
/******************************************************************************
*  Return the column sort order for one item in the list.
*/
TQString TemplateListViewItem::key(int column, bool) const
{
    TemplateListView* listView = templateListView();
    if (column == listView->iconColumn())
        return mIconOrder;
    return text(column).lower();
}