KDE 4.0 API Reference kopete/libkopete
Kopete::MessageEvent Class Reference
#include <kopetemessageevent.h>
Detailed Description
Kopete::MessageEvent is used when a new messages arrives, it is caught by the UI. It contains just information about the message, and a signal when it is terminated (i.e. the message is read
Definition at line 41 of file kopetemessageevent.h.
Public Types | |
| enum | EventState { Nothing, Applied, Ignored } |
Public Slots | |
| void | apply () |
| void | ignore () |
| void | accept () |
| void | discard () |
Signals | |
| void | done (Kopete::MessageEvent *) |
| void | discarded (Kopete::MessageEvent *event) |
| void | accepted (Kopete::MessageEvent *event) |
Public Member Functions | |
| MessageEvent (const Kopete::Message &, QObject *parent=0L) | |
| ~MessageEvent () | |
| Kopete::Message | message () |
| void | setMessage (const Kopete::Message &message) |
| EventState | state () |
Member Enumeration Documentation
The state of the event.
Nothingmeans that the event has not been accepted or ignoredAppliedif the event has been appliedIgnoredif the event has been ignored
Definition at line 66 of file kopetemessageevent.h.
Constructor & Destructor Documentation
| Kopete::MessageEvent::MessageEvent | ( | const Kopete::Message & | m, | |
| QObject * | parent = 0L | |||
| ) | [explicit] |
Definition at line 40 of file kopetemessageevent.cpp.
| Kopete::MessageEvent::~MessageEvent | ( | ) |
Definition at line 50 of file kopetemessageevent.cpp.
Member Function Documentation
| Kopete::Message Kopete::MessageEvent::message | ( | ) |
| void Kopete::MessageEvent::setMessage | ( | const Kopete::Message & | message | ) |
Sets the message contained in this event.
- Parameters:
-
message The new value for the message
Definition at line 62 of file kopetemessageevent.cpp.
| MessageEvent::EventState Kopete::MessageEvent::state | ( | ) |
Definition at line 67 of file kopetemessageevent.cpp.
| void Kopete::MessageEvent::apply | ( | ) | [slot] |
- Deprecated:
- Use accept() instead to continue the processing of this event once the caller has moved to using MessageHandlers
Definition at line 72 of file kopetemessageevent.cpp.
| void Kopete::MessageEvent::ignore | ( | ) | [slot] |
- Deprecated:
- Use discard() instead to destroy this event once the caller has moved to using MessageHandlers
Definition at line 78 of file kopetemessageevent.cpp.
| void Kopete::MessageEvent::accept | ( | ) | [slot] |
Passes the event to the next handler.
Call this when you've finished processing this event
Definition at line 88 of file kopetemessageevent.cpp.
| void Kopete::MessageEvent::discard | ( | ) | [slot] |
Discards the event.
If this event should not be processed any further, this function should be called to discard it.
Definition at line 93 of file kopetemessageevent.cpp.
| void Kopete::MessageEvent::done | ( | Kopete::MessageEvent * | ) | [signal] |
The event has been processed.
| void Kopete::MessageEvent::discarded | ( | Kopete::MessageEvent * | event | ) | [signal] |
The event has been discarded.
- Parameters:
-
event The event sending the signal.
| void Kopete::MessageEvent::accepted | ( | Kopete::MessageEvent * | event | ) | [signal] |
The event has been accepted by its current handler.
- Parameters:
-
event The event sending the signal.
The documentation for this class was generated from the following files:
