kopete/libkopete/kopeteinfoevent.h

   1 /*
   2     kopeteinfoevent.h - Kopete Info Event
   3
   4     Copyright (c) 2008      by Roman Jarosz          <kedgedev@centrum.cz>
   5     Kopete    (c) 2008      by the Kopete developers <kopete-devel@kde.org>
   6
   7     *************************************************************************
   8     *                                                                       *
   9     * This library is free software; you can redistribute it and/or         *
  10     * modify it under the terms of the GNU Lesser General Public            *
  11     * License as published by the Free Software Foundation; either          *
  12     * version 2 of the License, or (at your option) any later version.      *
  13     *                                                                       *
  14     *************************************************************************
  15 */
  16 #ifndef KOPETEINFOEVENT_H
  17 #define KOPETEINFOEVENT_H
  18
  19 #include <QObject>
  20 #include <QMap>
  21
  22 #include "kopete_export.h"
  23
  24 namespace Kopete {
  25
  26 /**
  27  * Base class for all Info Events
  28  *
  29  * The info event will be shown in non-intrusive way
  30  * to user in Kopete Main Window.
  31  *
  32  * You have to use sendEvent to show the event.
  33  *
  34  * The pointer is automatically deleted when the event is closed.
  35  *
  36  *      @author Roman Jarosz <kedgedev@centrum.cz>
  37  */
  38 class KOPETE_EXPORT InfoEvent : public QObject
  39 {
  40 Q_OBJECT
  41 public:
  42         InfoEvent( QObject *parent = 0 );
  43
  44         ~InfoEvent();
  45
  46         /**
  47          * @return the Info Event title
  48          */
  49         QString title() const;
  50
  51         /**
  52          * Set the Info Event title.
  53          * @param title the title
  54          */
  55         void setTitle( const QString& title );
  56
  57         /**
  58          * @return the Info Event text
  59          */
  60         QString text() const;
  61
  62         /**
  63          * Set the Info Event text.
  64          *
  65          * The text is shown in a QLabel, you should make sure to escape any html that is needed.
  66          * You can use some of the qt basic html tags.
  67          *
  68          * This text will also be shown in KNotification popup
  69          *
  70          * @param text the text
  71          */
  72         void setText( const QString& text );
  73
  74         /**
  75          * @return the additional text
  76          */
  77         QString additionalText() const;
  78
  79         /**
  80          * Set the additional text.
  81          *
  82          * This is only shown in InfoEditWidget
  83          *
  84          * @param text the additional text
  85          */
  86         void setAdditionalText( const QString& text );
  87
  88         /**
  89          * @return the list of actions
  90          */
  91         QMap<uint, QString> actions() const;
  92
  93         /**
  94          * Set the list of actions link.
  95          * @param actions the list of actions
  96          */
  97         void addAction( uint actionId, const QString& actionText );
  98
  99 public Q_SLOTS:
 100         /**
 101          * Emit the event.
 102          */
 103         virtual void sendEvent();
 104
 105         /**
 106          * Activate the action specified action
 107          */
 108         virtual void activate( uint actionId );
 109
 110         /**
 111          * Close the info event.
 112          *
 113          * This will delete the info event.
 114          */
 115         void close();
 116
 117 Q_SIGNALS:
 118         /**
 119          * A action has been activated. This signal is only emitted if
 120          * activate( uint ) is not replaced.
 121          * @param actionId is the id of the activated action.
 122          */
 123         void actionActivated( uint actionId );
 124
 125         /**
 126          * Emitted when the info event is closed.
 127          */
 128         void eventClosed( Kopete::InfoEvent* event );
 129
 130 private:
 131         class Private;
 132         Private *d;
 133
 134 };
 135
 136 }
 137
 138 #endif