Development/Tutorials/Using KConfig XT - Revision history

AnneW at 12:24, 13 July 2012

2012-07-13T12:24:39Z

Djszapi: /* Common Pitfalls and Tips */ Fix a minor typo

2012-01-17T14:06:07Z

‎Common Pitfalls and Tips: Fix a minor typo

Djszapi: /* Example */ Fix typo

2012-01-17T14:02:01Z

‎Example: Fix typo

Djszapi: /* Use and Dialogs */

2012-01-17T14:00:24Z

‎Use and Dialogs

Djszapi: /* .kcfgc files */ Fix a small typo

2012-01-17T13:46:46Z

‎.kcfgc files: Fix a small typo

Djszapi: /* .kcfg Structure */ Replace the old svn link with the new git project site link for the kcfg.xsd specification

2012-01-17T13:16:32Z

‎.kcfg Structure: Replace the old svn link with the new git project site link for the kcfg.xsd specification

Winterz: swap the order of and lines so the example will validate against the kcfg.xsd schema

2011-12-11T22:26:41Z

swap the order of <include> and <kcfgfile...> lines so the example will validate against the kcfg.xsd schema

Jan: /* Adjusting the CMakeLists.txt file */ Use cmake syntax highlighting and fix a typo.

2011-07-09T15:27:30Z

‎Adjusting the CMakeLists.txt file: Use cmake syntax highlighting and fix a typo.

Icwiener: Fix syntax highlighting.

2011-06-27T15:01:26Z

Fix syntax highlighting.

Bedahr: Replaced references to QValueList with QList

2010-05-13T19:35:24Z

Replaced references to QValueList with QList

← Older revision		Revision as of 12:24, 13 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Using_KConfig_XT}}~~	+
	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 263: / Line 263: @@
 * Always try to add both the &lt;label&gt;, &lt;whatsthis&gt; and &lt;tooltip&gt; tags to each entry.
 * Putting the MemberVariables=public in your .kcfgc is usually a bad idea - you'll avoid accidental changes to those members by using the aggregation and forcing the use of the mutators.
-* If your application doesn't have one central object (created before and destructed after; all others) then always put the Singleton=true entry in your .kcfgs file.
+* If your application doesn't have one central object (created before and destructed after all others) then always put the Singleton=true entry in your .kcfgs file.
 == Additional References ==

@@ Line 195: / Line 195: @@
 </syntaxhighlight>
-And here's how to actually use the generated class. for the given kcfgc file.
+And here's how to actually use the generated class for the given kcfgc file.
 <syntaxhighlight lang="ini">

@@ Line 151: / Line 151: @@
 The use will depend on whether you have added the <tt>Singleton=true</tt> entry to your .kcfgc file.
-One the nicest features of the KConfig XT is its seamless integration with the Qt
+One of the nicest features of the KConfig XT is its seamless integration with the Qt
 Designer generated dialogs. You can do that by using {{class|KConfigDialog}}. The
 steps to do that are as follows:

@@ Line 107: / Line 107: @@
 #* ItemAccessors - relates to the above item, if member variables are public then it might make little sense to generate accessors. By default they are generated,
 #* Mutators - similar to the above one, but applies to the mutator methods,
-#* GlobalEnums - specifies whether enums should be class wide of whether they should be always explicitly prefixed with their type name,
+#* GlobalEnums - specifies whether enums should be class wide or whether they should be always explicitly prefixed with their type name,
 #* UseEnumTypes - specifies whether enum values should be passed as type int or as their enum type in the return value of accessor functions and the arguments of mutator and signal functions.
 #* SetUserTexts - specifies whether &lt;label&gt;, &lt;tooltip&gt; and &lt;whatsthis&gt; tags should be processed. This allows tools like KConfigDialog make use of these tags. By default this tags are ignored

@@ Line 34: / Line 34: @@
 The structure of the {{path|.kcfg}} file is described by its XML Schema (kcfg.xsd - available from
-[http://www.kde.org/standards/kcfg/1.0/kcfg.xsd here] or [http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/kconfig_compiler/kcfg.xsd?view=markup from the kdecore library] ). Please go through it before you go any further.
+[http://www.kde.org/standards/kcfg/1.0/kcfg.xsd here] or [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/entry/kdecore/kconfig_compiler/kcfg.xsd from the kdecore library] ). Please go through it before you go any further.
 Lets create a simple .kcfg file. Please reference the code below as we go through each step.

@@ Line 44: / Line 44: @@
        xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0
                            http://www.kde.org/standards/kcfg/1.0/kcfg.xsd" >
    <include>kglobalsettings.h</include>
    <group name="kjots">
      <entry name="SplitterSizes" type="IntList">

@@ Line 117: / Line 117: @@
 After creating the .kcfg and .kcfgc files the next step is to adjust the
 build to let kconfig_compiler generate the required class at compile time. For in-source builds, doing this is trivial and requires only one step, adding this two lines to the CMakeLists.txt file example (asuming your files are named settings.kcfg and settings.kcfgc):
-<pre>
+<syntaxhighlight lang="cmake">
 kde4_add_kcfg_files(<project name>_SRCS settings.kcfgc)
 install(FILES settings.kcfg DESTINATION ${KCFG_INSTALL_DIR})
-</pre>
+</syntaxhighlight>
 Alternatively, if a .moc file needs to be generated before compiling the generated source code, use
-<pre>
+<syntaxhighlight lang="cmake">
 kde4_add_kcfg_files(<project name>_SRCS GENERATE_MOC settings.kcfgc)
 install(FILES settings.kcfg DESTINATION ${KCFG_INSTALL_DIR})
-</pre>
+</syntaxhighlight>
 This assures that the configuration class is properly generated (<tt>kde4_add_kcfg_files</tt>) and that the .kcfg is installed so it can be used by tools like the KConfigEditor (<tt>install</tt>).
-=== out-of-source builds ===
+=== Out-of-source builds ===
 Out-of-source builds require one more step.
@@ Line 135: / Line 135: @@
 '''The solution:''' Probably you have yet a line similar to the following line in your CMakeLists.txt:
-<pre>
+<syntaxhighlight lang="cmake">
 include_directories(${QT_INCLUDE} ${KDE4_INCLUDES})
-</pre>
+</syntaxhighlight>
 Add the variable ''CMAKE_CURRENT_BINARY_DIR'', so that you get something like this:
-<pre>
+<syntaxhighlight lang="cmake">
 include_directories(${QT_INCLUDE} ${KDE4_INCLUDES} ${CMAKE_CURRENT_BINARY_DIR})
-</pre>
+</syntaxhighlight>
 Notice that you should call <tt>include_directories</tt> only once in your project. (When you call <tt>include_directories</tt> in your base source directory, but than call it another time in a subdirectory (added by <tt>add_subdirectory</tt>), then the second call will be ignored.)

@@ Line 84: / Line 84: @@
 *#* Path - This is a string that is specially treated as a file-path. In particular paths in the home directory are prefixed with $HOME when being stored in the configuration file.
 *#* Enum - This indicates an enumeration. The possible enum values should be provided via the &lt;choices&gt; tag. Enum values are accessed as integers by the application but stored as string in the configuration file. This makes it possible to add more values at a later date without breaking compatibility.
-*#* IntList - This indicates a list of integers. This information is provided to the application as QValueList&lt;int&gt;. Useful for storing QSplitter geometries.
+*#* IntList - This indicates a list of integers. This information is provided to the application as QList&lt;int&gt;. Useful for storing QSplitter geometries.
 *#* PathList - List of Path elements.
 *# The min and max tags can be set to limit the value of the integer-type options.