KTextEditor
#include <messageinterface.h>
Public Member Functions | |
MessageInterface () | |
virtual | ~MessageInterface () |
virtual bool | postMessage (Message *message)=0 |
Detailed Description
Message interface for posting interactive Messages to a Document and its Views.
This interface allows to post Messages to a Document. The Message then is shown either the specified View if Message::setView() was called, or in all Views of the Document.
Working with Messages
To post a message, you first have to cast the Document to this interface, and then create a Message. Example:
- See also
- Message
- Since
- KDE 4.11
Definition at line 399 of file messageinterface.h.
Constructor & Destructor Documentation
KTextEditor::MessageInterface::MessageInterface | ( | ) |
Default constructor, for internal use.
Definition at line 179 of file messageinterface.cpp.
|
virtual |
Destructor, for internal use.
Definition at line 184 of file messageinterface.cpp.
Member Function Documentation
Post message
to the Document and its Views.
If multiple Messages are posted, the one with the highest priority is shown first.
Usually, you can simply forget the pointer, as the Message is deleted automatically, once it is processed or the document gets closed.
If the Document does not have a View yet, the Message is queued and shown, once a View for the Document is created.
- Parameters
-
message the message to show
- Returns
- true, if
message
was posted. false, if message == 0.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:52:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.