QtNetwork/qnetworkcookie.h Source File

qnetworkcookie.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtNetwork module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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 
51 
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 {
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:
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 
115 
116 // ### Qt5 remove this include
117 #include <QtNetwork/QNetworkCookieJar>
118 
119 Q_DECLARE_METATYPE(QNetworkCookie)
120 Q_DECLARE_METATYPE(QList<QNetworkCookie>)
121 
123 
124 #endif
#define QT_END_NAMESPACE
Definition: qglobal.h:128
#define QT_BEGIN_HEADER
Definition: qglobal.h:141
Definition: qdebug.h:62
#define Q_DECLARE_METATYPE(TYPE)
Definition: qmetatype.h:265
bool operator==(const Attribute &cA, const AttributeInstance< type > &cB)
This operator compares the two attributes and NOT their values.
Definition: node.h:577
#define QT_BEGIN_NAMESPACE
Definition: qglobal.h:127
Q_NETWORK_EXPORT QDebug operator<<(QDebug, const QNetworkCookie &)
GLsizei const GLfloat * value
Definition: GLee.h:1742
Definition: qurl.h:61
GLuint const GLchar * name
Definition: GLee.h:1704
#define QT_END_HEADER
Definition: qglobal.h:142
Q_DECLARE_TYPEINFO(QNetworkCookie, Q_MOVABLE_TYPE)