• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
agentactionmanager.h
1/*
2 Copyright (c) 2010 Tobias Koenig <tokoe@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_AGENTACTIONMANAGER_H
21#define AKONADI_AGENTACTIONMANAGER_H
22
23#include "akonadi_export.h"
24
25#include <akonadi/agentinstance.h>
26
27#include <QtCore/QObject>
28
29class KAction;
30class KActionCollection;
31class KLocalizedString;
32class QItemSelectionModel;
33class QWidget;
34
35namespace Akonadi {
36
43class AKONADI_EXPORT AgentActionManager : public QObject
44{
45 Q_OBJECT
46public:
50 enum Type {
51 CreateAgentInstance,
52 DeleteAgentInstance,
53 ConfigureAgentInstance,
54 LastType
55 };
56
60 enum TextContext {
61 DialogTitle,
62 DialogText,
63 MessageBoxTitle,
64 MessageBoxText,
65 MessageBoxAlternativeText,
66 ErrorMessageTitle,
67 ErrorMessageText
68 };
69
76 explicit AgentActionManager(KActionCollection *actionCollection, QWidget *parent = 0);
77
81 ~AgentActionManager();
82
88 void setSelectionModel(QItemSelectionModel *model);
89
93 void setMimeTypeFilter(const QStringList &mimeTypes);
94
98 void setCapabilityFilter(const QStringList &capabilities);
99
106 KAction *createAction(Type type);
107
112 void createAllActions();
113
117 KAction *action(Type type) const;
118
128 void interceptAction(Type type, bool intercept = true);
129
136 Akonadi::AgentInstance::List selectedAgentInstances() const;
137
147 void setContextText(Type type, TextContext context, const QString &text);
148
157 void setContextText(Type type, TextContext context, const KLocalizedString &text);
158
159Q_SIGNALS:
165 void actionStateUpdated();
166
167private:
168 //@cond PRIVATE
169 class Private;
170 Private *const d;
171
172 Q_PRIVATE_SLOT(d, void updateActions())
173
174 Q_PRIVATE_SLOT(d, void slotCreateAgentInstance())
175 Q_PRIVATE_SLOT(d, void slotDeleteAgentInstance())
176 Q_PRIVATE_SLOT(d, void slotConfigureAgentInstance())
177
178 Q_PRIVATE_SLOT(d, void slotAgentInstanceCreationResult(KJob *))
179 //@endcond
180};
181
182}
183
184#endif
Akonadi::AgentActionManager
Manages generic actions for agent and agent instance views.
Definition: agentactionmanager.h:44
Akonadi::AgentActionManager::AgentActionManager
AgentActionManager(KActionCollection *actionCollection, QWidget *parent=0)
Creates a new agent action manager.
Akonadi::AgentActionManager::selectedAgentInstances
Akonadi::AgentInstance::List selectedAgentInstances() const
Returns the list of agent instances that are currently selected.
Akonadi::AgentActionManager::setContextText
void setContextText(Type type, TextContext context, const KLocalizedString &text)
Sets the text of the action type for the given context.
Akonadi::AgentActionManager::actionStateUpdated
void actionStateUpdated()
This signal is emitted whenever the action state has been updated.
Akonadi::AgentActionManager::action
KAction * action(Type type) const
Returns the action of the given type, 0 if it has not been created (yet).
Akonadi::AgentActionManager::interceptAction
void interceptAction(Type type, bool intercept=true)
Sets whether the default implementation for the given action type shall be executed when the action i...
Akonadi::AgentActionManager::Type
Type
Describes the supported actions.
Definition: agentactionmanager.h:50
Akonadi::AgentActionManager::CreateAgentInstance
@ CreateAgentInstance
Creates an agent instance.
Definition: agentactionmanager.h:51
Akonadi::AgentActionManager::ConfigureAgentInstance
@ ConfigureAgentInstance
Configures the selected agent instance.
Definition: agentactionmanager.h:53
Akonadi::AgentActionManager::DeleteAgentInstance
@ DeleteAgentInstance
Deletes the selected agent instance.
Definition: agentactionmanager.h:52
Akonadi::AgentActionManager::createAction
KAction * createAction(Type type)
Creates the action of the given type and adds it to the action collection specified in the constructo...
Akonadi::AgentActionManager::setMimeTypeFilter
void setMimeTypeFilter(const QStringList &mimeTypes)
Sets the mime type filter that will be used when creating new agent instances.
Akonadi::AgentActionManager::setContextText
void setContextText(Type type, TextContext context, const QString &text)
Sets the text of the action type for the given context.
Akonadi::AgentActionManager::~AgentActionManager
~AgentActionManager()
Destroys the agent action manager.
Akonadi::AgentActionManager::setSelectionModel
void setSelectionModel(QItemSelectionModel *model)
Sets the agent selection model based on which the actions should operate.
Akonadi::AgentActionManager::createAllActions
void createAllActions()
Convenience method to create all standard actions.
Akonadi::AgentActionManager::TextContext
TextContext
Describes the text context that can be customized.
Definition: agentactionmanager.h:60
Akonadi::AgentActionManager::DialogTitle
@ DialogTitle
The window title of a dialog.
Definition: agentactionmanager.h:61
Akonadi::AgentActionManager::MessageBoxAlternativeText
@ MessageBoxAlternativeText
An alternative text of a message box.
Definition: agentactionmanager.h:65
Akonadi::AgentActionManager::DialogText
@ DialogText
The text of a dialog.
Definition: agentactionmanager.h:62
Akonadi::AgentActionManager::MessageBoxText
@ MessageBoxText
The text of a message box.
Definition: agentactionmanager.h:64
Akonadi::AgentActionManager::ErrorMessageTitle
@ ErrorMessageTitle
The window title of an error message.
Definition: agentactionmanager.h:66
Akonadi::AgentActionManager::MessageBoxTitle
@ MessageBoxTitle
The window title of a message box.
Definition: agentactionmanager.h:63
Akonadi::AgentActionManager::setCapabilityFilter
void setCapabilityFilter(const QStringList &capabilities)
Sets the capability filter that will be used when creating new agent instances.
Akonadi::AgentInstance::List
QList< AgentInstance > List
Describes a list of agent instances.
Definition: agentinstance.h:71
Akonadi
FreeBusyManager::Singleton.
Definition: actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal