KIO::Integration::CookieJar Class Reference

#include <accessmanager.h>

Inheritance diagram for KIO::Integration::CookieJar:

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
Public Member Functions inherited from QNetworkCookieJar
	QNetworkCookieJar (QObject *parent)
virtual	~QNetworkCookieJar ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QNetworkCookieJar
QList< QNetworkCookie >	allCookies () const
void	setAllCookies (const QList< QNetworkCookie > &cookieList)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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 278 of file accessmanager.h.

Constructor & Destructor Documentation

CookieJar::CookieJar ( QObject *  parent = 0 )

explicit

Constructs a KNetworkCookieJar with parent parent.

Definition at line 495 of file accessmanager.cpp.

CookieJar::~CookieJar

(

)

Destroys the KNetworkCookieJar.

Definition at line 501 of file accessmanager.cpp.

Member Function Documentation

QList< QNetworkCookie > CookieJar::cookiesForUrl ( const QUrl &  url ) const

virtual

Reimplemented for internal reasons, the API is not affected.

See also

QNetworkCookieJar::cookiesForUrl

Reimplemented from QNetworkCookieJar.

Definition at line 516 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 511 of file accessmanager.cpp.

void CookieJar::reparseConfiguration

(

)

Reparse the KDE cookiejar configuration file.

Definition at line 577 of file accessmanager.cpp.

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

virtual

Reimplemented for internal reasons, the API is not affected.

See also

QNetworkCookieJar::setCookiesFromUrl

Reimplemented from QNetworkCookieJar.

Definition at line 544 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 567 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 572 of file accessmanager.cpp.

WId CookieJar::windowId

(

)

const

Returns the currently set window id.

The default value is -1.

Definition at line 506 of file accessmanager.cpp.

---

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

• accessmanager.h
• accessmanager.cpp