QXmppDataForm.h
/*
* Copyright (C) 2008-2014 The QXmpp developers
*
* Author:
* Jeremy Lainé
*
* Source:
* https://github.com/qxmpp-project/qxmpp
*
* This file is a part of QXmpp library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
*/
#ifndef QXMPPDATAFORM_H
#define QXMPPDATAFORM_H
#include <QPair>
#include <QVariant>
#include "QXmppStanza.h"
class QXmppDataFormPrivate;
class QXmppDataFormFieldPrivate;
class QXmppDataFormMediaPrivate;
class QXMPP_EXPORT QXmppDataForm
{
public:
class QXMPP_EXPORT Media
{
public:
Media();
Media(const QXmppDataForm::Media &other);
~Media();
QXmppDataForm::Media& operator=(const QXmppDataForm::Media &other);
int height() const;
void setHeight(int height);
int width() const;
void setWidth(int width);
QList<QPair<QString, QString> > uris() const;
void setUris(const QList<QPair<QString, QString> > &uris);
bool isNull() const;
private:
QSharedDataPointer<QXmppDataFormMediaPrivate> d;
};
class QXMPP_EXPORT Field
{
public:
enum Type
{
BooleanField,
FixedField,
HiddenField,
JidMultiField,
JidSingleField,
ListMultiField,
ListSingleField,
TextMultiField,
TextPrivateField,
TextSingleField
};
Field(QXmppDataForm::Field::Type type = QXmppDataForm::Field::TextSingleField);
Field(const QXmppDataForm::Field &other);
~Field();
QXmppDataForm::Field& operator=(const QXmppDataForm::Field &other);
QString description() const;
void setDescription(const QString &description);
QString key() const;
void setKey(const QString &key);
QString label() const;
void setLabel(const QString &label);
Media media() const;
void setMedia(const Media &media);
QList<QPair<QString, QString> > options() const;
void setOptions(const QList<QPair<QString, QString> > &options);
bool isRequired() const;
void setRequired(bool required);
QXmppDataForm::Field::Type type() const;
void setType(QXmppDataForm::Field::Type type);
QVariant value() const;
void setValue(const QVariant &value);
private:
QSharedDataPointer<QXmppDataFormFieldPrivate> d;
};
enum Type
{
None,
Form,
Submit,
Cancel,
Result
};
QXmppDataForm(QXmppDataForm::Type type = QXmppDataForm::None);
QXmppDataForm(const QXmppDataForm &other);
~QXmppDataForm();
QXmppDataForm& operator=(const QXmppDataForm &other);
QString instructions() const;
void setInstructions(const QString &instructions);
QList<Field> fields() const;
QList<Field> &fields();
void setFields(const QList<QXmppDataForm::Field> &fields);
QString title() const;
void setTitle(const QString &title);
QXmppDataForm::Type type() const;
void setType(QXmppDataForm::Type type);
bool isNull() const;
void parse(const QDomElement &element);
void toXml(QXmlStreamWriter *writer) const;
private:
QSharedDataPointer<QXmppDataFormPrivate> d;
};
#endif
QXmppDataForm::Type
Type
This enum is used to describe a form&#39;s type.
Definition: QXmppDataForm.h:128
QXmppDataForm::None
Unknown form type.
Definition: QXmppDataForm.h:130
QXmppDataForm::Field::Type
Type
This enum is used to describe a field&#39;s type.
Definition: QXmppDataForm.h:79
QXmppDataForm
The QXmppDataForm class represents a data form as defined by XEP-0004: Data Forms.
Definition: QXmppDataForm.h:40
QXmppDataForm::Field
The QXmppDataForm::Field class represents a data form field as defined by XEP-0004: Data Forms...
Definition: QXmppDataForm.h:75
QXmppDataForm::Media
The QXmppDataForm::Media class represents a media field as defined by XEP-0221: Data Forms Media Elem...
Definition: QXmppDataForm.h:47