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

KIO

  • KIO
  • AccessManager
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KIO::AccessManager Class Reference

#include <accessmanager.h>

Inheritance diagram for KIO::AccessManager:
Inheritance graph
[legend]

Public Types

enum  Attribute { MetaData = QNetworkRequest::User, KioError }
 

Public Member Functions

 AccessManager (QObject *parent)
 
virtual ~AccessManager ()
 
WId cookieJarWindowid () const
 
bool isExternalContentAllowed () const
 
KIO::MetaData & requestMetaData ()
 
KIO::MetaData & sessionMetaData ()
 
void setCookieJarWindowId (WId id)
 
void setEmitReadyReadOnMetaDataChange (bool)
 
void setExternalContentAllowed (bool allowed)
 
void setWindow (QWidget *widget)
 
QWidget * window () const
 
- Public Member Functions inherited from QNetworkAccessManager
 QNetworkAccessManager (QObject *parent)
 
 ~QNetworkAccessManager ()
 
QNetworkConfiguration activeConfiguration () const
 
void authenticationRequired (QNetworkReply *reply, QAuthenticator *authenticator)
 
QAbstractNetworkCache * cache () const
 
QNetworkConfiguration configuration () const
 
QNetworkCookieJar * cookieJar () const
 
QNetworkReply * deleteResource (const QNetworkRequest &request)
 
void finished (QNetworkReply *reply)
 
QNetworkReply * get (const QNetworkRequest &request)
 
QNetworkReply * head (const QNetworkRequest &request)
 
NetworkAccessibility networkAccessible () const
 
void networkAccessibleChanged (QNetworkAccessManager::NetworkAccessibility accessible)
 
QNetworkReply * post (const QNetworkRequest &request, QHttpMultiPart *multiPart)
 
QNetworkReply * post (const QNetworkRequest &request, QIODevice *data)
 
QNetworkReply * post (const QNetworkRequest &request, const QByteArray &data)
 
QNetworkProxy proxy () const
 
void proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator)
 
QNetworkProxyFactory * proxyFactory () const
 
QNetworkReply * put (const QNetworkRequest &request, QIODevice *data)
 
QNetworkReply * put (const QNetworkRequest &request, const QByteArray &data)
 
QNetworkReply * put (const QNetworkRequest &request, QHttpMultiPart *multiPart)
 
QNetworkReply * sendCustomRequest (const QNetworkRequest &request, const QByteArray &verb, QIODevice *data)
 
void setCache (QAbstractNetworkCache *cache)
 
void setConfiguration (const QNetworkConfiguration &config)
 
void setCookieJar (QNetworkCookieJar *cookieJar)
 
void setNetworkAccessible (NetworkAccessibility accessible)
 
void setProxy (const QNetworkProxy &proxy)
 
void setProxyFactory (QNetworkProxyFactory *factory)
 
void sslErrors (QNetworkReply *reply, const QList< QSslError > &errors)
 
- 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
 

Static Public Member Functions

static void putReplyOnHold (QNetworkReply *reply)
 
- 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

virtual QNetworkReply * createRequest (Operation op, const QNetworkRequest &req, QIODevice *outgoingData=0)
 
- 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)
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QNetworkAccessManager
 networkAccessible
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A KDE implementation of QNetworkAccessManager.

Use this class instead of QNetworkAccessManager if you want to integrate with KDE's KIO and KCookieJar modules for network operations and cookie handling respectively.

Here is a simple example that shows how to set the QtWebKit module to use KDE's KIO for its network operations:

QWebView *view = new QWebView(this);
KIO::Integration::AccessManager *manager = new KIO::Integration::AccessManager(view);
view->page()->setNetworkAccessManager(manager);

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

KIO::Integration::AccessManager *manager = qobject_cast<KIO::Integration::AccessManager*>(view->page()->accessManager());

Please note that this class is in the KIO namespace for backward compatablity. You should use KIO::Integration::AccessManager to access this class in your code.

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

Author
Urs Wolfer <uwolfer @ kde.org>
Dawit Alemayehu <adawit @ kde.org>
Deprecated:
Use the KIO::Integration::AccessManager typedef to access this class instead.
Since
4.3

Definition at line 73 of file accessmanager.h.

Member Enumeration Documentation

enum KIO::AccessManager::Attribute

Extensions to QNetworkRequest::Attribute enums.

Since
4.3.2
Enumerator
MetaData 
KioError 

< Used to send KIO MetaData back and forth.

type: QVariant::Map. Used to send KIO error codes that cannot be mapped into QNetworkReply::NetworkError. type: QVariant::Int

Definition at line 81 of file accessmanager.h.

Constructor & Destructor Documentation

AccessManager::AccessManager ( QObject *  parent)

Constructor.

Definition at line 115 of file accessmanager.cpp.

AccessManager::~AccessManager ( )
virtual

Destructor.

Definition at line 122 of file accessmanager.cpp.

Member Function Documentation

WId AccessManager::cookieJarWindowid ( ) const

Returns the cookiejar's window id.

This is a convenience function that returns the window id associated with the cookiejar. Note that this function will return a 0 if the cookiejar is not of type KIO::Integration::CookieJar or a window id has not yet been set.

See also
KIO::Integration::CookieJar::windowId.
Since
4.4
Deprecated:
Use KIO::Integration::CookieJar::windowId

Definition at line 173 of file accessmanager.cpp.

QNetworkReply * AccessManager::createRequest ( Operation  op,
const QNetworkRequest &  req,
QIODevice *  outgoingData = 0 
)
protectedvirtual

Reimplemented for internal reasons, the API is not affected.

See also
QNetworkAccessManager::createRequest

Reimplemented from QNetworkAccessManager.

Definition at line 213 of file accessmanager.cpp.

bool AccessManager::isExternalContentAllowed ( ) const

Returns true if external content is going to be fetched.

See also
setExternalContentAllowed

Definition at line 132 of file accessmanager.cpp.

void AccessManager::putReplyOnHold ( QNetworkReply *  reply)
static

Puts the ioslave associated with the given reply on hold.

This function is intended to make possible the implementation of the special case mentioned in KIO::get's documentation within the KIO-QNAM integration.

See also
KIO::get.
Since
4.6

Definition at line 198 of file accessmanager.cpp.

KIO::MetaData & AccessManager::requestMetaData ( )

Returns a reference to the temporary meta data container.

See kdelibs/kio/DESIGN.metadata for list of supported KIO meta data.

Use this function when you want to set per request KIO meta data that will be removed after it has been sent once.

Since
4.4

Definition at line 188 of file accessmanager.cpp.

KIO::MetaData & AccessManager::sessionMetaData ( )

Returns a reference to the persistent meta data container.

See kdelibs/kio/DESIGN.metadata for list of supported KIO meta data.

Use this function when you want to set per session KIO meta data that will be sent with every request.

Unlike requestMetaData, the meta data values set using the reference returned by this function will not be deleted and will be sent with every request.

Since
4.4

Definition at line 193 of file accessmanager.cpp.

void AccessManager::setCookieJarWindowId ( WId  id)

Sets the cookiejar's window id to id.

This is a convenience function that allows you to set the cookiejar's window id. Note that this function does nothing unless the cookiejar in use is of type KIO::Integration::CookieJar.

By default the cookiejar's window id is set to false. Make sure you call this function and set the window id to its proper value when create an instance of this object. Otherwise, the KDE cookiejar will not be able to properly manage session based cookies.

See also
KIO::Integration::CookieJar::setWindowId.
Since
4.4
Deprecated:
Use setWindow

Definition at line 138 of file accessmanager.cpp.

void AccessManager::setEmitReadyReadOnMetaDataChange ( bool  enable)

Sets the network reply object to emit readyRead when it receives meta data.

Meta data is any information that is not the actual content itself, e.g. HTTP response headers of the HTTP protocol.

Calling this function will force the code connecting to QNetworkReply's readyRead signal to prematurely start dealing with the content that might not yet have arrived. However, it is essential to make the put ioslave on hold functionality of KIO work in libraries like QtWebKit.

See also
QNetworkReply::metaDataChanged
Since
4.7

Definition at line 208 of file accessmanager.cpp.

void AccessManager::setExternalContentAllowed ( bool  allowed)

Set allowed to false if you don't want any external content to be fetched.

By default external content is fetched.

Definition at line 127 of file accessmanager.cpp.

void AccessManager::setWindow ( QWidget *  widget)

Sets the window associated with this network access manager.

Note that widget will be used as a parent for dialogs in KIO as well as the cookie jar. If widget is not a window, this function will invoke QWidget::window() to obtain the window for the given widget.

See also
KIO::Integration::CookieJar::setWindow.
Since
4.7

Definition at line 154 of file accessmanager.cpp.

QWidget * AccessManager::window ( ) const

Returns the window associated with this network access manager.

See also
setWindow
Since
4.7

Definition at line 183 of file accessmanager.cpp.


The documentation for this class was generated from the following files:
  • accessmanager.h
  • accessmanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:24:55 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal