KParts::BrowserExtension Class Reference

#include <browserextension.h>

Inheritance diagram for 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 =0x0001, ShowUp =0x0002, ShowReload =0x0004,   ShowBookmark =0x0008, ShowCreateDirectory =0x0010, ShowTextSelectionItems =0x0020, NoDeletion =0x0040,   IsLink =0x0080, ShowUrlOperations =0x0100, ShowProperties =0x200 }

Signals
void	addWebSideBar (const KUrl &url, const QString &name)
void	createNewWindow (const KUrl &url, const KParts::OpenUrlArguments &arguments=KParts::OpenUrlArguments(), const KParts::BrowserArguments &browserArguments=KParts::BrowserArguments(), const KParts::WindowArgs &windowArgs=KParts::WindowArgs(), KParts::ReadOnlyPart **part=0)
void	enableAction (const char *name, bool enabled)
void	infoMessage (const QString &)
void	itemsRemoved (const KFileItemList &items)
void	loadingProgress (int percent)
void	mouseOverInfo (const KFileItem &item)
void	moveTopLevelWidget (int x, int y)
void	openUrlNotify ()
void	openUrlRequest (const KUrl &url, const KParts::OpenUrlArguments &arguments=KParts::OpenUrlArguments(), const KParts::BrowserArguments &browserArguments=KParts::BrowserArguments())
void	openUrlRequestDelayed (const KUrl &url, const KParts::OpenUrlArguments &arguments, const KParts::BrowserArguments &browserArguments)
void	popupMenu (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=ActionGroupMap())
void	popupMenu (const QPoint &global, const KUrl &url, mode_t mode=static_cast< mode_t >(-1), const KParts::OpenUrlArguments &args=KParts::OpenUrlArguments(), const KParts::BrowserArguments &browserArgs=KParts::BrowserArguments(), KParts::BrowserExtension::PopupFlags flags=KParts::BrowserExtension::DefaultPopupItems, const KParts::BrowserExtension::ActionGroupMap &actionGroups=ActionGroupMap())
void	requestFocus (KParts::ReadOnlyPart *part)
void	resizeTopLevelWidget (int w, int h)
void	selectionInfo (const KFileItemList &items)
void	selectionInfo (const QString &text)
void	selectionInfo (const KUrl::List &urls)
void	setActionText (const char *name, const QString &text)
void	setIconUrl (const KUrl &url)
void	setLocationBarUrl (const QString &url)
void	setPageSecurity (int)
void	speedProgress (int bytesPerSecond)

Public Member Functions
	BrowserExtension (KParts::ReadOnlyPart *parent)
virtual	~BrowserExtension ()
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 ()

Static Public Member Functions
static ActionSlotMap	actionSlotMap ()
static ActionSlotMap *	actionSlotMapPtr ()
static BrowserExtension *	childObject (QObject *obj)

Properties
bool	urlDropHandling

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) 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 KUrl &) : 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 320 of file browserextension.h.

Member Typedef Documentation

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 493 of file browserextension.h.

typedef QMap<QByteArray,int> KParts::BrowserExtension::ActionNumberMap

Definition at line 700 of file browserextension.h.

typedef QMap<QByteArray,QByteArray> KParts::BrowserExtension::ActionSlotMap

Definition at line 439 of file browserextension.h.

Member Enumeration Documentation

enum KParts::BrowserExtension::PopupFlag

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

Enumerator
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)
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 338 of file browserextension.h.

Constructor & Destructor Documentation

BrowserExtension::BrowserExtension ( KParts::ReadOnlyPart *  parent )

explicit

Constructor.

Parameters

parent

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

Definition at line 506 of file browserextension.cpp.

BrowserExtension::~BrowserExtension ( )

virtual

Definition at line 547 of file browserextension.cpp.

Member Function Documentation

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

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

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

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.

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

BrowserInterface * BrowserExtension::browserInterface

(

)

const

Definition at line 676 of file browserextension.cpp.

BrowserExtension * BrowserExtension::childObject ( QObject *  obj )

static

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

Convenience method.

Definition at line 734 of file browserextension.cpp.

void KParts::BrowserExtension::createNewWindow ( const KUrl &  url, const KParts::OpenUrlArguments &  arguments = KParts::OpenUrlArguments(), const KParts::BrowserArguments &  browserArguments = KParts::BrowserArguments(), const KParts::WindowArgs &  windowArgs = KParts::WindowArgs(), KParts::ReadOnlyPart **  part = 0  )

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

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.

void KParts::BrowserExtension::infoMessage ( const QString &  )

signal

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

bool BrowserExtension::isURLDropHandlingEnabled

(

)

const

Returns whether url drop handling is enabled.

See setURLDropHandlingEnabled for more information about this property.

Definition at line 593 of file browserextension.cpp.

void KParts::BrowserExtension::itemsRemoved ( const KFileItemList &  items )

signal

Inform the host about items that have been removed.

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::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::moveTopLevelWidget ( int  x, int  y  )

signal

Ask the hosting application to move the top level widget.

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::openUrlRequest ( const KUrl &  url, const KParts::OpenUrlArguments &  arguments = KParts::OpenUrlArguments(), const KParts::BrowserArguments &  browserArguments = KParts::BrowserArguments()  )

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

void KParts::BrowserExtension::openUrlRequestDelayed ( const KUrl &  url, const KParts::OpenUrlArguments &  arguments, const KParts::BrowserArguments &  browserArguments  )

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

(

)

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

Definition at line 609 of file browserextension.cpp.

void KParts::BrowserExtension::popupMenu ( 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 = ActionGroupMap()  )

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

void KParts::BrowserExtension::popupMenu ( const QPoint &  global, const KUrl &  url, mode_t  mode = static_cast< mode_t >(-1), const KParts::OpenUrlArguments &  args = KParts::OpenUrlArguments(), const KParts::BrowserArguments &  browserArgs = KParts::BrowserArguments(), KParts::BrowserExtension::PopupFlags  flags = KParts::BrowserExtension::DefaultPopupItems, const KParts::BrowserExtension::ActionGroupMap &  actionGroups = ActionGroupMap()  )

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

void KParts::BrowserExtension::requestFocus ( KParts::ReadOnlyPart *  part )

signal

Ask the hosting application to focus part.

void KParts::BrowserExtension::resizeTopLevelWidget ( int  w, int  h  )

signal

Ask the hosting application to resize the top level widget.

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

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

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::setActionText ( const char *  name, const QString &  text  )

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.

void BrowserExtension::setBrowserArguments ( const BrowserArguments &  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

BrowserArguments

Definition at line 553 of file browserextension.cpp.

void BrowserExtension::setBrowserInterface

(

BrowserInterface *

impl

)

Definition at line 671 of file browserextension.cpp.

void KParts::BrowserExtension::setIconUrl ( const KUrl &  url )

signal

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

void KParts::BrowserExtension::setLocationBarUrl ( const QString &  url )

signal

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

void KParts::BrowserExtension::setPageSecurity ( int  )

signal

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

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

void KParts::BrowserExtension::speedProgress ( int  bytesPerSecond )

signal

See also

loadingProgress

int BrowserExtension::xOffset ( )

virtual

Returns the current x offset.

For a scrollview, implement this using contentsX().

Definition at line 563 of file browserextension.cpp.

int BrowserExtension::yOffset ( )

virtual

Returns the current y offset.

For a scrollview, implement this using contentsY().

Definition at line 568 of file browserextension.cpp.

Property Documentation

bool KParts::BrowserExtension::urlDropHandling

readwrite

Definition at line 323 of file browserextension.h.

---

The documentation for this class was generated from the following files:

• browserextension.h
• browserextension.cpp