class BrowserExtension

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

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

Public Methods

Signals

Public Static Methods


Detailed Description

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

[selection-dependent actions] cut : copy selected items to clipboard and notifies that a cut has been done, using DCOP copy : copy selected items to clipboard (and notifies it's not a cut) pastecut : called when doing a paste after a cut pastecopy : called when doing a paste after a copy trash : move selected items to trash del : delete selected items (couldn't call it delete!) shred : shred selected items (secure deletion) properties : show file/document properties editMimeType : show file/document's mimetype properties <P> [normal actions] print : print :-) reparseConfiguration : re-read configuration and apply it refreshMimeTypes : if the view uses mimetypes it should re-determine them <P>

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 does not depend on the selection. For each slot that is defined in the second list, the action is automatically enabled.

A special case is the configuration slots, not connected to any action directly, and having parameters. [configuration slot] setSaveViewPropertiesLocally( bool ): if true, view properties are saved into .directory otherwise, they are saved globally.

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

Constructor

Parameters:
parentthe KParts::ReadOnlyPart that this extension ... "extends" :)
namean optional name for the extension

int  xOffset ()

[virtual]

Returns: the current x offset For a scrollview, implement this using contentsX()

int  yOffset ()

[virtual]

Returns: the current y offset For a scrollview, implement this using contentsY()

void  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 additionnal properties, reimplement it but don't forget to call the parent method (probably first).

void  restoreState ( QDataStream &stream )

[virtual]

Used by the browser to restore the view in the state it was when we left it. If you saved additionnal properties, reimplement it but don't forget to call the parent method (probably first).

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

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]

Open url in the browser, optionnally forcing reload, and optionnally setting the x and y offsets. The @serviceType allows to ...

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 an 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  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, @see KParts::URLArgs

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 = -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 = -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: root@porky.devel.redhat.com on Wed May 10 08:57:00 2000, using kdoc 2.0a35.