/usr/include/konqsidebarplugin.h is in libkonqsidebarplugin-dev 4:15.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | /* This file is part of the KDE project
Copyright (C) 2001,2002 Joseph Wenninger <jowenn@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 _konqsidebarplugin_h_
#define _konqsidebarplugin_h_
#include <kconfiggroup.h>
#include <QWidget>
#include <kurl.h>
#include <kparts/part.h>
#include <kparts/browserextension.h>
#include <kio/job.h>
#include <kfileitem.h>
#include <kcomponentdata.h>
#ifndef KONQSIDEBARPLUGIN_EXPORT
# if defined(MAKE_KONQSIDEBARPLUGIN_LIB)
/* We are building this library */
# define KONQSIDEBARPLUGIN_EXPORT KDE_EXPORT
# else
/* We are using this library */
# define KONQSIDEBARPLUGIN_EXPORT KDE_IMPORT
# endif
#endif
class KonqSidebarModulePrivate;
/**
* Base class for modules, implemented in plugins.
* This class is exported, make sure you keep BINARY COMPATIBILITY!
* (Alternatively, add a Version key to the plugins desktop file...)
*
* A plugin can instantiate multiple modules, for various configurations.
* Example: the dirtree plugin can create a module for "/", a module for $HOME, etc.
*/
class KONQSIDEBARPLUGIN_EXPORT KonqSidebarModule : public QObject
{
Q_OBJECT
public:
KonqSidebarModule(const KComponentData &componentData,
QObject *parent,
const KConfigGroup& configGroup);
~KonqSidebarModule();
virtual QWidget *getWidget() = 0;
const KComponentData &parentComponentData() const;
KConfigGroup configGroup();
/**
* Enable/disable a standard konqueror action (cut, copy, paste, print)
* See KParts::BrowserExtension::enableAction
*/
void enableCopy(bool enabled);
void enableCut(bool enabled);
void enablePaste(bool enabled);
bool isCopyEnabled() const;
bool isCutEnabled() const;
bool isPasteEnabled() const;
void showPopupMenu(const QPoint &global, const KFileItemList &items,
const KParts::OpenUrlArguments &args = KParts::OpenUrlArguments(),
const KParts::BrowserArguments &browserArgs = KParts::BrowserArguments(),
KParts::BrowserExtension::PopupFlags flags = KParts::BrowserExtension::DefaultPopupItems,
const KParts::BrowserExtension::ActionGroupMap& actionGroups = KParts::BrowserExtension::ActionGroupMap());
protected:
/**
* Called by the sidebar's openUrl. Reimplement this in order to
* follow the navigation happening in konqueror's current view.
*/
virtual void handleURL(const KUrl &url) { Q_UNUSED(url); }
virtual void handlePreview(const KFileItemList & items);
virtual void handlePreviewOnMouseOver(const KFileItem &items); //not used yet
public Q_SLOTS:
void openUrl(const KUrl& url);
void openPreview(const KFileItemList& items);
void openPreviewOnMouseOver(const KFileItem& item); // not used yet
Q_SIGNALS:
void started(KIO::Job *);
void completed();
void setIcon(const QString& icon);
void setCaption(const QString& caption);
/**
* Ask konqueror to open @p url.
*/
void openUrlRequest(const KUrl &url, const KParts::OpenUrlArguments& args = KParts::OpenUrlArguments(),
const KParts::BrowserArguments& browserArgs = KParts::BrowserArguments());
/**
* Ask konqueror to create a new window (or tab, see BrowserArguments) for @p url.
*/
void createNewWindow(const KUrl &url, const KParts::OpenUrlArguments& args = KParts::OpenUrlArguments(),
const KParts::BrowserArguments& browserArgs = KParts::BrowserArguments(),
const KParts::WindowArgs& = KParts::WindowArgs());
/**
* Ask konqueror to show the standard popup menu for the given @p items.
*/
void popupMenu(KonqSidebarModule* module,
const QPoint &global, const KFileItemList &items,
const KParts::OpenUrlArguments &args = KParts::OpenUrlArguments(),
const KParts::BrowserArguments &browserArgs = KParts::BrowserArguments(),
KParts::BrowserExtension::PopupFlags flags = KParts::BrowserExtension::DefaultPopupItems,
const KParts::BrowserExtension::ActionGroupMap& actionGroups = KParts::BrowserExtension::ActionGroupMap());
// TODO
void submitFormRequest(const char*,const QString&,const QByteArray&,const QString&,const QString&,const QString&);
void enableAction(KonqSidebarModule* module, const char* name, bool enabled);
private:
KComponentData m_parentComponentData;
KConfigGroup m_configGroup;
KonqSidebarModulePrivate* const d;
};
/**
* The plugin class is the "factory" for sidebar modules.
* It can create a module (based on a given configuration),
* it can also provide QActions for letting the user create new modules interactively.
*/
class KONQSIDEBARPLUGIN_EXPORT KonqSidebarPlugin : public QObject
{
Q_OBJECT
public:
KonqSidebarPlugin(QObject* parent, const QVariantList& args)
: QObject(parent)
{ Q_UNUSED(args); }
virtual ~KonqSidebarPlugin() {}
/**
* Create new module for the sidebar.
* @param componentData
* @param parent parent widget, for the plugin's widget
* @param configGroup desktop group from the plugin's desktop file
* @param desktopName filename of the plugin's desktop file - for compatibility only
* @param unused for future extensions
*/
virtual KonqSidebarModule* createModule(const KComponentData &componentData, QWidget *parent,
const KConfigGroup& configGroup,
const QString &desktopname,
const QVariant& unused) = 0;
/**
* Creates QActions for the "Add new" menu.
* @param parent parent object for the actions
* @param existingModules list of existing modules, to avoid creating "unique"
* modules multiple times
* @param unused for future extensions
*/
virtual QList<QAction*> addNewActions(QObject* parent,
const QList<KConfigGroup>& existingModules,
const QVariant& unused) {
Q_UNUSED(parent); Q_UNUSED(existingModules); Q_UNUSED(unused);
return QList<QAction *>();
}
/**
* Returns the template of the filename to used for new modules.
* @param actionData data given to the QAction (for modules who provide
* multiple "new" actions)
* @param unused for future extensions
*/
virtual QString templateNameForNewModule(const QVariant& actionData,
const QVariant& unused) const {
Q_UNUSED(actionData); Q_UNUSED(unused);
return QString();
}
/**
* Finally create a new module, added by the user.
* @param actionData data given to the QAction (for modules who provide
* multiple "new" actions)
* @param configGroup desktop group of the new desktop file. The desktop file
* is deleted if the method returns false (e.g. cancelled by user).
* @param parentWidget in case the plugin shows dialogs in this method
* @param unused for future extensions
*/
virtual bool createNewModule(const QVariant& actionData, KConfigGroup& configGroup,
QWidget* parentWidget,
const QVariant& unused) {
Q_UNUSED(actionData); Q_UNUSED(configGroup);
Q_UNUSED(parentWidget); Q_UNUSED(unused);
return false;
}
};
#endif
|