KParts::BrowserExtension
#include <KParts/BrowserExtension>

Public Types | |
typedef QMap< QString, QList< QAction * > > | ActionGroupMap |
typedef QMap< QByteArray, int > | ActionNumberMap |
typedef QMap< QByteArray, QByteArray > | ActionSlotMap |
enum | PopupFlag { DefaultPopupItems = 0x0000, ShowNavigationItems, ShowUp = 0x0002, ShowReload = 0x0004, ShowBookmark = 0x0008, ShowCreateDirectory = 0x0010, ShowTextSelectionItems = 0x0020, NoDeletion = 0x0040, IsLink = 0x0080, ShowUrlOperations = 0x0100, ShowProperties = 0x200 } |
typedef QFlags< PopupFlag > | PopupFlags |
Properties | |
bool | urlDropHandling |
![]() | |
objectName | |
Public Member Functions | |
BrowserExtension (KParts::ReadOnlyPart *parent) | |
QString | actionText (const char *name) const |
BrowserArguments | browserArguments () const |
BrowserInterface * | browserInterface () const |
bool | isActionEnabled (const char *name) const |
bool | isURLDropHandlingEnabled () const |
void | pasteRequest () |
virtual void | restoreState (QDataStream &stream) |
virtual void | saveState (QDataStream &stream) |
virtual void | setBrowserArguments (const BrowserArguments &args) |
void | setBrowserInterface (BrowserInterface *impl) |
void | setURLDropHandlingEnabled (bool enable) |
virtual int | xOffset () |
virtual int | yOffset () |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, 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 |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | 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 | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
Static Public Member Functions | |
static ActionSlotMap | actionSlotMap () |
static ActionSlotMap * | actionSlotMapPtr () |
static BrowserExtension * | childObject (QObject *obj) |
![]() | |
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) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Additional Inherited Members | |
![]() | |
typedef | QObjectList |
![]() | |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
The Browser Extension is an extension (yes, no kidding) to KParts::ReadOnlyPart, which allows a better integration of parts with browsers (in particular Konqueror).
Remember that ReadOnlyPart only has openUrl(QUrl) and a few arguments() but not much more. For full-fledged browsing, we need much more than that, including enabling/disabling of standard actions (print, copy, paste...), allowing parts to save and restore their data into the back/forward history, allowing parts to control the location bar URL, to requests URLs to be opened by the hosting browser, etc.
The part developer needs to define its own class derived from BrowserExtension, to implement the virtual methods [and the standard-actions slots, see below].
The way to associate the BrowserExtension with the part is to simply create the BrowserExtension as a child of the part (in QObject's terms). The hosting application will look for it automatically.
Another aspect of the browser integration is that a set of standard actions are provided by the browser, but implemented by the part (for the actions it supports).
The following standard actions are defined by the host of the view:
[selection-dependent actions]
cut
: Copy selected items to clipboard and store 'not cut' in clipboard.copy
: Copy selected items to clipboard and store 'cut' in clipboard.paste
: Paste clipboard into view URL.pasteTo(const QUrl &)
: Paste clipboard into given URL.searchProvider
: Lookup selected text at default search provider
[normal actions]
- None anymore.
The view defines a slot with the name of the action in order to implement the action. The browser will detect the slot automatically and connect its action to it when appropriate (i.e. when the view is active).
The selection-dependent actions are disabled by default and the view should enable them when the selection changes, emitting enableAction().
The normal actions do not depend on the selection.
A special case is the configuration slots, not connected to any action directly.
[configuration slot]
reparseConfiguration
: Re-read configuration and apply it.disableScrolling:
no scrollbars
Definition at line 90 of file browserextension.h.
Member Typedef Documentation
◆ ActionGroupMap
typedef QMap<QString, QList<QAction *> > KParts::BrowserExtension::ActionGroupMap |
Associates a list of actions with a predefined name known by the host's popupmenu: "editactions" for actions related text editing, "linkactions" for actions related to hyperlinks, "partactions" for any other actions provided by the part.
Definition at line 273 of file browserextension.h.
◆ PopupFlags
typedef QFlags< PopupFlag > KParts::BrowserExtension::PopupFlags |
Stores a combination of PopupFlag values.
Definition at line 130 of file browserextension.h.
Member Enumeration Documentation
◆ PopupFlag
Set of flags passed via the popupMenu signal, to ask for some items in the popup menu.
- See also
- PopupFlags
Enumerator | |
---|---|
DefaultPopupItems | default value, no additional menu item |
ShowNavigationItems |
|
ShowUp |
|
ShowReload |
|
ShowBookmark | show "add to bookmarks" (usually not done on the local filesystem) |
ShowCreateDirectory | show "create directory" (usually only done on the background of the view, or in hierarchical views like directory trees, where the new dir would be visible) |
ShowTextSelectionItems | set when selecting text, for a popup that only contains text-related items. |
NoDeletion | deletion, trashing and renaming not allowed (e.g. parent dir not writeable). (this is only needed if the protocol itself supports deletion, unlike e.g. HTTP) |
IsLink | show "Bookmark This Link" and other link-related actions (linkactions merging group) |
ShowUrlOperations | show copy, paste, as well as cut if NoDeletion is not set. |
ShowProperties | show "Properties" action (usually done by directory views) |
Definition at line 108 of file browserextension.h.
Constructor & Destructor Documentation
◆ BrowserExtension()
|
explicit |
Constructor.
- Parameters
-
parent The KParts::ReadOnlyPart that this extension ... "extends" :)
Definition at line 100 of file browserextension.cpp.
Member Function Documentation
◆ actionSlotMap()
|
static |
Returns a map containing the action names as keys and corresponding SLOT()'ified method names as data entries.
This is very useful for the host component, when connecting the own signals with the extension's slots. Basically you iterate over the map, check if the extension implements the slot and connect to the slot using the data value of your map iterator. Checking if the extension implements a certain slot can be done like this:
(note that actionName
is the iterator's key value if already iterating over the action slot map, returned by this method)
Connecting to the slot can be done like this:
(where "mapIterator" is your ActionSlotMap iterator)
Definition at line 303 of file browserextension.cpp.
◆ actionSlotMapPtr()
|
static |
- Returns
- a pointer to the static action-slot map. Preferred method to get it. The map is created if it doesn't exist yet
Definition at line 309 of file browserextension.cpp.
◆ actionText()
QString BrowserExtension::actionText | ( | const char * | name | ) | const |
- Returns
- the text of an action, if it was set explicitly by the part. When the setActionText signal is emitted, the browserextension stores the text of the action internally, so that it's possible to query later for the text of the action, using this method.
Definition at line 292 of file browserextension.cpp.
◆ addWebSideBar
Ask the hosting application to add a new HTML (aka Mozilla/Netscape) SideBar entry.
◆ browserArguments()
BrowserArguments BrowserExtension::browserArguments | ( | ) | const |
Retrieve the set of parameters to use for opening the URL (this must be called from openUrl() in the part).
- See also
- BrowserArguments
Definition at line 139 of file browserextension.cpp.
◆ childObject()
|
static |
Queries obj
for a child object which inherits from this BrowserExtension class.
Convenience method.
Definition at line 317 of file browserextension.cpp.
◆ createNewWindow
|
signal |
Asks the hosting browser to open a new window for the given url
and return a reference to the content part.
arguments
is optional additional information about how to open the url,
- See also
- KParts::OpenUrlArguments
browserArguments
is optional additional information for web browsers,
- See also
- KParts::BrowserArguments
The request for a pointer to the part is only fulfilled/processed if the mimeType is set in the browserArguments
. (otherwise the request cannot be processed synchronously).
◆ enableAction
|
signal |
Enables or disable a standard action held by the browser.
See class documentation for the list of standard actions.
◆ isActionEnabled()
bool BrowserExtension::isActionEnabled | ( | const char * | name | ) | const |
- Returns
- the status (enabled/disabled) of an action. When the enableAction signal is emitted, the browserextension stores the status of the action internally, so that it's possible to query later for the status of the action, using this method.
Definition at line 275 of file browserextension.cpp.
◆ isURLDropHandlingEnabled()
bool BrowserExtension::isURLDropHandlingEnabled | ( | ) | const |
Returns whether url drop handling is enabled.
See setURLDropHandlingEnabled for more information about this property.
Definition at line 175 of file browserextension.cpp.
◆ itemsRemoved
|
signal |
Inform the host about items that have been removed.
◆ loadingProgress
|
signal |
Since the part emits the jobid in the started() signal, progress information is automatically displayed.
However, if you don't use a KIO::Job in the part, you can use loadingProgress() and speedProgress() to display progress information.
◆ mouseOverInfo
|
signal |
Inform the hosting application that the user moved the mouse over an item.
Used when the mouse is on an URL.
◆ moveTopLevelWidget
|
signal |
Ask the hosting application to move the top level widget.
◆ openUrlNotify
|
signal |
Tells the hosting browser that the part opened a new URL (which can be queried via KParts::Part::url().
This helps the browser to update/create an entry in the history. The part may not emit this signal together with openUrlRequest(). Emit openUrlRequest() if you want the browser to handle a URL the user asked to open (from within your part/document). This signal however is useful if you want to handle URLs all yourself internally, while still telling the hosting browser about new opened URLs, in order to provide a proper history functionality to the user. An example of usage is a html rendering component which wants to emit this signal when a child frame document changed its URL. Conclusion: you probably want to use openUrlRequest() instead.
◆ openUrlRequest
|
signal |
Asks the host (browser) to open url
.
To set a reload, the x and y offsets, the service type etc., fill in the appropriate fields in the args
structure. Hosts should not connect to this signal but to openUrlRequestDelayed().
◆ openUrlRequestDelayed
|
signal |
This signal is emitted when openUrlRequest() is called, after a 0-seconds timer.
This allows the caller to terminate what it's doing first, before (usually) being destroyed. Parts should never use this signal, hosts should only connect to this signal.
◆ pasteRequest()
void BrowserExtension::pasteRequest | ( | ) |
Asks the hosting browser to perform a paste (using openUrlRequestDelayed())
Definition at line 191 of file browserextension.cpp.
◆ popupMenu [1/2]
|
signal |
Emit this to make the browser show a standard popup menu for the files items
.
- Parameters
-
global global coordinates where the popup should be shown items list of file items which the popup applies to args OpenUrlArguments, mostly for metadata here browserArguments BrowserArguments, mostly for referrer flags enables/disables certain builtin actions in the popupmenu actionGroups named groups of actions which should be inserted into the popup, see ActionGroupMap
◆ popupMenu [2/2]
|
signal |
Emit this to make the browser show a standard popup menu for the given url
.
Give as much information about this URL as possible, like args.mimeType
and the file type mode
- Parameters
-
global global coordinates where the popup should be shown url the URL this popup applies to mode the file type of the url (S_IFREG, S_IFDIR...) args OpenUrlArguments, set the mimetype of the URL using setMimeType() browserArguments BrowserArguments, mostly for referrer flags enables/disables certain builtin actions in the popupmenu actionGroups named groups of actions which should be inserted into the popup, see ActionGroupMap
◆ requestFocus
|
signal |
Ask the hosting application to focus part
.
◆ resizeTopLevelWidget
|
signal |
Ask the hosting application to resize the top level widget.
◆ restoreState()
|
virtual |
Used by the browser to restore the view in the state it was when we left it.
If you saved additional properties, reimplement it but don't forget to call the parent method (probably first).
Definition at line 160 of file browserextension.cpp.
◆ saveState()
|
virtual |
Used by the browser to save the current state of the view (in order to restore it if going back in navigation).
If you want to save additional properties, reimplement it but don't forget to call the parent method (probably first).
Definition at line 154 of file browserextension.cpp.
◆ selectionInfo [1/3]
|
signal |
Inform the hosting application about the current selection.
Used when a set of files/URLs is selected (with full information about those URLs, including size, permissions etc.)
◆ selectionInfo [2/3]
Inform the hosting application about the current selection.
Used when a set of URLs is selected.
- Deprecated:
- Since 5.88, use selectionInfo(KFileItemList) instead
◆ selectionInfo [3/3]
|
signal |
Inform the hosting application about the current selection.
Used when some text is selected.
- Deprecated:
- Since 5.88, deprecated for lack of usage
◆ setActionText
|
signal |
Change the text of a standard action held by the browser.
This can be used to change "Paste" into "Paste Image" for instance.
See class documentation for the list of standard actions.
◆ setBrowserArguments()
|
virtual |
Set the parameters to use for opening the next URL.
This is called by the "hosting" application, to pass parameters to the part.
- See also
- BrowserArguments
Definition at line 134 of file browserextension.cpp.
◆ setIconUrl
|
signal |
Sets the URL of an icon for the currently displayed page.
◆ setLocationBarUrl
|
signal |
Updates the URL shown in the browser's location bar to url
.
◆ setPageSecurity
|
signal |
Tell the host (browser) about security state of current page enum PageSecurity { NotCrypted, Encrypted, Mixed };.
◆ setURLDropHandlingEnabled()
void BrowserExtension::setURLDropHandlingEnabled | ( | bool | enable | ) |
Enables or disables url drop handling.
URL drop handling is a property describing whether the hosting shell component is allowed to install an event filter on the part's widget, to listen for URI drop events. Set it to true if you are exporting a BrowserExtension implementation and do not provide any special URI drop handling. If set to false you can be sure to receive all those URI drop events unfiltered. Also note that the implementation as of Konqueror installs the event filter only on the part's widget itself, not on child widgets.
Definition at line 180 of file browserextension.cpp.
◆ speedProgress
|
signal |
- See also
- loadingProgress
◆ xOffset()
|
virtual |
Returns the current x offset.
For a scrollview, implement this using contentsX().
Definition at line 144 of file browserextension.cpp.
◆ yOffset()
|
virtual |
Returns the current y offset.
For a scrollview, implement this using contentsY().
Definition at line 149 of file browserextension.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 03:53:51 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.