summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qfxview.cpp
diff options
context:
space:
mode:
authorIan Walters <ian.walters@nokia.com>2009-04-30 00:18:49 (GMT)
committerIan Walters <ian.walters@nokia.com>2009-04-30 00:18:49 (GMT)
commit54839beaabb62da8ca238b64683b56e66e1ff10b (patch)
tree184394839eaf3769c37d4f38fea603f93d915ea8 /src/declarative/util/qfxview.cpp
parent7a60538c0c12245e8b542a477bcaabac0b9de345 (diff)
parent4f98e50ef93f213cc47e5f49cd844b27b8115f99 (diff)
downloadQt-54839beaabb62da8ca238b64683b56e66e1ff10b.zip
Qt-54839beaabb62da8ca238b64683b56e66e1ff10b.tar.gz
Qt-54839beaabb62da8ca238b64683b56e66e1ff10b.tar.bz2
Merge branch 'kinetic-declarativeui' of git@scm.dev.nokia.troll.no:qt/kinetic into kinetic-declarativeui
Conflicts: examples/declarative/tutorials/contacts/1_Drawing_and_Animation/RemoveButton2.qml examples/declarative/tutorials/contacts/1_Drawing_and_Animation/RemoveButton3.qml examples/declarative/tutorials/contacts/1_Drawing_and_Animation/RemoveButton4.qml examples/declarative/tutorials/contacts/1_Drawing_and_Animation/RemoveButton5.qml examples/declarative/tutorials/contacts/2_Reuse/ContactField1.qml examples/declarative/tutorials/contacts/2_Reuse/ContactField2.qml examples/declarative/tutorials/contacts/2_Reuse/ContactField3.qml examples/declarative/tutorials/contacts/2_Reuse/ContactField4.qml examples/declarative/tutorials/contacts/2_Reuse/FieldText3.qml examples/declarative/tutorials/contacts/2_Reuse/FieldText4.qml examples/declarative/tutorials/contacts/2_Reuse/RemoveButton1.qml examples/declarative/tutorials/contacts/2_Reuse/RemoveButton2.qml examples/declarative/tutorials/contacts/2_Reuse/RemoveButton3.qml examples/declarative/tutorials/contacts/2_Reuse/RemoveButton4.qml examples/declarative/tutorials/contacts/3_Collections/Button.qml examples/declarative/tutorials/contacts/3_Collections/ContactField.qml examples/declarative/tutorials/contacts/3_Collections/FieldText.qml examples/declarative/tutorials/contacts/3_Collections/RemoveButton.qml
Diffstat (limited to 'src/declarative/util/qfxview.cpp')
-rw-r--r--src/declarative/util/qfxview.cpp38
1 files changed, 35 insertions, 3 deletions
diff --git a/src/declarative/util/qfxview.cpp b/src/declarative/util/qfxview.cpp
index 1e9d5a4..e285890 100644
--- a/src/declarative/util/qfxview.cpp
+++ b/src/declarative/util/qfxview.cpp
@@ -107,10 +107,10 @@ public:
\class QFxView
\brief The QFxView class provides a widget for displaying a Qt Declarative user interface.
- QFxView currently provides a minimal interface for displaying Qml files, and
- connecting between QML and C++ Qt objects.
+ QFxView currently provides a minimal interface for displaying QML
+ files, and connecting between QML and C++ Qt objects.
- Typcial usage looks something like this:
+ Typcial usage:
\code
...
QFxView *view = new QFxView(this);
@@ -129,12 +129,24 @@ public:
\endcode
*/
+/*!
+ \fn QFxView::QFxView(QWidget *parent)
+
+ Constructs a QFxView with the given \a parent.
+*/
QFxView::QFxView(QWidget *parent)
: QSimpleCanvas(parent), d(new QFxViewPrivate(this))
{
d->init();
}
+/*!
+ \fn QFxView::QFxView(QSimpleCanvas::CanvasMode mode, QWidget *parent)
+
+ Constructs a QFxView with the given \a parent. The canvas
+ \a mode can be QSimpleCanvas::GraphicsView or
+ QSimpleCanvas::SimpleCanvas.
+*/
QFxView::QFxView(QSimpleCanvas::CanvasMode mode, QWidget *parent)
: QSimpleCanvas(mode, parent), d(new QFxViewPrivate(this))
{
@@ -157,29 +169,49 @@ void QFxViewPrivate::init()
QFontDatabase database;
}
+/*!
+ The destructor clears the instance and deletes the internal
+ representation.
+
+ \sa clearItems()
+ */
QFxView::~QFxView()
{
clearItems();
delete d; d = 0;
}
+/*!
+ Sets the source to the \a url. The XML string is set to
+ empty.
+ */
void QFxView::setUrl(const QUrl& url)
{
d->source = url;
d->xml = QString();
}
+/*!
+ Sets the source to the URL from the \a filename, and sets
+ the XML string to \a xml.
+ */
void QFxView::setXml(const QString &xml, const QString &filename)
{
d->source = QUrl::fromLocalFile(filename);
d->xml = xml;
}
+/*!
+ Returns the XML string.
+ */
QString QFxView::xml() const
{
return d->xml;
}
+/*!
+ Returns a pointer to the QmlEngine.
+ */
QmlEngine* QFxView::engine()
{
return &d->engine;