Member Function Documentation

[explicit] NavigationExtension::NavigationExtension(KParts::ReadOnlyPart *parent)

Constructor

parent The KParts::ReadOnlyPart that this extension ... "extends" :)

[static] KParts::NavigationExtension::ActionSlotMap *NavigationExtension::actionSlotMap()

Returns a pointer to the static map containing the action names as keys and corresponding SLOT()'ified method names as data entries. The map is created if it doesn't exist yet.

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:

extension->metaObject()->slotNames().contains( actionName + "()" )

(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:

connect( yourObject, SIGNAL( yourSignal() ),
         extension, mapIterator.data() )

(where "mapIterator" is your ActionSlotMap iterator)

QString NavigationExtension::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.

See also setActionText().

[signal] void NavigationExtension::addWebSideBar(const QUrl &url, const QString &name)

Ask the hosting application to add a new HTML (aka Mozilla/Netscape) SideBar entry.

[static] KParts::NavigationExtension *NavigationExtension::childObject(QObject *obj)

Queries obj for a child object which inherits from this BrowserExtension class. Convenience method.

[signal] void NavigationExtension::createNewWindow(const QUrl &url)

Asks the hosting browser to open a new window for the given url and return a reference to the content part.

[signal] void NavigationExtension::enableAction(const char *name, bool enabled)

Enables or disable a standard action held by the browser.

See class documentation for the list of standard actions.

bool NavigationExtension::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.

bool NavigationExtension::isURLDropHandlingEnabled() const

Returns whether url drop handling is enabled. See setURLDropHandlingEnabled for more information about this property.

[signal] void NavigationExtension::itemsRemoved(const KFileItemList &items)

Inform the host about items that have been removed.

[signal] void NavigationExtension::loadingProgress(int percent)

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.

[signal] void NavigationExtension::mouseOverInfo(const KFileItem &item)

Inform the hosting application that the user moved the mouse over an item. Used when the mouse is on an URL.

[signal] void NavigationExtension::moveTopLevelWidget(int x, int y)

Ask the hosting application to move the top level widget.

[signal] void NavigationExtension::openUrlNotify()

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.

[signal] void NavigationExtension::openUrlRequest(const QUrl &url, const KParts::OpenUrlArguments &arguments = KParts::OpenUrlArguments())

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().

[signal] void NavigationExtension::openUrlRequestDelayed(const QUrl &url, const KParts::OpenUrlArguments &arguments)

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.

void NavigationExtension::pasteRequest()

Asks the hosting browser to perform a paste (using openUrlRequestDelayed())

[signal] void NavigationExtension::popupMenu(const QPoint &global, const KFileItemList &items, const KParts::OpenUrlArguments &arguments = KParts::OpenUrlArguments(), KParts::NavigationExtension::PopupFlags flags = KParts::NavigationExtension::DefaultPopupItems, const KParts::NavigationExtension::ActionGroupMap &actionGroups = ActionGroupMap())

Emit this to make the browser show a standard popup menu for the files items.

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

flags enables/disables certain builtin actions in the popupmenu

actionGroups named groups of actions which should be inserted into the popup, see ActionGroupMap

Note: Signal popupMenu is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

connect(navigationExtension, QOverload<const QPoint &, const KFileItemList &, const KParts::OpenUrlArguments &, KParts::NavigationExtension::PopupFlags, const KParts::NavigationExtension::ActionGroupMap &>::of(&NavigationExtension::popupMenu),
    [=](const QPoint &global, const KFileItemList &items, const KParts::OpenUrlArguments &arguments, KParts::NavigationExtension::PopupFlags flags, const KParts::NavigationExtension::ActionGroupMap &actionGroups){ /* ... */ });

[signal] void NavigationExtension::popupMenu(const QPoint &global, const QUrl &url, mode_t mode = static_cast<mode_t>(-1), const KParts::OpenUrlArguments &arguments = KParts::OpenUrlArguments(), KParts::NavigationExtension::PopupFlags flags = KParts::NavigationExtension::DefaultPopupItems, const KParts::NavigationExtension::ActionGroupMap &actionGroups = ActionGroupMap())

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

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()

flags enables/disables certain builtin actions in the popupmenu

actionGroups named groups of actions which should be inserted into the popup, see ActionGroupMap

Note: Signal popupMenu is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

connect(navigationExtension, QOverload<const QPoint &, const QUrl &, mode_t, const KParts::OpenUrlArguments &, KParts::NavigationExtension::PopupFlags, const KParts::NavigationExtension::ActionGroupMap &>::of(&NavigationExtension::popupMenu),
    [=](const QPoint &global, const QUrl &url, mode_t mode, const KParts::OpenUrlArguments &arguments, KParts::NavigationExtension::PopupFlags flags, const KParts::NavigationExtension::ActionGroupMap &actionGroups){ /* ... */ });

[signal] void NavigationExtension::requestFocus(KParts::ReadOnlyPart *part)

Ask the hosting application to focus part.

[signal] void NavigationExtension::resizeTopLevelWidget(int w, int h)

Ask the hosting application to resize the top level widget.

[virtual] void NavigationExtension::restoreState(QDataStream &stream)

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).

[virtual] void NavigationExtension::saveState(QDataStream &stream)

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).

[signal] void NavigationExtension::selectionInfo(const KFileItemList &items)

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.)

[signal] void NavigationExtension::setActionText(const char *name, const QString &text)

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.

See also actionText().

[signal] void NavigationExtension::setIconUrl(const QUrl &url)

Sets the URL of an icon for the currently displayed page.

[signal] void NavigationExtension::setLocationBarUrl(const QString &url)

Updates the URL shown in the browser's location bar to url.

[signal] void NavigationExtension::setPageSecurity(int)

Tell the host (browser) about security state of current page enum PageSecurity { NotCrypted, Encrypted, Mixed };

void NavigationExtension::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.

See also isURLDropHandlingEnabled().

[signal] void NavigationExtension::speedProgress(int bytesPerSecond)

See also loadingProgress.

[virtual] int NavigationExtension::xOffset()

Returns the current x offset.

For a scrollview, implement this using contentsX().

[virtual] int NavigationExtension::yOffset()

Returns the current y offset.

For a scrollview, implement this using contentsY().