You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pytde/doc/classref/tdecore/KConfigSkeleton.html

335 lines
20 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN
"http://www.w3.org/TR/html4/loose.dtd"">
<html>
<head>
<title>class KConfigSkeleton</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="GENERATOR" content="wabbit dumphtml">
</head>
<body>
<h4>PyKDE - Python Bindings for KDE</h4>
<hr>
<table width="100%"><tr>
<td width ="70%">
<h1>class KConfigSkeleton</h1><hr>
</td>
<td width="30%" valign="top" align="right">
<table>
<tr><td align="right"><a href="doc/index.html">Table of contents</a></td></tr>
<tr><td align="right"><a href="../index.html">Modules</a></td></tr>
<tr><td align="right"><a href="index.html">tdecore Classes</a></td></tr>
<tr><td align="right"><a href="../allclasses.html">All Classes</a></td></tr>
</table>
</td>
</tr></table>
<table>
<tr><td width="10%" align=left>Module</td>
<td width="30%" align=left>tdecore</td>
</tr>
<tr><td>Class</td>
<td>KConfigSkeleton</td>
</tr>
<tr><td>Inherits</td>
<td> </td>
</tr>
</table>
<h3>methods</h3><ul>
<li><b>KConfigSkeleton</b> (configname = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a KConfigSkeleton instance</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>configname</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>KConfigSkeleton</b> (config)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a KConfigSkeleton instance</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>config</td><td>KSharedConfig.Ptr</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItem</b> (a0, name = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>KConfigSkeletonItem</td><td></td></tr>
<tr><td>name</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemBool</b> (name, value, defaultValue, key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemBool) reference (bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>value</td><td>bool</td><td></td></tr>
<tr><td>defaultValue</td><td>bool</td><td></td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemColor</b> (name, reference, defaultValue = QColor (128 ,128 ,128 ), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemColor)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QColor</td><td></td></tr>
<tr><td>defaultValue</td><td>QColor</td><td>QColor (128 ,128 ,128 )</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemDateTime</b> (name, reference, defaultValue = QDateTime (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemDateTime)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QDateTime</td><td></td></tr>
<tr><td>defaultValue</td><td>QDateTime</td><td>QDateTime ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemDouble</b> (name, value, defaultValue, key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemDouble) reference (double)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>value</td><td>double</td><td></td></tr>
<tr><td>defaultValue</td><td>double</td><td></td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemFont</b> (name, reference, defaultValue = KGlobalSettings .generalFont (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemFont)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QFont</td><td></td></tr>
<tr><td>defaultValue</td><td>QFont</td><td>KGlobalSettings .generalFont ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemInt</b> (name, value, defaultValue, key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemInt) reference (int)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>value</td><td>int</td><td></td></tr>
<tr><td>defaultValue</td><td>int</td><td></td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemInt64</b> (name, reference, defaultValue = 0, key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfigSkeleton.ItemInt64)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>longlong</td><td></td></tr>
<tr><td>defaultValue</td><td>longlong</td><td>0</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemIntList</b> (name, reference, defaultValue = [], key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a Python list of int,</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>a Python list of int</td><td></td></tr>
<tr><td>defaultValue</td><td>a Python list of int</td><td>[]</td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemLong</b> (name, value, defaultValue, key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemLong) reference (long)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>value</td><td>long</td><td></td></tr>
<tr><td>defaultValue</td><td>long</td><td></td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemPassword</b> (name, reference, defaultValue = QString .fromLatin1 ("" ), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfigSkeleton.ItemPassword)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QString</td><td></td></tr>
<tr><td>defaultValue</td><td>QString</td><td>QString .fromLatin1 ("" )</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemPath</b> (name, reference, defaultValue = QString .fromLatin1 ("" ), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfigSkeleton.ItemPath)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QString</td><td></td></tr>
<tr><td>defaultValue</td><td>QString</td><td>QString .fromLatin1 ("" )</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemPoint</b> (name, reference, defaultValue = QPoint (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemPoint)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QPoint</td><td></td></tr>
<tr><td>defaultValue</td><td>QPoint</td><td>QPoint ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemProperty</b> (name, reference, defaultValue = QVariant (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemProperty)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QVariant</td><td></td></tr>
<tr><td>defaultValue</td><td>QVariant</td><td>QVariant ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemRect</b> (name, reference, defaultValue = QRect (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemRect)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QRect</td><td></td></tr>
<tr><td>defaultValue</td><td>QRect</td><td>QRect ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemSize</b> (name, reference, defaultValue = QSize (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemSize)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QSize</td><td></td></tr>
<tr><td>defaultValue</td><td>QSize</td><td>QSize ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemString</b> (name, reference, defaultValue = QString .fromLatin1 ("" ), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemString)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QString</td><td></td></tr>
<tr><td>defaultValue</td><td>QString</td><td>QString .fromLatin1 ("" )</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemStringList</b> (name, reference, defaultValue = QStringList (), key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfigSkeleton.ItemStringList)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>QStringList</td><td></td></tr>
<tr><td>defaultValue</td><td>QStringList</td><td>QStringList ()</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemUInt</b> (name, value, defaultValue, key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemUInt) reference (uint)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>value</td><td>uint</td><td></td></tr>
<tr><td>defaultValue</td><td>uint</td><td></td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemUInt64</b> (name, reference, defaultValue = 0, key = QString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfigSkeleton.ItemUInt64)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>reference</td><td>ulonglong</td><td></td></tr>
<tr><td>defaultValue</td><td>ulonglong</td><td>0</td></tr>
<tr><td>key</td><td>QString</td><td>QString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addItemULong</b> (name, value, defaultValue, key = QString.null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(ItemULong) reference (ulong)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
<tr><td>value</td><td>ulong</td><td></td></tr>
<tr><td>defaultValue</td><td>ulong</td><td></td></tr>
<tr><td>key</td><td>QString</td><td>QString.null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>config</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfig)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>currentGroup</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(QString)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findItem</b> (name)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KConfigSkeletonItem)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>isImmutable</b> (name)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>QString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>items</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(a Python list of Items),</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>readConfig</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setCurrentGroup</b> (group)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>group</td><td>QString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setDefaults</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>useDefaults</b> (b)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>b</td><td>bool</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>usrReadConfig</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>usrSetDefaults</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>usrUseDefaults</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>bool</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>usrWriteConfig</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeConfig</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
</ul>
</body>
</html>