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/kabc/KABC.AddressBook.html

282 lines
17 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN
"http://www.w3.org/TR/html4/loose.dtd"">
<html>
<head>
<title>class KABC.AddressBook</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 KABC.AddressBook</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">kabc 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>kabc</td>
</tr>
<tr><td>Class</td>
<td>KABC.AddressBook</td>
</tr>
<tr><td>Inherits</td>
<td>TQObject </td>
</tr>
</table>
<h3>methods</h3><ul>
<li><b>AddressBook</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a AddressBook instance</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>AddressBook</b> (config)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a AddressBook 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>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addCustomField</b> (label, category = KABC .Field .All, key = TQString .null, app = TQString .null)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>label</td><td>TQString</td><td></td></tr>
<tr><td>category</td><td>int</td><td>KABC .Field .All</td></tr>
<tr><td>key</td><td>TQString</td><td>TQString .null</td></tr>
<tr><td>app</td><td>TQString</td><td>TQString .null</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addResource</b> (resource)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>resource</td><td>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addressBookChanged</b> (addressBook)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>addressBook</td><td>KABC.AddressBook</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addressBookLocked</b> (addressBook)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>addressBook</td><td>KABC.AddressBook</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addressBookUnlocked</b> (addressBook)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>addressBook</td><td>KABC.AddressBook</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>allAddressees</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Addressee.List)</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>asyncLoad</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></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>asyncSave</b> (ticket)
<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>ticket</td><td>KABC.Ticket</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>cleanUp</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.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>clear</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>deleteRemovedAddressees</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.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>dump</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>emitAddressBookChanged</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>emitAddressBookLocked</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>emitAddressBookUnlocked</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>error</b> (msg)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>msg</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>fields</b> (category = KABC .Field .All)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Field.List)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>category</td><td>int</td><td>KABC .Field .All</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findByCategory</b> (category)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Addressee.List)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>category</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findByEmail</b> (email)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Addressee.List)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>email</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findByName</b> (name)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Addressee.List)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findByUid</b> (uid)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Addressee)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>uid</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>identifier</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQString)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>insertAddressee</b> (addr)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>addr</td><td>KABC.Addressee</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>load</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>loadingFinished</b> (resource)
<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>resource</td><td>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>loadingHasFinished</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.5.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>releaseSaveTicket</b> (ticket)
<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>ticket</td><td>KABC.Ticket</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>removeAddressee</b> (addr)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>addr</td><td>KABC.Addressee</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>removeAddressee</b> (it)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td><i>Not Implemented</i></td></tr></table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>removeResource</b> (resource)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>resource</td><td>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>requestSaveTicket</b> (resource = 0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Ticket)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>resource</td><td>KABC.Resource</td><td>0</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>resourceLoadingError</b> (a0, a1)
<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>KABC.Resource</td><td></td></tr>
<tr><td>a1</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>resourceLoadingFinished</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>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>resourceManager</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td><i>Not Implemented</i></td></tr></table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>resourceSavingError</b> (a0, a1)
<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>KABC.Resource</td><td></td></tr>
<tr><td>a1</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>resourceSavingFinished</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>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>resources</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQPtrList<KABC.Resource>)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>save</b> (ticket)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>ticket</td><td>KABC.Ticket</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>savingFinished</b> (resource)
<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>resource</td><td>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setErrorHandler</b> (errorHandler)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>errorHandler</td><td>KABC.ErrorHandler</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setStandardResource</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.1.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>KABC.Resource</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>standardResource</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KABC.Resource)</i></td></tr>
<tr><td>In versions KDE 3.1.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>