korn/dockeditem.h

   1 /*
   2  * Copyright (C) 2004, Mart Kelder (mart.kde@hccnet.nl)
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18
  19 #ifndef MK_DOCKEDITEM_H
  20 #define MK_DOCKEDITEM_H
  21
  22 /**
  23  * @file
  24  *
  25  * This file contains the class DocketItem.
  26  */
  27
  28 #include "boxcontaineritem.h"
  29
  30 class SystemTray;
  31
  32 class KConfig;
  33
  34 template< class T > class QList;
  35
  36 /**
  37  * This class is an implementation of a BoxContainerItem for the
  38  * systemtray view. If also is a KSystemTray reimplementation.
  39  *
  40  * @see BoxContainerItem
  41  * @author Mart Kelder <mart.kde@hccnet.nl>
  42  */
  43 class DockedItem : public BoxContainerItem
  44 { Q_OBJECT
  45 public:
  46         /**
  47          * This contructor gives all it parameters to its parents.
  48          *
  49          * @param parent the parent window
  50          */
  51         DockedItem( QWidget * parent = 0 );
  52         /**
  53          * Empty destructor; does nothing at the moment
  54          */
  55         ~DockedItem();
  56
  57         /**
  58          * This functions shows the element in the systay.
  59          */
  60         virtual void showBox();
  61
  62         /**
  63          * This functions reads the config. It used the parent
  64          * version for the main things, but it is possible to
  65          * add some configurations over here.
  66          *
  67          * @param config The KConfig-instance which contains the settings of this tray-item.
  68          * @param index The index of the box in the configuration file
  69          */
  70         virtual void readConfig( BoxSettings *config, BoxSettings *config_settings, const int index );
  71
  72 public slots:
  73         /**
  74          * This functions sets the number of messages to be displayed, and warns if there are new messages waiting.
  75          *
  76          * @param count The number of messages waiting
  77          * @param newMessages if true than the settings for displaying new messages will be used.
  78          */
  79         virtual void setCount( const int count, const bool newMessages ) ;
  80
  81         /**
  82          * This function sets the tooltip @p string to a box.
  83          *
  84          * @param string The tooltip to be added.
  85          */
  86         virtual void setTooltip( const QString& string );
  87
  88         /**
  89          * This function displays a passive popup containing some headers of a number of messages.
  90          *
  91          * @param list the list which contains some headers of the new messages
  92          * @param total the total number of messages
  93          * @param date true is the date should also be printed; false otherwise
  94          * @param name the name of the account
  95          */
  96         void slotShowPassivePopup( QList< KornMailSubject >* list, int total, bool date, const QString& name );
  97
  98         /**
  99          * This function displays an error message in a passive popup.
 100          *
 101          * @param error the error string
 102          * @param name the name of the account
 103          */
 104         void slotShowPassivePopup( const QString& error, const QString& name );
 105
 106 protected:
 107         /**
 108          * This function popup's the KMenu inmideately.
 109          */
 110         virtual void doPopup();
 111
 112 private:
 113         void setAnimIcon( const QString& anim );
 114
 115 private:
 116         SystemTray *_systemtray;
 117 };
 118
 119 #endif //MK_DOCKEDITEM_H