diff options
| author | abcd <amos.choy@nokia.com> | 2012-08-24 15:12:41 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-28 09:00:19 +0200 |
| commit | 7dd46f8c96a4bdaca2809ff97b773f358392516f (patch) | |
| tree | 61f15a48c0e67af363bd524fda5af52fbea79fed | |
| parent | dac48f0417f818ef4e1ef8ba81be64def5154067 (diff) | |
| download | qtlocation-7dd46f8c96a4bdaca2809ff97b773f358392516f.tar.gz | |
Document how support for attributes may vary according to plugin
Change-Id: Ie0900821daabb7c6fbcc24550fb7dae7fb773710
Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
| -rw-r--r-- | src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp | 8 | ||||
| -rw-r--r-- | src/location/places/qplaceattribute.cpp | 8 |
2 files changed, 16 insertions, 0 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp index 8e114e51..bc98736f 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp @@ -77,6 +77,14 @@ perspective of the specified provider. \endtable + Some plugins may not support attributes at all, others may only support a + certain set, others still may support a dynamically changing set of attributes + over time or even allow attributes to be arbitrarily defined by the client + application. The attributes could also vary on a place by place basis, + for example one place may have opening hours while another does not. + Consult the \l {Plugin References and Parameters}{plugin + references} for details. + Some attributes may not be intended to be readable by end users, the label field of such attributes is empty to indicate this fact. diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp index a1fdf89f..1c4f51d4 100644 --- a/src/location/places/qplaceattribute.cpp +++ b/src/location/places/qplaceattribute.cpp @@ -83,6 +83,14 @@ bool QPlaceAttributePrivate::isEmpty() const localized label which describes the attribute and rich text string representing the attribute's value. Generally, both are intended to be displayed to the end-user as is. + Some plugins may not support attributes at all, others may only support a + certain set, others still may support a dynamically changing set of attributes + over time or even allow attributes to be arbitrarily defined by the client + application. The attributes could also vary on a place by place basis, + for example one place may have opening hours while another does not. + Consult the \l {Plugin References and Parameters}{plugin + references} for details. + \section2 Attribute Types The QPlaceAttribute class defines some constant strings which characterize standard \e {attribute types}. \list |