class BrowserExtension

The following standard actions are defined by the host of the view : More...

Full nameKParts::BrowserExtension
Definition#include <browserextension.h>
InheritsQObject (qt)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Signals


Detailed Description

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]

void  enableAction ( const char * name, bool enabled )

[signal]

Enable or disable a standard action held by the browser.

See class documentation for the list of standard actions.

void  openURLRequest ( const KURL &url, const KParts::URLArgs &args = KParts::URLArgs() )

[signal]

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

[signal]

Tell 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  setLocationBarURL ( const QString &url )

[signal]

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

void  setIconURL ( const KURL &url )

[signal]

URL of an icon for the currently displayed page

void  createNewWindow ( const KURL &url, const KParts::URLArgs &args = KParts::URLArgs() )

[signal]

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

The args argument is optional additionnal information for the browser,

void  createNewWindow ( const KURL &url, const KParts::URLArgs &args, const KParts::WindowArgs &windowArgs, KParts::ReadOnlyPart *&part )

[signal]

Ask 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  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  speedProgress ( int bytesPerSecond )

[signal]

void  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  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  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  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


Generated by: ssk@tauon.ph.unimelb.EDU.AU on Wed May 23 05:38:55 2001, using kdoc 2.0a35.