Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
HelpNetworkAccessManager Class Reference
+ Inheritance diagram for HelpNetworkAccessManager:
+ Collaboration diagram for HelpNetworkAccessManager:

Public Member Functions

 HelpNetworkAccessManager (QObject *parent)
 
 HelpNetworkAccessManager (QObject *parent)
 
- Public Member Functions inherited from QNetworkAccessManager
 QNetworkAccessManager (QObject *parent=nullptr)
 Constructs a QNetworkAccessManager object that is the center of the Network Access API and sets parent as the parent object.
 
 ~QNetworkAccessManager ()
 Destroys the QNetworkAccessManager object and frees up any resources.
 
virtual QStringList supportedSchemes () const
 
void clearAccessCache ()
 
void clearConnectionCache ()
 
QNetworkProxy proxy () const
 Returns the QNetworkProxy that the requests sent using this QNetworkAccessManager object will use.
 
void setProxy (const QNetworkProxy &proxy)
 Sets the proxy to be used in future requests to be proxy.
 
QNetworkProxyFactoryproxyFactory () const
 
void setProxyFactory (QNetworkProxyFactory *factory)
 
QAbstractNetworkCachecache () const
 
void setCache (QAbstractNetworkCache *cache)
 
QNetworkCookieJarcookieJar () const
 Returns the QNetworkCookieJar that is used to store cookies obtained from the network as well as cookies that are about to be sent.
 
void setCookieJar (QNetworkCookieJar *cookieJar)
 Sets the manager's cookie jar to be the cookieJar specified.
 
void setStrictTransportSecurityEnabled (bool enabled)
 
bool isStrictTransportSecurityEnabled () const
 
void enableStrictTransportSecurityStore (bool enabled, const QString &storeDir=QString())
 
bool isStrictTransportSecurityStoreEnabled () const
 
void addStrictTransportSecurityHosts (const QList< QHstsPolicy > &knownHosts)
 
QList< QHstsPolicystrictTransportSecurityHosts () const
 
QNetworkReplyhead (const QNetworkRequest &request)
 Posts a request to obtain the network headers for request and returns a new QNetworkReply object which will contain such headers.
 
QNetworkReplyget (const QNetworkRequest &request)
 Posts a request to obtain the contents of the target request and returns a new QNetworkReply object opened for reading which emits the \l{QIODevice::readyRead()}{readyRead()} signal whenever new data arrives.
 
QNetworkReplyget (const QNetworkRequest &request, QIODevice *data)
 
QNetworkReplyget (const QNetworkRequest &request, const QByteArray &data)
 
QNetworkReplypost (const QNetworkRequest &request, QIODevice *data)
 Sends an HTTP POST request to the destination specified by request and returns a new QNetworkReply object opened for reading that will contain the reply sent by the server.
 
QNetworkReplypost (const QNetworkRequest &request, const QByteArray &data)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sends the contents of the data byte array to the destination specified by request.
 
QNetworkReplypost (const QNetworkRequest &request, std::nullptr_t)
 
QNetworkReplyput (const QNetworkRequest &request, QIODevice *data)
 Uploads the contents of data to the destination request and returns a new QNetworkReply object that will be open for reply.
 
QNetworkReplyput (const QNetworkRequest &request, const QByteArray &data)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sends the contents of the data byte array to the destination specified by request.
 
QNetworkReplyput (const QNetworkRequest &request, std::nullptr_t)
 
QNetworkReplydeleteResource (const QNetworkRequest &request)
 
QNetworkReplysendCustomRequest (const QNetworkRequest &request, const QByteArray &verb, QIODevice *data=nullptr)
 
QNetworkReplysendCustomRequest (const QNetworkRequest &request, const QByteArray &verb, const QByteArray &data)
 
void connectToHostEncrypted (const QString &hostName, quint16 port=443, const QSslConfiguration &sslConfiguration=QSslConfiguration::defaultConfiguration())
 
void connectToHostEncrypted (const QString &hostName, quint16 port, const QSslConfiguration &sslConfiguration, const QString &peerName)
 
void connectToHost (const QString &hostName, quint16 port=80)
 
void setRedirectPolicy (QNetworkRequest::RedirectPolicy policy)
 
QNetworkRequest::RedirectPolicy redirectPolicy () const
 
bool autoDeleteReplies () const
 
void setAutoDeleteReplies (bool autoDelete)
 
int transferTimeout () const
 
void setTransferTimeout (int timeout)
 
std::chrono::milliseconds transferTimeoutAsDuration () const
 
void setTransferTimeout (std::chrono::milliseconds duration=QNetworkRequest::DefaultTransferTimeout)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

QNetworkReplycreateRequest (Operation op, const QNetworkRequest &request, QIODevice *outgoingData=nullptr) override
 Returns a new QNetworkReply object to handle the operation op and request originalReq.
 
QNetworkReplycreateRequest (Operation op, const QNetworkRequest &request, QIODevice *outgoingData=nullptr) override
 Returns a new QNetworkReply object to handle the operation op and request originalReq.
 
- Protected Member Functions inherited from QNetworkAccessManager
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Public Types inherited from QNetworkAccessManager
enum  Operation {
  HeadOperation = 1 , GetOperation , PutOperation , PostOperation ,
  DeleteOperation , CustomOperation , UnknownOperation = 0
}
 Indicates the operation this reply is processing. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QNetworkAccessManager
void proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator)
 This signal is emitted whenever a proxy requests authentication and QNetworkAccessManager cannot find a valid, cached credential.
 
void authenticationRequired (QNetworkReply *reply, QAuthenticator *authenticator)
 This signal is emitted whenever a final server requests authentication before it delivers the requested contents.
 
void finished (QNetworkReply *reply)
 This signal is emitted whenever a pending network reply is finished.
 
void encrypted (QNetworkReply *reply)
 
void sslErrors (QNetworkReply *reply, const QList< QSslError > &errors)
 This signal is emitted if the SSL/TLS session encountered errors during the set up, including certificate verification errors.
 
void preSharedKeyAuthenticationRequired (QNetworkReply *reply, QSslPreSharedKeyAuthenticator *authenticator)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Slots inherited from QNetworkAccessManager
QStringList supportedSchemesImplementation () const
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 139 of file helpbrowsersupport.cpp.

Constructor & Destructor Documentation

◆ HelpNetworkAccessManager() [1/2]

HelpNetworkAccessManager::HelpNetworkAccessManager ( QObject * parent)

Definition at line 149 of file helpbrowsersupport.cpp.

References HelpNetworkAccessManager().

Referenced by HelpNetworkAccessManager(), and HelpBrowserSupport::createNetworkAccessManager().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ HelpNetworkAccessManager() [2/2]

HelpNetworkAccessManager::HelpNetworkAccessManager ( QObject * parent)

Member Function Documentation

◆ createRequest() [1/2]

QNetworkReply * HelpNetworkAccessManager::createRequest ( Operation op,
const QNetworkRequest & request,
QIODevice * outgoingData = nullptr )
overrideprotectedvirtual

Returns a new QNetworkReply object to handle the operation op and request originalReq.

The device outgoingData is always 0 for Get and Head requests, but is the value passed to post() and put() in those operations (the QByteArray variants will pass a QBuffer object).

The default implementation calls QNetworkCookieJar::cookiesForUrl() on the cookie jar set with setCookieJar() to obtain the cookies to be sent to the remote server.

The returned object must be in an open state.

Reimplemented from QNetworkAccessManager.

Definition at line 155 of file helpbrowsersupport.cpp.

References HelpBrowserSupport::resolveUrl(), HelpBrowserSupport::UrlLocalData, HelpBrowserSupport::UrlRedirect, and HelpBrowserSupport::UrlResolveError.

+ Here is the call graph for this function:

◆ createRequest() [2/2]

QNetworkReply * HelpNetworkAccessManager::createRequest ( Operation op,
const QNetworkRequest & request,
QIODevice * outgoingData = nullptr )
overrideprotectedvirtual

Returns a new QNetworkReply object to handle the operation op and request originalReq.

The device outgoingData is always 0 for Get and Head requests, but is the value passed to post() and put() in those operations (the QByteArray variants will pass a QBuffer object).

The default implementation calls QNetworkCookieJar::cookiesForUrl() on the cookie jar set with setCookieJar() to obtain the cookies to be sent to the remote server.

The returned object must be in an open state.

Reimplemented from QNetworkAccessManager.


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