• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KParts

KParts::BrowserArguments

KParts::BrowserArguments Struct Reference

#include <browserextension.h>

List of all members.


Detailed Description

BrowserArguments is a set of web-browsing-specific arguments, which allow specifying how a URL should be opened by openUrl() (as a complement to KParts::OpenUrlArguments which are the non-web-specific arguments).

The arguments remain stored in the browser extension after that, and can be used for instance to jump to the xOffset/yOffset position once the url has finished loading.

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


Public Member Functions

 BrowserArguments (const BrowserArguments &args)
 BrowserArguments ()
QString contentType () const
bool doPost () const
bool forcesNewWindow () const
bool lockHistory () const
bool newTab () const
BrowserArguments & operator= (const BrowserArguments &args)
bool redirectedRequest () const
void setContentType (const QString &contentType)
void setDoPost (bool enable)
void setForcesNewWindow (bool forcesNewWindow)
void setLockHistory (bool lock)
void setNewTab (bool newTab)
void setRedirectedRequest (bool redirected)
virtual ~BrowserArguments ()

Public Attributes

QStringList docState
QString frameName
QByteArray postData
bool softReload
bool trustedSource

Constructor & Destructor Documentation

BrowserArguments::BrowserArguments (  ) 

Definition at line 127 of file browserextension.cpp.

BrowserArguments::BrowserArguments ( const BrowserArguments &  args  ) 

Definition at line 134 of file browserextension.cpp.

BrowserArguments::~BrowserArguments (  )  [virtual]

Definition at line 158 of file browserextension.cpp.


Member Function Documentation

QString BrowserArguments::contentType (  )  const

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

Definition at line 183 of file browserextension.cpp.

bool BrowserArguments::doPost (  )  const

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

Definition at line 195 of file browserextension.cpp.

bool BrowserArguments::forcesNewWindow (  )  const

Whether the URL specifies to be opened in a new window.

Definition at line 231 of file browserextension.cpp.

bool BrowserArguments::lockHistory (  )  const

Definition at line 207 of file browserextension.cpp.

bool BrowserArguments::newTab (  )  const

Definition at line 219 of file browserextension.cpp.

BrowserArguments & BrowserArguments::operator= ( const BrowserArguments &  args  ) 

Definition at line 140 of file browserextension.cpp.

bool BrowserArguments::redirectedRequest (  )  const

Returns:
true if the request was a result of a META refresh/redirect request or HTTP redirect.

Definition at line 178 of file browserextension.cpp.

void BrowserArguments::setContentType ( const QString &  contentType  ) 

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

Definition at line 164 of file browserextension.cpp.

void BrowserArguments::setDoPost ( bool  enable  ) 

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

Definition at line 188 of file browserextension.cpp.

void BrowserArguments::setForcesNewWindow ( bool  forcesNewWindow  ) 

Set whether the URL specifies to be opened in a new window.

Definition at line 224 of file browserextension.cpp.

void BrowserArguments::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.

Definition at line 200 of file browserextension.cpp.

void BrowserArguments::setNewTab ( bool  newTab  ) 

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

Definition at line 212 of file browserextension.cpp.

void BrowserArguments::setRedirectedRequest ( bool  redirected  ) 

Set the redirect flag to indicate URL is a result of either a META redirect or HTTP redirect.

Parameters:
redirected 

Definition at line 171 of file browserextension.cpp.


Member Data Documentation

QStringList KParts::BrowserArguments::docState

This buffer can be used by the part to save and restore its contents.

See KHTMLPart for instance.

Definition at line 81 of file browserextension.h.

QString KParts::BrowserArguments::frameName

The frame in which to open the URL.

KHTML/Konqueror-specific.

Definition at line 133 of file browserextension.h.

QByteArray KParts::BrowserArguments::postData

KHTML-specific field, contents of the HTTP POST data.

Definition at line 94 of file browserextension.h.

bool KParts::BrowserArguments::softReload

softReload is set when user just hits reload button.

It's used currently for two different frameset reload strategies. In case of soft reload individual frames are reloaded instead of reloading whole frameset.

Definition at line 89 of file browserextension.h.

bool KParts::BrowserArguments::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 140 of file browserextension.h.


The documentation for this struct was generated from the following files:
  • browserextension.h
  • browserextension.cpp

KParts

Skip menu "KParts"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal