MessageViewer::ViewerPluginInterface

Search for usage in LXR

MessageViewer::ViewerPluginInterface Class Referenceabstract

#include <viewerplugininterface.h>

Inheritance diagram for MessageViewer::ViewerPluginInterface:

Public Types

enum  SpecificFeatureType {
  None = 0 , NeedSelection = 2 , NeedMessage = 4 , NeedUrl = 8 ,
  All = 16
}
 
typedef QFlags< SpecificFeatureType > SpecificFeatureTypes
 

Signals

void activatePlugin (MessageViewer::ViewerPluginInterface *)
 

Public Member Functions

 ViewerPluginInterface (QObject *parent=nullptr)
 
virtual QList< QAction * > actions () const
 
virtual void closePlugin ()
 
virtual void execute ()
 
virtual ViewerPluginInterface::SpecificFeatureTypes featureTypes () const =0
 
virtual void refreshActionList (KActionCollection *ac)
 
virtual void setCurrentCollection (const Akonadi::Collection &col)
 
virtual void setMessage (const KMime::Message::Ptr &value)
 
virtual void setMessageItem (const Akonadi::Item &item)
 
virtual void setText (const QString &text)
 
virtual void setUrl (const QUrl &url)
 
virtual void updateAction (const Akonadi::Item &item)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

void slotActivatePlugin ()
 

Protected Member Functions

void addHelpTextAction (QAction *act, const QString &text)
 
virtual void showWidget ()
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

The ViewerPluginInterface class.

Author
Laurent Montel monte.nosp@m.l@kd.nosp@m.e.org

Definition at line 23 of file viewerplugininterface.h.

Member Typedef Documentation

◆ SpecificFeatureTypes

Definition at line 31 of file viewerplugininterface.h.

Member Enumeration Documentation

◆ SpecificFeatureType

enum MessageViewer::ViewerPluginInterface::SpecificFeatureType

Definition at line 29 of file viewerplugininterface.h.

Constructor & Destructor Documentation

◆ ViewerPluginInterface()

ViewerPluginInterface::ViewerPluginInterface ( QObject * parent = nullptr)
explicit

Definition at line 18 of file viewerplugininterface.cpp.

Member Function Documentation

◆ actions()

QList< QAction * > ViewerPluginInterface::actions ( ) const
virtual

Definition at line 37 of file viewerplugininterface.cpp.

◆ addHelpTextAction()

void ViewerPluginInterface::addHelpTextAction ( QAction * act,
const QString & text )
protected

Definition at line 89 of file viewerplugininterface.cpp.

◆ closePlugin()

void ViewerPluginInterface::closePlugin ( )
virtual

Definition at line 67 of file viewerplugininterface.cpp.

◆ execute()

void ViewerPluginInterface::execute ( )
virtual

Definition at line 26 of file viewerplugininterface.cpp.

◆ refreshActionList()

void ViewerPluginInterface::refreshActionList ( KActionCollection * ac)
virtual

Definition at line 83 of file viewerplugininterface.cpp.

◆ setCurrentCollection()

void ViewerPluginInterface::setCurrentCollection ( const Akonadi::Collection & col)
virtual

Definition at line 61 of file viewerplugininterface.cpp.

◆ setMessage()

void ViewerPluginInterface::setMessage ( const KMime::Message::Ptr & value)
virtual

Definition at line 49 of file viewerplugininterface.cpp.

◆ setMessageItem()

void ViewerPluginInterface::setMessageItem ( const Akonadi::Item & item)
virtual

Definition at line 55 of file viewerplugininterface.cpp.

◆ setText()

void ViewerPluginInterface::setText ( const QString & text)
virtual

Definition at line 31 of file viewerplugininterface.cpp.

◆ setUrl()

void ViewerPluginInterface::setUrl ( const QUrl & url)
virtual

Definition at line 43 of file viewerplugininterface.cpp.

◆ showWidget()

void ViewerPluginInterface::showWidget ( )
protectedvirtual

Definition at line 72 of file viewerplugininterface.cpp.

◆ slotActivatePlugin

void ViewerPluginInterface::slotActivatePlugin ( )
protectedslot

Definition at line 94 of file viewerplugininterface.cpp.

◆ updateAction()

void ViewerPluginInterface::updateAction ( const Akonadi::Item & item)
virtual

Definition at line 77 of file viewerplugininterface.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:12:44 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.