diff options
author | Alex Blasche <alexander.blasche@digia.com> | 2013-07-01 15:14:32 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-07-12 15:00:17 +0200 |
commit | 7197e14116c4e214efc5e8c6a0a6ab6a7990a634 (patch) | |
tree | 4d62acc4500124042e8fd7978c5e601d42d775dd /src/location/doc/src/cpp-qml.qdoc | |
parent | c955dcea2df9378a45d53d5556a1f726bcf05306 (diff) | |
download | qtlocation-7197e14116c4e214efc5e8c6a0a6ab6a7990a634.tar.gz |
Fix QtLocation documentation
This moves the docs to its proper place and fixes content as well as
broken links.
There are still some warnings left.
Change-Id: Ie83086f4feabab5f3b3d6c92eb6b401a5ff43e29
Reviewed-by: Alex <alexander.blasche@digia.com>
Diffstat (limited to 'src/location/doc/src/cpp-qml.qdoc')
-rw-r--r-- | src/location/doc/src/cpp-qml.qdoc | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/src/location/doc/src/cpp-qml.qdoc b/src/location/doc/src/cpp-qml.qdoc new file mode 100644 index 00000000..3e38edb0 --- /dev/null +++ b/src/location/doc/src/cpp-qml.qdoc @@ -0,0 +1,145 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page location-cpp-qml.html +\title Interfaces between C++ and QML Code + +\brief Some of the location QML types providing interfaces to access and modify properties in C++. + +\section2 Category - QPlaceCategory +\target category +The \l {Category::category} {Category.category} property is used to provide an interface between C++ and QML code. First a pointer to a +Category object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c category property. +The following gets the QPlaceCategory representing this object from C++: +\snippet cpp/cppqml.cpp Category get +The following sets the properties of this object based on a QPlaceCategory object from C++: +\snippet cpp/cppqml.cpp Category set + + +\section2 ContactDetail - QDeclarativeContactDetail +\target contact_detail +The \l {ContactDetail::contactDetail} {ContactDetail.contactDetail} property is used to provide an interface between C++ and QML code. First a pointer to a ContactDetail object must be obtained from C++, then use the +\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions +to get and set the \c contactDetail property. +The following gets the QPlaceContactDetail representing this object from C++: +\snippet cpp/cppqml.cpp ContactDetail get +The following sets the properties of this object based on a QPlaceContactDetail object from +C++: +\snippet cpp/cppqml.cpp ContactDetail set + + +\section2 Place - QPlace +\target place +The \l {Place::place} {Place.place} property is used to provide an interface between C++ and QML code. First a pointer to a Place object must be obtained from C++, then use the +\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions +to get and set the \c place property. +The following gets the QPlace representing this object from C++: +\snippet cpp/cppqml.cpp Place get +The following sets the properties of this object based on a QPlace object from C++: +\snippet cpp/cppqml.cpp Place set + + + +\section2 PlaceAttribute - QPlaceAttribute +\target placeattribute +The \l {PlaceAttribute::attribute} {PlaceAttribute.attribute} property is used to provide an interface between C++ and QML code. First a pointer to a +PlaceAttribute object must be obtained from C++, then use the +\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions +to get and set the \c attribute property. +The following gets the QPlaceAttribute representing this object from C++: +\snippet cpp/cppqml.cpp PlaceAttribute get +The following sets the properties of this object based on a QPlaceAttribute object from C++: +\snippet cpp/cppqml.cpp PlaceAttribute set + + +\section2 Icon - QPlaceIcon +\target placeicon +The \l {Icon::icon} {Icon.icon} property is used to provide an interface between C++ and QML code. First a pointer to a Icon object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c icon property. +The following gets the QPlaceIcon representing this object from C++: +\snippet cpp/cppqml.cpp Icon get +The following sets the properties of this object based on a QPlaceIcon object from C++: +\snippet cpp/cppqml.cpp Icon set + + +\section2 User - QPlaceUser +\target placeuser +The \l {User::user} {User.user} property is used to provide an interface between C++ and QML code. First a pointer to a +User object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c user property. +The following gets the QPlaceUser representing this object from C++: +\snippet cpp/cppqml.cpp User get +The following sets the properties of this object based on a QPlaceUser object from C++: +\snippet cpp/cppqml.cpp User set + + +\section2 Ratings - QPlaceRatings +\target placeratings +The \l {Ratings::ratings} {Ratings.ratings} property is used to provide an interface between C++ and QML code. First a pointer to a +Ratings object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c ratings property. +The following gets the QPlaceRating representing this object from C++: +\snippet cpp/cppqml.cpp Ratings get +The following sets the properties of this object based on a QPlaceRatings object from C++: +\snippet cpp/cppqml.cpp Ratings set + + +\section2 Supplier - QPlaceSupplier +\target placesupplier +The \l {Supplier::supplier} {Supplier.supplier} property is used to provide an interface between C++ and QML code. First a pointer to a +Supplier object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c supplier property. +The following gets the QPlaceSupplier representing this object from C++: +\snippet cpp/cppqml.cpp Supplier get +The following sets the properties of this object based on a QPlaceSupplier object from C++: +\snippet cpp/cppqml.cpp Supplier set + + +\section2 Address - QGeoAddress +\target geoaddress +The \l {Address::address} {Address.address} property is used to provide an interface between C++ and QML code. First a pointer to a +Address object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c address property. +The following gets the QGeoAddress representing this object from C++: +\snippet cpp/cppqml.cpp Address get +The following sets the properties of this object based on a QGeoAddress object from C++: +\snippet cpp/cppqml.cpp Address set + + +\section2 Location - QGeoLocation +\target location +The \l {Location::location} {Location.location} property is used to provide an interface between C++ and QML code. First a pointer to a +Location object must be obtained from C++, then use the \l {QObject::property()}{property()} and +\l {QObject::setProperty()}{setProperty()} functions to get and set the \c location property. +The following gets the QGeoLocation representing this object from C++: +\snippet cpp/cppqml.cpp Location get +The following sets the properties of this object based on a QGeoLocation object from C++: +\snippet cpp/cppqml.cpp Location set + +*/ |