KDE 4.2 API Reference kopete/libkopete
Kopete::InfoEvent Class Reference
#include <kopeteinfoevent.h>
Detailed Description
Base class for all Info Events.The info event will be shown in non-intrusive way to user in Kopete Main Window.
You have to use sendEvent to show the event.
The pointer is automatically deleted when the event is closed.
Definition at line 38 of file kopeteinfoevent.h.
Public Slots | |
| virtual void | activate (uint actionId) |
| void | close () |
| virtual void | sendEvent () |
Signals | |
| void | actionActivated (uint actionId) |
| void | eventClosed (Kopete::InfoEvent *event) |
Public Member Functions | |
| QMap< uint, QString > | actions () const |
| void | addAction (uint actionId, const QString &actionText) |
| QString | additionalText () const |
| InfoEvent (QObject *parent=0) | |
| void | setAdditionalText (const QString &text) |
| void | setText (const QString &text) |
| void | setTitle (const QString &title) |
| QString | text () const |
| QString | title () const |
| ~InfoEvent () | |
Constructor & Destructor Documentation
| Kopete::InfoEvent::InfoEvent | ( | QObject * | parent = 0 |
) |
Definition at line 35 of file kopeteinfoevent.cpp.
| Kopete::InfoEvent::~InfoEvent | ( | ) |
Definition at line 41 of file kopeteinfoevent.cpp.
Member Function Documentation
| void Kopete::InfoEvent::actionActivated | ( | uint | actionId | ) | [signal] |
A action has been activated.
This signal is only emitted if activate( uint ) is not replaced.
- Parameters:
-
actionId is the id of the activated action.
| void Kopete::InfoEvent::activate | ( | uint | actionId | ) | [virtual, slot] |
Activate the action specified action.
Reimplemented in Kopete::AddedInfoEvent.
Definition at line 94 of file kopeteinfoevent.cpp.
| void Kopete::InfoEvent::addAction | ( | uint | actionId, | |
| const QString & | actionText | |||
| ) |
Set the list of actions link.
- Parameters:
-
actions the list of actions
Definition at line 89 of file kopeteinfoevent.cpp.
| QString Kopete::InfoEvent::additionalText | ( | ) | const |
| void Kopete::InfoEvent::close | ( | ) | [slot] |
Close the info event.
This will delete the info event.
Definition at line 99 of file kopeteinfoevent.cpp.
| void Kopete::InfoEvent::eventClosed | ( | Kopete::InfoEvent * | event | ) | [signal] |
Emitted when the info event is closed.
| void Kopete::InfoEvent::sendEvent | ( | ) | [virtual, slot] |
Emit the event.
Reimplemented in Kopete::AddedInfoEvent.
Definition at line 49 of file kopeteinfoevent.cpp.
| void Kopete::InfoEvent::setAdditionalText | ( | const QString & | text | ) |
Set the additional text.
This is only shown in InfoEditWidget
- Parameters:
-
text the additional text
Definition at line 79 of file kopeteinfoevent.cpp.
| void Kopete::InfoEvent::setText | ( | const QString & | text | ) |
Set the Info Event text.
The text is shown in a QLabel, you should make sure to escape any html that is needed. You can use some of the qt basic html tags.
This text will also be shown in KNotification popup
- Parameters:
-
text the text
Definition at line 69 of file kopeteinfoevent.cpp.
| void Kopete::InfoEvent::setTitle | ( | const QString & | title | ) |
Set the Info Event title.
- Parameters:
-
title the title
Definition at line 59 of file kopeteinfoevent.cpp.
| QString Kopete::InfoEvent::text | ( | ) | const |
| QString Kopete::InfoEvent::title | ( | ) | const |
The documentation for this class was generated from the following files:
