---

KParts::URLArgs Struct Reference

#include <browserextension.h>

List of all members.

Public Methods
void	setContentType (const QString &contentType)
QString	contentType () const
void	setDoPost (bool enable)
bool	doPost () const
void	setLockHistory (bool lock)
void	setNewTab (bool newTab)
QMap< QString, QString > &	metaData ()
Public Attributes
QStringList	docState
bool	reload
int	xOffset
int	yOffset
QString	serviceType
QByteArray	postData
QString	frameName
bool	trustedSource

---

Detailed Description

URLArgs is a set of arguments bundled into a structure, to allow specifying how a URL should be opened by openURL(). In other words, this is like arguments to openURL(), but without have to change the signature of openURL() (since openURL is a generic KParts method). The parts (with a browser extension) who care about urlargs will use those arguments, others will ignore them.

This can also be used the other way round, when a part asks for a URL to be opened (with openURLRequest or createNewWindow).

Definition at line 56 of file browserextension.h.

---

Member Function Documentation

QString KParts::URLArgs::contentType (    )

KHTML-specific field, header defining the type of the POST data.

bool KParts::URLArgs::doPost (    )

KHTML-specific field, whether to do a POST instead of a GET, for the next openURL.

QMap<QString, QString>& KParts::URLArgs::metaData (    )

Meta-data to associate with the next KIO operation See also: KIO::TransferJob etc.

void KParts::URLArgs::setContentType (  const QString &    contentType )

KHTML-specific field, header defining the type of the POST data.

void KParts::URLArgs::setDoPost (  bool    enable )

KHTML-specific field, whether to do a POST instead of a GET, for the next openURL.

void KParts::URLArgs::setLockHistory (  bool    lock )

Whether to lock the history when opening the next URL. This is used during e.g. a redirection, to avoid a new entry in the history.

void KParts::URLArgs::setNewTab (  bool    newTab )

Whether the URL should be opened in a new tab instead in a new window.

---

Member Data Documentation

QStringList KParts::URLArgs::docState

This buffer can be used by the part to save and restore its contents. See KHTMLPart for instance. Definition at line 69 of file browserextension.h.

QString KParts::URLArgs::frameName

The frame in which to open the URL. KHTML/Konqueror-specific. Definition at line 136 of file browserextension.h.

QByteArray KParts::URLArgs::postData

KHTML-specific field, contents of the HTTP POST data. Definition at line 93 of file browserextension.h.

bool KParts::URLArgs::reload

reload is set when the cache shouldn't be used (forced reload). Definition at line 74 of file browserextension.h.

QString KParts::URLArgs::serviceType

The servicetype (usually mimetype) to use when opening the next URL. Definition at line 88 of file browserextension.h.

bool KParts::URLArgs::trustedSource

If true, the part who asks for a URL to be opened can be 'trusted' to execute applications. For instance, the directory views can be 'trusted' whereas HTML pages are not trusted in that respect. Definition at line 143 of file browserextension.h.

int KParts::URLArgs::xOffset

xOffset is the horizontal scrolling of the part's widget (in case it's a scrollview). This is saved into the history and restored when going back in the history. Definition at line 80 of file browserextension.h.

int KParts::URLArgs::yOffset

yOffset vertical scrolling position, xOffset. Definition at line 84 of file browserextension.h.

---

The documentation for this struct was generated from the following file:

• browserextension.h

---