官术网_书友最值得收藏!

Storing and reading project preferences

The QGIS application settings are stored using the Qt API. However, QGIS project settings have their own object. In this recipe, we'll set and read the project title and then set and read a custom preference for a plugin.

Getting ready

We are going to set a plugin preference using the sample plugin created in the previous recipe, Creating a QGIS plugin. You can substitute the name of any plugin you want, however. We will also run this recipe in the QGIS Python console for quick testing, but this code will normally be used in a plugin.

How to do it…

In this recipe, we will first write and then read the title of the current project. Then, we will create a custom value for a plugin called splash, which can be used for the plugin startup splash screen if desired.

  1. Start QGIS.
  2. From the Plugins menu, select Python Console.
  3. In the console, run the following code:
    proj = QgsProject.instance()
    proj.title("My QGIS Project")
    proj.title()
    proj.writeEntry("MyPlugin", "splash", "Geospatial Python Rocks!")
    proj.readEntry("MyPlugin", "splash", "Welcome!")[0]

How it works…

In the first two lines, we change the title of the current active project and then echo it back. In the next set of two lines, we set up and read custom settings for a plugin. Notice that the readEntry() method returns a tuple with the desired text and a boolean, acknowledging that the value is set. So, we extract the first index to get the text. The read method also allows the default text in case that property is not set (rather than throw an exception which must be handled) as well as the boolean value False to inform you that the default text was used because the property was not set. The values you set using this method are stored in the project's XML file when you save it.

There's more…

The QgsProject object has a number of methods and properties that may be useful. The QGIS API documentation details all of them at http://qgis.org/api/2.6/classQgsProject.html.

主站蜘蛛池模板: 定南县| 汾西县| 邛崃市| 呈贡县| 开阳县| 来安县| 蛟河市| 河西区| 南充市| 桦川县| 兴海县| 珠海市| 达拉特旗| 拉孜县| 西乌珠穆沁旗| 乾安县| 长顺县| 溆浦县| 天峻县| 永修县| 尼木县| 遵化市| 获嘉县| 营山县| 贵港市| 横山县| 屯留县| 甘南县| 双辽市| 通道| 乐亭县| 行唐县| 虞城县| 岱山县| 沭阳县| 哈尔滨市| 屯昌县| 祥云县| 新津县| 金寨县| 土默特右旗|