qnetworkcookie.h [include/QtNetwork/qnetworkcookie.h]

1	/****************************************************************************
2	**
3	** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4	** Contact: http://www.qt-project.org/
5	**
6	** This file is part of the QtNetwork module of the Qt Toolkit.
7	**
8	** $QT_BEGIN_LICENSE:LGPL$
9	** GNU Lesser General Public License Usage
10	** This file may be used under the terms of the GNU Lesser General Public
11	** License version 2.1 as published by the Free Software Foundation and
12	** appearing in the file LICENSE.LGPL included in the packaging of this
13	** file. Please review the following information to ensure the GNU Lesser
14	** General Public License version 2.1 requirements will be met:
15	** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16	**
17	** In addition, as a special exception, Nokia gives you certain additional
18	** rights. These rights are described in the Nokia Qt LGPL Exception
19	** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20	**
21	** GNU General Public License Usage
22	** Alternatively, this file may be used under the terms of the GNU General
23	** Public License version 3.0 as published by the Free Software Foundation
24	** and appearing in the file LICENSE.GPL included in the packaging of this
25	** file. Please review the following information to ensure the GNU General
26	** Public License version 3.0 requirements will be met:
27	** http://www.gnu.org/copyleft/gpl.html.
28	**
29	** Other Usage
30	** Alternatively, this file may be used in accordance with the terms and
31	** conditions contained in a signed written agreement between you and Nokia.
32	**
33	**
34	**
35	**
36	**
37	**
38	** $QT_END_LICENSE$
39	**
40	****************************************************************************/
41
42	#ifndef QNETWORKCOOKIE_H
43	#define QNETWORKCOOKIE_H
44
45	#include <QtCore/QSharedDataPointer>
46	#include <QtCore/QList>
47	#include <QtCore/QMetaType>
48	#include <QtCore/QObject>
49
50	QT_BEGIN_HEADER
51
52	QT_BEGIN_NAMESPACE
53
54	QT_MODULE(Network)
55
56	class QByteArray;
57	class QDateTime;
58	class QString;
59	class QUrl;
60
61	class QNetworkCookiePrivate;
62	class Q_NETWORK_EXPORT QNetworkCookie
63	{
64	public:
65	enum RawForm {
66	NameAndValueOnly,
67	Full
68	};
69
70	QNetworkCookie(const QByteArray &name = QByteArray(), const QByteArray &value = QByteArray());
71	QNetworkCookie(const QNetworkCookie &other);
72	~QNetworkCookie();
73	QNetworkCookie &operator=(const QNetworkCookie &other);
74	bool operator==(const QNetworkCookie &other) const;
75	inline bool operator!=(const QNetworkCookie &other) const
76	{ return !(*this == other); }
77
78	bool isSecure() const;
79	void setSecure(bool enable);
80	bool isHttpOnly() const;
81	void setHttpOnly(bool enable);
82
83	bool isSessionCookie() const;
84	QDateTime expirationDate() const;
85	void setExpirationDate(const QDateTime &date);
86
87	QString domain() const;
88	void setDomain(const QString &domain);
89
90	QString path() const;
91	void setPath(const QString &path);
92
93	QByteArray name() const;
94	void setName(const QByteArray &cookieName);
95
96	QByteArray value() const;
97	void setValue(const QByteArray &value);
98
99	QByteArray toRawForm(RawForm form = Full) const;
100
101	static QList<QNetworkCookie> parseCookies(const QByteArray &cookieString);
102
103	private:
104	QSharedDataPointer<QNetworkCookiePrivate> d;
105	friend class QNetworkCookiePrivate;
106	};
107	Q_DECLARE_TYPEINFO(QNetworkCookie, Q_MOVABLE_TYPE);
108
109	#ifndef QT_NO_DEBUG_STREAM
110	class QDebug;
111	Q_NETWORK_EXPORT QDebug operator<<(QDebug, const QNetworkCookie &);
112	#endif
113
114	QT_END_NAMESPACE
115
116	// ### Qt5 remove this include
117	#include <QtNetwork/QNetworkCookieJar>
118
119	Q_DECLARE_METATYPE(QNetworkCookie)
120	Q_DECLARE_METATYPE(QList<QNetworkCookie>)
121
122	QT_END_HEADER
123
124	#endif
125