Qt 4.8
Public Types | Public Functions | Friends | List of all members
QHttpMultiPart Class Reference

The QHttpMultiPart class resembles a MIME multipart message to be sent over HTTP. More...

#include <qhttpmultipart.h>

Inheritance diagram for QHttpMultiPart:
QObject

Public Types

enum  ContentType { MixedType, RelatedType, FormDataType, AlternativeType }
 List of known content types for a multipart subtype as described in RFC 2046 and others. More...
 

Public Functions

void append (const QHttpPart &httpPart)
 Appends httpPart to this multipart. More...
 
QByteArray boundary () const
 returns the boundary. More...
 
 QHttpMultiPart (QObject *parent=0)
 Constructs a QHttpMultiPart with content type MixedType and sets parent as the parent object. More...
 
 QHttpMultiPart (ContentType contentType, QObject *parent=0)
 Constructs a QHttpMultiPart with content type contentType and sets parent as the parent object. More...
 
void setBoundary (const QByteArray &boundary)
 Sets the boundary to boundary. More...
 
void setContentType (ContentType contentType)
 Sets the content type to contentType. More...
 
 ~QHttpMultiPart ()
 Destroys the multipart. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) 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. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
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. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Friends

class QNetworkAccessManager
 
class QNetworkAccessManagerPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QHttpMultiPart class resembles a MIME multipart message to be sent over HTTP.

Since
4.8
Attention
Module: QtNetwork

The QHttpMultiPart resembles a MIME multipart message, as described in RFC 2046, which is to be sent over HTTP. A multipart message consists of an arbitrary number of body parts (see QHttpPart), which are separated by a unique boundary. The boundary of the QHttpMultiPart is constructed with the string "boundary_.oOo._" followed by random characters, and provides enough uniqueness to make sure it does not occur inside the parts itself. If desired, the boundary can still be set via setBoundary().

As an example, consider the following code snippet, which constructs a multipart message containing a text part followed by an image part:

QHttpPart textPart;
textPart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"text\""));
textPart.setBody("my text");
QHttpPart imagePart;
imagePart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"image\""));
QFile *file = new QFile("image.jpg");
imagePart.setBodyDevice(file);
file->setParent(multiPart); // we cannot delete the file now, so delete it with the multiPart
multiPart->append(textPart);
multiPart->append(imagePart);
QUrl url("http://my.server.tld");
QNetworkRequest request(url);
QNetworkReply *reply = manager.post(request, multiPart);
multiPart->setParent(reply); // delete the multiPart with the reply
// here connect signals etc.
See also
QHttpPart, QNetworkAccessManager::post()

Definition at line 83 of file qhttpmultipart.h.

Enumerations

◆ ContentType

List of known content types for a multipart subtype as described in RFC 2046 and others.

  • MixedType corresponds to the "multipart/mixed" subtype, meaning the body parts are independent of each other, as described in RFC 2046.
  • RelatedType corresponds to the "multipart/related" subtype, meaning the body parts are related to each other, as described in RFC 2387.
  • FormDataType corresponds to the "multipart/form-data" subtype, meaning the body parts contain form elements, as described in RFC 2388.
  • AlternativeType corresponds to the "multipart/alternative" subtype, meaning the body parts are alternative representations of the same information, as described in RFC 2046.
See also
setContentType()
Enumerator
MixedType 
RelatedType 
FormDataType 
AlternativeType 

Definition at line 89 of file qhttpmultipart.h.

Constructors and Destructors

◆ QHttpMultiPart() [1/2]

QHttpMultiPart::QHttpMultiPart ( QObject parent = 0)

Constructs a QHttpMultiPart with content type MixedType and sets parent as the parent object.

See also
QHttpMultiPart::ContentType

Definition at line 275 of file qhttpmultipart.cpp.

275  : QObject(*new QHttpMultiPartPrivate, parent)
276 {
278  d->contentType = MixedType;
279 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753
The QHttpMultiPart class resembles a MIME multipart message to be sent over HTTP. ...

◆ QHttpMultiPart() [2/2]

QHttpMultiPart::QHttpMultiPart ( QHttpMultiPart::ContentType  contentType,
QObject parent = 0 
)

Constructs a QHttpMultiPart with content type contentType and sets parent as the parent object.

See also
QHttpMultiPart::ContentType

Definition at line 287 of file qhttpmultipart.cpp.

287  : QObject(*new QHttpMultiPartPrivate, parent)
288 {
290  d->contentType = contentType;
291 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753
The QHttpMultiPart class resembles a MIME multipart message to be sent over HTTP. ...

◆ ~QHttpMultiPart()

QHttpMultiPart::~QHttpMultiPart ( )

Destroys the multipart.

Definition at line 296 of file qhttpmultipart.cpp.

297 {
298 }

Functions

◆ append()

void QHttpMultiPart::append ( const QHttpPart httpPart)

Appends httpPart to this multipart.

Definition at line 303 of file qhttpmultipart.cpp.

304 {
305  d_func()->parts.append(httpPart);
306 }

◆ boundary()

QByteArray QHttpMultiPart::boundary ( ) const

returns the boundary.

See also
setBoundary()

Definition at line 330 of file qhttpmultipart.cpp.

Referenced by QNetworkAccessManagerPrivate::prepareMultipart(), and setBoundary().

331 {
332  return d_func()->boundary;
333 }

◆ setBoundary()

void QHttpMultiPart::setBoundary ( const QByteArray boundary)

Sets the boundary to boundary.

Usually, you do not need to generate a boundary yourself; upon construction the boundary is initiated with the string "boundary_.oOo._" followed by random characters, and provides enough uniqueness to make sure it does not occur inside the parts itself.

See also
boundary()

Definition at line 345 of file qhttpmultipart.cpp.

346 {
347  d_func()->boundary = boundary;
348 }
QByteArray boundary() const
returns the boundary.

◆ setContentType()

void QHttpMultiPart::setContentType ( QHttpMultiPart::ContentType  contentType)

Sets the content type to contentType.

The content type will be used in the HTTP header section when sending the multipart message via QNetworkAccessManager::post(). In case you want to use a multipart subtype not contained in QHttpMultiPart::ContentType, you can add the "Content-Type" header field to the QNetworkRequest by hand, and then use this request together with the multipart message for posting.

See also
QHttpMultiPart::ContentType, QNetworkAccessManager::post()

Definition at line 320 of file qhttpmultipart.cpp.

321 {
322  d_func()->contentType = contentType;
323 }

Friends and Related Functions

◆ QNetworkAccessManager

Definition at line 111 of file qhttpmultipart.h.

◆ QNetworkAccessManagerPrivate

Definition at line 112 of file qhttpmultipart.h.


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