KIO::Integration::CookieJar Class Reference

A KDE implementation of QNetworkCookieJar. More...

#include <accessmanager.h>

Inheritance diagram for KIO::Integration::CookieJar:

List of all members.

Public Member Functions
	CookieJar (QObject *parent=0)
	~CookieJar ()
QList< QNetworkCookie >	cookiesForUrl (const QUrl &url) const
bool	isCookieStorageDisabled () const
void	reparseConfiguration ()
bool	setCookiesFromUrl (const QList< QNetworkCookie > &cookieList, const QUrl &url)
void	setDisableCookieStorage (bool disable)
void	setWindowId (WId id)
WId	windowId () const

---

Detailed Description

A KDE implementation of QNetworkCookieJar.

Use this class in place of QNetworkCookieJar if you want to integrate with KDE's cookiejar instead of the one that comes with Qt.

Here is a simple example that shows how to set the QtWebKit module to use KDE's cookiejar:

   QWebView *view = new QWebView(this);
   KIO::Integration::CookieJar *cookieJar = new KIO::Integration::CookieJar;
   cookieJar->setWindowId(view->window()->winId());
   view->page()->networkAccessManager()->setCookieJar(cookieJar);

To access member functions in the cookiejar class at a later point in your code simply downcast the pointer returned by QNetworkAccessManager::cookieJar as follows:

   KIO::Integration::CookieJar *cookieJar = qobject_cast<KIO::Integration::CookieJar*>(view->page()->accessManager()->cookieJar());

IMPORTANTThis class is not a replacement for the standard KDE API. It should ONLY be used to to provide KDE integration in applications that cannot use the standard KDE API directly.

See also:

QNetworkAccessManager::setCookieJar for details.

Author:

Dawit Alemayehu <adawit @ kde.org>

Since:

4.4

Definition at line 232 of file accessmanager.h.

---

Constructor & Destructor Documentation

CookieJar::CookieJar

(

QObject *

parent = 0

)

[explicit]

Constructs a KNetworkCookieJar with parent parent.

Definition at line 347 of file accessmanager.cpp.

CookieJar::~CookieJar

(

)

Destroys the KNetworkCookieJar.

Definition at line 352 of file accessmanager.cpp.

---

Member Function Documentation

QList< QNetworkCookie > CookieJar::cookiesForUrl

(

const QUrl &

url

)

const

Reimplemented for internal reasons, the API is not affected.

See also:

QNetworkCookieJar::cookiesForUrl

Definition at line 364 of file accessmanager.cpp.

bool CookieJar::isCookieStorageDisabled

(

)

const

Returns true if persistent caching of cookies is disabled.

See also:

setDisableCookieStorage

Since:

4.6

Definition at line 360 of file accessmanager.cpp.

void CookieJar::reparseConfiguration

(

)

Reparse the KDE cookiejar configuration file.

Definition at line 419 of file accessmanager.cpp.

bool CookieJar::setCookiesFromUrl	(	const QList< QNetworkCookie > &	cookieList,
		const QUrl &	url
	)

Reimplemented for internal reasons, the API is not affected.

See also:

QNetworkCookieJar::setCookiesFromUrl

Definition at line 390 of file accessmanager.cpp.

void CookieJar::setDisableCookieStorage

(

bool

disable

)

Prevent persistent storage of cookies.

Call this function if you do not want cookies to be stored locally for later access without disabling the cookiejar. All cookies will be discarded once the sessions that are using the cookie are done.

Since:

4.6

Definition at line 411 of file accessmanager.cpp.

void CookieJar::setWindowId

(

WId

id

)

Sets the window id of the application.

This value is used by KDE's cookiejar to manage session cookies, namely to delete them when the last application referring to such cookies is closed by the end user.

See also:

QWidget::window()

QWidget::winId()

Parameters:

id	the value of QWidget::winId() from the window that contains your widget.

Definition at line 415 of file accessmanager.cpp.

WId CookieJar::windowId

(

)

const

Returns the currently set window id.

The default value is -1.

Definition at line 356 of file accessmanager.cpp.

---

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

• accessmanager.h
• accessmanager.cpp