summaryrefslogtreecommitdiffstats
path: root/src/3rdparty/webkit/WebKit/qt/Api/qwebelement.h
blob: 7e56d0ff0523ee978c225e5923d545a70c2ad148 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
    Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef QWEBELEMENT_H
#define QWEBELEMENT_H

#include <QString>
#include <QRect>
#include <QVariant>
#include <QExplicitlySharedDataPointer>

#include "qwebkitglobal.h"
namespace WebCore {
    class Element;
    class Node;
}

class QWebFrame;
class QWebElementPrivate;

class QWEBKIT_EXPORT QWebElement
{
public:
    QWebElement();
    QWebElement(const QWebElement &);
    QWebElement &operator=(const QWebElement &);
    ~QWebElement();

    bool operator==(const QWebElement& o) const;
    bool operator!=(const QWebElement& o) const;

    bool isNull() const;

    QList<QWebElement> findAll(const QString &selectorQuery) const;
    QWebElement findFirst(const QString &selectorQuery) const;

    void setPlainText(const QString &text);
    QString toPlainText() const;

    void setOuterXml(const QString &markup);
    QString toOuterXml() const;

    void setInnerXml(const QString &markup);
    QString toInnerXml() const;

    void setAttribute(const QString &name, const QString &value);
    void setAttributeNS(const QString &namespaceUri, const QString &name, const QString &value);
    QString attribute(const QString &name, const QString &defaultValue = QString()) const;
    QString attributeNS(const QString &namespaceUri, const QString &name, const QString &defaultValue = QString()) const;
    bool hasAttribute(const QString &name) const;
    bool hasAttributeNS(const QString &namespaceUri, const QString &name) const;
    void removeAttribute(const QString &name);
    void removeAttributeNS(const QString &namespaceUri, const QString &name);
    bool hasAttributes() const;

    QStringList classes() const;
    bool hasClass(const QString &name) const;
    void addClass(const QString &name);
    void removeClass(const QString &name);
    void toggleClass(const QString &name);

    QRect geometry() const;

    QString tagName() const;
    QString prefix() const;
    QString localName() const;
    QString namespaceUri() const;

    QWebElement parent() const;
    QWebElement firstChild() const;
    QWebElement lastChild() const;
    QWebElement nextSibling() const;
    QWebElement previousSibling() const;
    QWebElement document() const;
    QWebFrame *webFrame() const;

    // TODO: Add QList<QWebElement> overloads
    // docs need example snippet
    void appendInside(const QString &markup);
    void appendInside(const QWebElement &element);

    // docs need example snippet
    void prependInside(const QString &markup);
    void prependInside(const QWebElement &element);

    // docs need example snippet
    void appendOutside(const QString &markup);
    void appendOutside(const QWebElement &element);

    // docs need example snippet
    void prependOutside(const QString &markup);
    void prependOutside(const QWebElement &element);

    // docs need example snippet
    void encloseContentsWith(const QWebElement &element);
    void encloseContentsWith(const QString &markup);
    void encloseWith(const QString &markup);
    void encloseWith(const QWebElement &element);

    void replace(const QString &markup);
    void replace(const QWebElement &element);

    QWebElement clone() const;
    QWebElement &takeFromDocument();
    void removeFromDocument();
    void removeChildren();

    QVariant evaluateScript(const QString& scriptSource);

    QVariant callFunction(const QString &functionName, const QVariantList &arguments = QVariantList());
    QStringList functions() const;

    QVariant scriptableProperty(const QString &name) const;
    void setScriptableProperty(const QString &name, const QVariant &value);
    QStringList scriptableProperties() const;

    enum ResolveRule { IgnoreCascadingStyles, RespectCascadingStyles };
    QString styleProperty(const QString &name, ResolveRule = IgnoreCascadingStyles) const;

    enum StylePriority { NormalStylePriority, DeclaredStylePriority, ImportantStylePriority };
    void setStyleProperty(const QString &name, const QString &value, StylePriority = DeclaredStylePriority);

    QString computedStyleProperty(const QString &name) const;

private:
    explicit QWebElement(WebCore::Element *domElement);
    explicit QWebElement(WebCore::Node *node);

    friend class QWebFrame;
    friend class QWebHitTestResult;
    friend class QWebHitTestResultPrivate;

    QWebElementPrivate *d;
    WebCore::Element *m_element;
};

#endif // QWEBELEMENT_H