kparts Library API Documentation

KParts::BrowserExtension Class Reference

The Browser Extension is an extension (yes, no kidding) to KParts::ReadOnlyPart, which allows a better integration of parts with browsers (in particular Konqueror). More...

#include <browserextension.h>

Inheritance diagram for KParts::BrowserExtension:

QObject List of all members.

Public Types

enum  

Signals

void enableAction (const char *name, bool enabled)
void openURLRequest (const KURL &url, const KParts::URLArgs &args=KParts::URLArgs())
void openURLRequestDelayed (const KURL &url, const KParts::URLArgs &args=KParts::URLArgs())
void openURLNotify ()
void setLocationBarURL (const QString &url)
void setIconURL (const KURL &url)
void createNewWindow (const KURL &url, const KParts::URLArgs &args=KParts::URLArgs())
void createNewWindow (const KURL &url, const KParts::URLArgs &args, const KParts::WindowArgs &windowArgs, KParts::ReadOnlyPart *&part)
void loadingProgress (int percent)
void speedProgress (int bytesPerSecond)
void popupMenu (const QPoint &global, const KFileItemList &items)
void popupMenu (KXMLGUIClient *client, const QPoint &global, const KFileItemList &items)
void popupMenu (const QPoint &global, const KURL &url, const QString &mimeType, mode_t mode=(mode_t)-1)
void popupMenu (KXMLGUIClient *client, const QPoint &global, const KURL &url, const QString &mimeType, mode_t mode=(mode_t)-1)
void popupMenu (KXMLGUIClient *client, const QPoint &global, const KURL &url, const KParts::URLArgs &args, KParts::BrowserExtension::PopupFlags i, mode_t mode=(mode_t)-1)
void selectionInfo (const KFileItemList &items)
void selectionInfo (const QString &text)
void selectionInfo (const KURL::List &urls)
void mouseOverInfo (const KFileItem *item)
void addWebSideBar (const KURL &url, const QString &name)
void moveTopLevelWidget (int x, int y)
void resizeTopLevelWidget (int w, int h)

Public Methods

 BrowserExtension (KParts::ReadOnlyPart *parent, const char *name=0L)
virtual void setURLArgs (const URLArgs &args)
URLArgs urlArgs () const
virtual int xOffset ()
virtual int yOffset ()
virtual void saveState (QDataStream &stream)
virtual void restoreState (QDataStream &stream)
bool isURLDropHandlingEnabled () const
void setURLDropHandlingEnabled (bool enable)
bool isActionEnabled (const char *name) const
void pasteRequest ()

Static Public Methods

ActionSlotMap actionSlotMap ()
ActionSlotMap * actionSlotMapPtr ()
BrowserExtension * childObject (QObject *obj)

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(KURL), with no other settings. For full-fledged browsing, we need much more than that, including many arguments about how to open this URL (see URLArgs), 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]

[normal actions] 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. You need to enable 'print' when printing is possible - you can even do that in the constructor.

A special case is the configuration slots, not connected to any action directly, and having parameters.

[configuration slot]

Definition at line 285 of file browserextension.h.


Member Enumeration Documentation

anonymous enum
 

Set of flags passed via the popupMenu signal, to ask for some items in the popup menu.

DefaultPopupItems: default value, no additional menu item ShowNavigationItems: show "back" and "forward" (usually done when clicking the background of the view, but not an item) ShowUp: show "up" (same thing, but not over e.g. HTTP). Requires ShowNavigationItems. ShowReload: show "reload" (usually done when clicking the background of the view, but not an item) 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)

Definition at line 314 of file browserextension.h.


Constructor & Destructor Documentation

BrowserExtension::BrowserExtension KParts::ReadOnlyPart   parent,
const char *    name = 0L
 

Constructor.

Parameters:
parent  The KParts::ReadOnlyPart that this extension ... "extends" :)
name  An optional name for the extension.

Definition at line 335 of file browserextension.cpp.

References QMap< QCString, QCString >::begin(), QObject::connect(), enableAction(), QMap< QCString, QCString >::end(), QObject::metaObject(), and openURLRequest().


Member Function Documentation

void BrowserExtension::setURLArgs const URLArgs   args [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:
URLArgs

Definition at line 372 of file browserextension.cpp.

Referenced by restoreState().

URLArgs BrowserExtension::urlArgs  
 

Retrieve the set of parameters to use for opening the URL (this must be called from openURL() in the part).

See also:
URLArgs

Definition at line 377 of file browserextension.cpp.

Referenced by restoreState().

int BrowserExtension::xOffset   [virtual]
 

Returns the current x offset.

For a scrollview, implement this using contentsX().

Definition at line 382 of file browserextension.cpp.

Referenced by saveState().

int BrowserExtension::yOffset   [virtual]
 

Returns the current y offset.

For a scrollview, implement this using contentsY().

Definition at line 387 of file browserextension.cpp.

Referenced by saveState().

void BrowserExtension::saveState QDataStream   stream [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 392 of file browserextension.cpp.

References KParts::ReadOnlyPart::url(), xOffset(), and yOffset().

void BrowserExtension::restoreState QDataStream   stream [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 397 of file browserextension.cpp.

References KParts::ReadOnlyPart::openURL(), setURLArgs(), urlArgs(), KParts::URLArgs::xOffset, and KParts::URLArgs::yOffset.

bool BrowserExtension::isURLDropHandlingEnabled  
 

Returns whether url drop handling is enabled.

See setURLDropHandlingEnabled for more information about this property.

Definition at line 412 of file browserextension.cpp.

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 417 of file browserextension.cpp.

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 508 of file browserextension.cpp.

References QObject::name().

BrowserExtension::ActionSlotMap BrowserExtension::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:

   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 QMap<QCString,QCString> iterator)

Definition at line 515 of file browserextension.cpp.

References actionSlotMapPtr().

BrowserExtension::ActionSlotMap * BrowserExtension::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 520 of file browserextension.cpp.

Referenced by actionSlotMap().

BrowserExtension * BrowserExtension::childObject QObject   obj [static]
 

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

Convenience method.

Definition at line 559 of file browserextension.cpp.

References QObject::children().

void BrowserExtension::pasteRequest  
 

Asks the hosting browser to perform a paste.

Since:
3.2

Definition at line 428 of file browserextension.cpp.

References QApplication::clipboard(), KURIFilterData::errorMsg(), QStyleSheet::escape(), KURIFilter::filterURI(), QString::length(), KURIFilter::pluginNames(), KMessageBox::questionYesNo(), KURIFilter::self(), KURIFilterData::setCheckForExecutables(), KURIFilterData::setData(), KMessageBox::sorry(), KURIFilterData::uri(), KURIFilterData::uriType(), and KParts::Part::widget().

void KParts::BrowserExtension::enableAction const char *    name,
bool    enabled
[signal]
 

Enables or disable a standard action held by the browser.

See class documentation for the list of standard actions.

Referenced by BrowserExtension().

void KParts::BrowserExtension::openURLRequest const KURL   url,
const KParts::URLArgs   args = KParts::URLArgs()
[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.

Referenced by BrowserExtension().

void KParts::BrowserExtension::openURLRequestDelayed const KURL   url,
const KParts::URLArgs   args = KParts::URLArgs()
[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.

void KParts::BrowserExtension::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.

void KParts::BrowserExtension::setLocationBarURL const QString   url [signal]
 

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

void KParts::BrowserExtension::setIconURL const KURL   url [signal]
 

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

void KParts::BrowserExtension::createNewWindow const KURL   url,
const KParts::URLArgs   args = KParts::URLArgs()
[signal]
 

Asks the hosting browser to open a new window for the given url.

The args argument is optional additional information for the browser,

See also:
KParts::URLArgs

void KParts::BrowserExtension::createNewWindow const KURL   url,
const KParts::URLArgs   args,
const KParts::WindowArgs   windowArgs,
KParts::ReadOnlyPart *&    part
[signal]
 

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

The request for a reference to the part is only fullfilled/processed if the serviceType is set in the args . (otherwise the request cannot be processed synchroniously.

void KParts::BrowserExtension::loadingProgress int    percent [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.

void KParts::BrowserExtension::speedProgress int    bytesPerSecond [signal]
 

See also:
loadingProgress

void KParts::BrowserExtension::popupMenu const QPoint   global,
const KFileItemList &    items
[signal]
 

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

void KParts::BrowserExtension::popupMenu KXMLGUIClient   client,
const QPoint   global,
const KFileItemList &    items
[signal]
 

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

The GUI described by client is being merged with the popupmenu of the host

void KParts::BrowserExtension::popupMenu const QPoint   global,
const KURL   url,
const QString   mimeType,
mode_t    mode = (mode_t)-1
[signal]
 

Emit this to make the browser show a standard popup menu at the point global for the given url.

Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)

void KParts::BrowserExtension::popupMenu KXMLGUIClient   client,
const QPoint   global,
const KURL   url,
const QString   mimeType,
mode_t    mode = (mode_t)-1
[signal]
 

Emit this to make the browser show a standard popup menu at the point global for the given url.

Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...) The GUI described by client is being merged with the popupmenu of the host

void KParts::BrowserExtension::popupMenu KXMLGUIClient   client,
const QPoint   global,
const KURL   url,
const KParts::URLArgs   args,
KParts::BrowserExtension::PopupFlags    i,
mode_t    mode = (mode_t)-1
[signal]
 

Emit this to make the browser show a standard popup menu at the point global for the given url.

Give as much information about this URL as possible, like args.mimeType and the file type (mode: S_IFREG, S_IFDIR...) The GUI described by client is being merged with the popupmenu of the host

void KParts::BrowserExtension::selectionInfo const KFileItemList &    items [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.)

void KParts::BrowserExtension::selectionInfo const QString   text [signal]
 

Inform the hosting application about the current selection.

Used when some text is selected.

void KParts::BrowserExtension::selectionInfo const KURL::List   urls [signal]
 

Inform the hosting application about the current selection.

Used when a set of URLs is selected.

void KParts::BrowserExtension::mouseOverInfo const KFileItem   item [signal]
 

Inform the hosting application that the user moved the mouse over an item.

Used when the mouse is on an URL.

void KParts::BrowserExtension::addWebSideBar const KURL   url,
const QString   name
[signal]
 

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

void KParts::BrowserExtension::moveTopLevelWidget int    x,
int    y
[signal]
 

Ask the hosting application to move the top level widget.

void KParts::BrowserExtension::resizeTopLevelWidget int    w,
int    h
[signal]
 

Ask the hosting application to resize the top level widget.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kparts Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:24:39 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003