mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-23 18:32:51 +00:00
144 lines
4 KiB
C++
144 lines
4 KiB
C++
/*
|
|
Copyright (c) 2006-2008 Tobias Koenig <tokoe@kde.org>
|
|
Copyright (c) 2012 Laurent Montel <montel@kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU Library General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or (at your
|
|
option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
|
|
License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef AKONADI_AGENTINSTANCEWIDGET_H
|
|
#define AKONADI_AGENTINSTANCEWIDGET_H
|
|
|
|
#include "akonadi_export.h"
|
|
|
|
#include <QWidget>
|
|
|
|
#include <QAbstractItemView>
|
|
namespace Akonadi {
|
|
|
|
class AgentInstance;
|
|
class AgentFilterProxyModel;
|
|
|
|
/**
|
|
* @short Provides a widget that lists all available agent instances.
|
|
*
|
|
* The widget is listening on the dbus for changes, so the
|
|
* widget is updated automatically as soon as new agent instances
|
|
* are added to or removed from the system.
|
|
*
|
|
* @code
|
|
*
|
|
* MyWidget::MyWidget( QWidget *parent )
|
|
* : QWidget( parent )
|
|
* {
|
|
* QVBoxLayout *layout = new QVBoxLayout( this );
|
|
*
|
|
* mAgentInstanceWidget = new Akonadi::AgentInstanceWidget( this );
|
|
* layout->addWidget( mAgentInstanceWidget );
|
|
*
|
|
* connect( mAgentInstanceWidget, SIGNAL(doubleClicked(Akonadi::AgentInstance)),
|
|
* this, SLOT(slotInstanceSelected(Akonadi::AgentInstance)) );
|
|
* }
|
|
*
|
|
* ...
|
|
*
|
|
* MyWidget::slotInstanceSelected( Akonadi::AgentInstance &instance )
|
|
* {
|
|
* qDebug() << "Selected instance" << instance.name();
|
|
* }
|
|
*
|
|
* @endcode
|
|
*
|
|
* @author Tobias Koenig <tokoe@kde.org>
|
|
*/
|
|
class AKONADI_EXPORT AgentInstanceWidget : public QWidget
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
* Creates a new agent instance widget.
|
|
*
|
|
* @param parent The parent widget.
|
|
*/
|
|
explicit AgentInstanceWidget(QWidget *parent = 0);
|
|
|
|
/**
|
|
* Destroys the agent instance widget.
|
|
*/
|
|
~AgentInstanceWidget();
|
|
|
|
/**
|
|
* Returns the current agent instance or an invalid agent instance
|
|
* if no agent instance is selected.
|
|
*/
|
|
AgentInstance currentAgentInstance() const;
|
|
|
|
/**
|
|
* Returns the selected agent instances.
|
|
* @since 4.5
|
|
*/
|
|
QList<AgentInstance> selectedAgentInstances() const;
|
|
|
|
/**
|
|
* Returns the agent filter proxy model, use this to filter by
|
|
* agent mimetype or capabilities.
|
|
*/
|
|
AgentFilterProxyModel *agentFilterProxyModel() const;
|
|
|
|
/**
|
|
* Returns the view used in the widget.
|
|
* @since 4.5
|
|
*/
|
|
QAbstractItemView *view() const;
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* This signal is emitted whenever the current agent instance changes.
|
|
*
|
|
* @param current The current agent instance.
|
|
* @param previous The previous agent instance.
|
|
*/
|
|
void currentChanged(const Akonadi::AgentInstance ¤t, const Akonadi::AgentInstance &previous);
|
|
|
|
/**
|
|
* This signal is emitted whenever there is a double click on an agent instance.
|
|
*
|
|
* @param current The current agent instance.
|
|
*/
|
|
void doubleClicked(const Akonadi::AgentInstance ¤t);
|
|
|
|
/**
|
|
* This signal is emitted whenever there is a click on an agent instance.
|
|
*
|
|
* @param current The current agent instance.
|
|
* @since 4.9.1
|
|
*/
|
|
void clicked(const Akonadi::AgentInstance ¤t);
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
class Private;
|
|
Private *const d;
|
|
|
|
Q_PRIVATE_SLOT(d, void currentAgentInstanceChanged(const QModelIndex &, const QModelIndex &))
|
|
Q_PRIVATE_SLOT(d, void currentAgentInstanceDoubleClicked(const QModelIndex &))
|
|
Q_PRIVATE_SLOT(d, void currentAgentInstanceClicked(const QModelIndex ¤tIndex))
|
|
//@endcond
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|