Using QSettings in QML with also json and XML support - Revision history

Hamishwillee: Text replace - "`" to ""`


2012-10-11T01:18:49Z
Text replace - "<code cpp>" to "<code cpp-qt>"

			
			
			
			
		
		← Older revision
		Revision as of 01:18, 11 October 2012
		
Line 32:
Line 32:
    
  Start copying {{Icode|setting.cpp}} and {{Icode|setting.h}} into your project source directory. In the {{Icode|main.cpp}} file include the .h:   Start copying {{Icode|setting.cpp}} and {{Icode|setting.h}} into your project source directory. In the {{Icode|main.cpp}} file include the .h:
− <code cpp> + <code cpp-qt>
  #include "setting.h"   #include "setting.h"
  </code>   </code>
  the register the context property   the register the context property
− <code cpp> + <code cpp-qt>
  Settings settings(appName, fileName);   Settings settings(appName, fileName);
  viewer.rootContext()->setContextProperty("settings", &settings);   viewer.rootContext()->setContextProperty("settings", &settings);
  </code>   </code>
  fileName will be create as follow:   fileName will be create as follow:
− <code cpp> + <code cpp-qt>
  QDesktopServices::storageLocation( QDesktopServices::DataLocation ) + "/" + appName + "/" + fileName;   QDesktopServices::storageLocation( QDesktopServices::DataLocation ) + "/" + appName + "/" + fileName;
  </code>   </code>



Croozeus: Croozeus - /* Usage */ Added appropriate code highlights
2012-05-13T18:00:54Z
Croozeus - - Usage:  Added appropriate code highlights

			
			
			
			
		
		← Older revision
		Revision as of 18:00, 13 May 2012
		
Line 32:
Line 32:
    
  Start copying {{Icode|setting.cpp}} and {{Icode|setting.h}} into your project source directory. In the {{Icode|main.cpp}} file include the .h:   Start copying {{Icode|setting.cpp}} and {{Icode|setting.h}} into your project source directory. In the {{Icode|main.cpp}} file include the .h:
− <code> + <code cpp>
  #include "setting.h"   #include "setting.h"
  </code>   </code>
  the register the context property   the register the context property
− <code> + <code cpp>
  Settings settings(appName, fileName);   Settings settings(appName, fileName);
  viewer.rootContext()->setContextProperty("settings", &settings);   viewer.rootContext()->setContextProperty("settings", &settings);
  </code>   </code>
  fileName will be create as follow:   fileName will be create as follow:
− <code> + <code cpp>
  QDesktopServices::storageLocation( QDesktopServices::DataLocation ) + "/" + appName + "/" + fileName;   QDesktopServices::storageLocation( QDesktopServices::DataLocation ) + "/" + appName + "/" + fileName;
  </code>   </code>
Line 57:
Line 57:
    
  so to write a new value or overwrite the existing just put in your qml this   so to write a new value or overwrite the existing just put in your qml this
− <code> + <code javascript>
  settings.setValue("main/user", "Marco");   settings.setValue("main/user", "Marco");
  </code>   </code>
    
  to get a value:   to get a value:
− <code> + <code javascript>
  var user;   var user;
  user = settings.getValue("main/user");   user = settings.getValue("main/user");
  </code>   </code>
  if you want to have a default value if there is not yet a setting named "main/user", do:   if you want to have a default value if there is not yet a setting named "main/user", do:
− <code> + <code javascript>
  var user;   var user;
  user = settings.getValue("main/user", "Marco");   user = settings.getValue("main/user", "Marco");
Line 89:
Line 89:
  ==== appendToArray ====   ==== appendToArray ====
  to make this in your qml just use:   to make this in your qml just use:
− <code> + <code javascript>
  settings.appendToArray( "main/user", { "name": "Marco" , "location": "Italy" });   settings.appendToArray( "main/user", { "name": "Marco" , "location": "Italy" });
  settings.appendToArray( "main/user", { "name": "Marco2" , "location": "Italy2" });   settings.appendToArray( "main/user", { "name": "Marco2" , "location": "Italy2" });
Line 96:
Line 96:
  ==== removeArray ====   ==== removeArray ====
  to remove the whole array:   to remove the whole array:
− <code> + <code javascript>
  settings.removeArray( "main/user");   settings.removeArray( "main/user");
  </code>   </code>
Line 102:
Line 102:
  ==== removeArrayEntry ====   ==== removeArrayEntry ====
  to remove a single entry of the array:   to remove a single entry of the array:
− <code> + <code javascript>
  settings.removeArrayEntry( "main/user", 1);   settings.removeArrayEntry( "main/user", 1);
  </code>   </code>
Line 108:
Line 108:
  ==== getIndexOfValueInArray ====   ==== getIndexOfValueInArray ====
  this will get the first array index of "Marco2" inside the array "main/user" checking it in the "name" field.   this will get the first array index of "Marco2" inside the array "main/user" checking it in the "name" field.
− <code> + <code javascript>
  var i = settings.getIndexOfValueInArray("main/user", "name", "Marco2");   var i = settings.getIndexOfValueInArray("main/user", "name", "Marco2");
  </code>   </code>
    
  so if it is needed to remove "Marco2" from the array, just do:   so if it is needed to remove "Marco2" from the array, just do:
− <code> + <code javascript>
  settings.removeArrayEntry( "main/user", settings.getIndexOfValueInArray("main/user", "name", "Marco2") );   settings.removeArrayEntry( "main/user", settings.getIndexOfValueInArray("main/user", "name", "Marco2") );
  </code>   </code>
Line 120:
Line 120:
  ==== checkValueArray ====   ==== checkValueArray ====
  this will return true or false whenever "Marco" is in the array "main/user"   this will return true or false whenever "Marco" is in the array "main/user"
− <code> + <code javascript>
  var b = settings.checkValueArray("main/user", "name", "Marco");   var b = settings.checkValueArray("main/user", "name", "Marco");
  </code>   </code>
Line 126:
Line 126:
  ==== getArrayJson ====   ==== getArrayJson ====
  this function will retrieve the array in a json string format. It is possible to use the eval() function for example to fill a [http://doc.qt.nokia.com/4.7-snapshot/qml-listmodel.html ListModel]:   this function will retrieve the array in a json string format. It is possible to use the eval() function for example to fill a [http://doc.qt.nokia.com/4.7-snapshot/qml-listmodel.html ListModel]:
− <code> + <code javascript>
  var users = eval ( settings.getArrayJson("main/users") );   var users = eval ( settings.getArrayJson("main/users") );
  listModel.clear();   listModel.clear();
Line 144:
Line 144:
  this function is useful to fill a [http://doc.qt.nokia.com/4.7-snapshot/qml-xmllistmodel.html XmlListModel]. The returned xml format is like:   this function is useful to fill a [http://doc.qt.nokia.com/4.7-snapshot/qml-xmllistmodel.html XmlListModel]. The returned xml format is like:
    
− <code> + <code xml>
  <xml>   <xml>
      <item>       <item>
Line 160:
Line 160:
    
  so, for example:   so, for example:
− <code> + <code javascript>
  XmlListModel {   XmlListModel {
       id: xmlListModel        id: xmlListModel



Lildeimos: Lildeimos -
2012-05-09T19:04:37Z
Lildeimos -

			
			
			
			
		
		← Older revision
		Revision as of 19:04, 9 May 2012
		
Line 1:
Line 1:
− [[Category:Draft]][[Category:Qt Mobility]][[Category:Qt Quick]][[Category:Qt]] + [[Category:Qt Mobility]][[Category:Qt Quick]][[Category:Qt]]
  {{Abstract|This article explains how to use settings in QML }}   {{Abstract|This article explains how to use settings in QML }}
    



Lildeimos: Lildeimos -
2012-05-08T20:09:21Z
Lildeimos -

			
			
			
			
		
		← Older revision
		Revision as of 20:09, 8 May 2012
		
Line 48:
Line 48:
    
  === single settings ===   === single settings ===
− The ini format is likely as: + The ini format is mostly like as:
  <code>   <code>
  [main]   [main]
Line 76:
Line 76:
  === array settings ===   === array settings ===
    
− The ini format for arrays is likely as: + The ini format for arrays is mostly like as:
  <code>   <code>
  [main]   [main]



Lildeimos: Lildeimos -
2012-05-08T17:01:26Z
Lildeimos -

			
			
			
			
		
		← Older revision
		Revision as of 17:01, 8 May 2012
		
Line 107:
Line 107:
    
  ==== getIndexOfValueInArray ====   ==== getIndexOfValueInArray ====
− this will get the index + this will get the first array index of "Marco2" inside the array "main/user" checking it in the "name" field.
− settings.getIndexOfValueInArray("favourites/place", "name", value); + <code>
  + var i = settings.getIndexOfValueInArray("main/user", "name", "Marco2");
  + </code>
  +  
  + so if it is needed to remove "Marco2" from the array, just do:
  + <code>
  + settings.removeArrayEntry( "main/user", settings.getIndexOfValueInArray("main/user", "name", "Marco2") );
  + </code>
  +  
  +  
  + ==== checkValueArray ====
  + this will return true or false whenever "Marco" is in the array "main/user"
  + <code>
  + var b = settings.checkValueArray("main/user", "name", "Marco");
  + </code>
  +  
  + ==== getArrayJson ====
  + this function will retrieve the array in a json string format. It is possible to use the eval() function for example to fill a [http://doc.qt.nokia.com/4.7-snapshot/qml-listmodel.html ListModel]:
  + <code>
  + var users = eval ( settings.getArrayJson("main/users") );
  + listModel.clear();
  + for (var i=0; i<users.length; i++)
  +         {
  +             listModel.append( {
  +                                         "name": users[i].name,
  +                                         "location": users[i].location
  +                                       } );
  +         }
  + </code>
  +  
  + ==== getArray ====
  + this function is like getArrayJson but it returns the values in a QList< QVariantMap > ready to be use without the need to use eval() function.
  +  
  + ==== getArrayXml ====
  + this function is useful to fill a [http://doc.qt.nokia.com/4.7-snapshot/qml-xmllistmodel.html XmlListModel]. The returned xml format is like:
  +  
  + <code>
  + <xml>
  +    <item>
  +        <name>Marco</name>
  +        <location>Italy</location>
  +    </item>
  +  
  +    <item>
  +        <name>Marco2</name>
  +        <location>Italy2</location>
  +    </item>
  + ...
  + </xml>
  + </code>
  +  
  + so, for example:
  + <code>
  + XmlListModel {
  +     id: xmlListModel
  +     xml: getArrayXml("main/users")
  +     query: "/xml/item"
  +  
  +      XmlRole { name: "name"; query: "name/string()" }
  +      XmlRole { name: "location"; query: "location/string()" }
  + }
  + </code>
  + will fill {{Icode|xmlListModel}} with the stored array.
  +  
  + == Download ==
  +  
  + [[File:settings-v1.0.zip]]



Lildeimos: Lildeimos -
2012-05-08T15:42:32Z
Lildeimos -
New page
[[Category:Draft]][[Category:Qt Mobility]][[Category:Qt Quick]][[Category:Qt]]

{{Abstract|This article explains how to use settings in QML }}



{{ArticleMetaData <!-- v1.2 -->

|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->

|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->

|devices= all

|sdk= Nokia Qt SDK 1.2.1

|platform= all

|devicecompatability= all

|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 --> 

|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->

|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->

|keywords= QSettings

|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->

|translated-by= <!-- [[User:XXXX]] -->

|translated-from-title= <!-- Title only --> 

|translated-from-id= <!-- Id of translated revision -->

|review-by=<!-- After re-review: [[User:username]] -->

|review-timestamp= <!-- After re-review: YYYYMMDD -->

|update-by= <!-- After significant update: [[User:username]]-->

|update-timestamp= <!-- After significant update: YYYYMMDD -->

|creationdate= 20120509

|author= [[User:lildeimos]]

}}



== Introduction ==



This class is used as a context property in QML applications as an easy way to store and get user settings. It supports storing arrays. These can also retrieved in json or xml format.



== Usage ==



Start copying {{Icode|setting.cpp}} and {{Icode|setting.h}} into your project source directory. In the {{Icode|main.cpp}} file include the .h:

<code>

#include "setting.h"

</code>

the register the context property

<code>

Settings settings(appName, fileName);

viewer.rootContext()->setContextProperty("settings", &settings);

</code>

fileName will be create as follow:

<code>

QDesktopServices::storageLocation( QDesktopServices::DataLocation ) + "/" + appName + "/" + fileName;

</code>



In your QML sources you will now be able to use the property {{Icode|settings}} in ini format as explained below.



=== single settings ===

The ini format is likely as:

<code>

[main]

user=Marco

location=Italy

...

</code>



so to write a new value or overwrite the existing just put in your qml this

<code>

settings.setValue("main/user", "Marco");

</code>



to get a value:

<code>

var user;

user = settings.getValue("main/user");

</code>

if you want to have a default value if there is not yet a setting named "main/user", do:

<code>

var user;

user = settings.getValue("main/user", "Marco");

</code>

if "main/user" exist it will return that value, else will return "Marco".





=== array settings ===



The ini format for arrays is likely as:

<code>

[main]

user/size=2

user/1/name=Marco

user/1/location=Italy

user/2/name=Marco2

user/2/location=Italy2

...

</code>



==== appendToArray ====

to make this in your qml just use:

<code>

settings.appendToArray( "main/user", { "name": "Marco" , "location": "Italy" });

settings.appendToArray( "main/user", { "name": "Marco2" , "location": "Italy2" });

</code>



==== removeArray ====

to remove the whole array:

<code>

settings.removeArray( "main/user");

</code>



==== removeArrayEntry ====

to remove a single entry of the array:

<code>

settings.removeArrayEntry( "main/user", 1);

</code>



==== getIndexOfValueInArray ====

this will get the index

settings.getIndexOfValueInArray("favourites/place", "name", value);

← Older revision		Revision as of 19:04, 9 May 2012
Line 1:		Line 1:
−	~~[[Category:Draft]]~~[[Category:Qt Mobility]][[Category:Qt Quick]][[Category:Qt]]	+	[[Category:Qt Mobility]][[Category:Qt Quick]][[Category:Qt]]
	{{Abstract\|This article explains how to use settings in QML }}		{{Abstract\|This article explains how to use settings in QML }}

Using QSettings in QML with also json and XML support - Revision history

Hamishwillee: Text replace - "" to ""

Croozeus: Croozeus - /* Usage */ Added appropriate code highlights

Lildeimos: Lildeimos -

Lildeimos: Lildeimos -

Lildeimos: Lildeimos -

Lildeimos: Lildeimos -

Hamishwillee: Text replace - "`" to ""`