<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US"> <head> <title>kaddressbook: KAddressBookIconView Class Reference (kaddressbook)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' /> <meta name="trademark" content="KDE e.V." /> <meta name="description" content="K Desktop Environment Homepage, KDE.org" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <link rel="shortcut icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" /> <style type="text/css"> <!-- hr { display: none; } #content h2 { margin-left: 0px; } table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; } td.mdRow { padding: 8px 20px; } td.md { font-weight: bold; } td.mdname1 { font-weight: bold; color: #602020; } td.mdname { font-weight: bold; color: #602020; } --> </style> </head> <body> <div id="nav_header_top" align="right"> <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a> <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a> <span class="doNotDisplay">::</span> <img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" /> <div id="nav_header_title" align="left">KDE PIM API Reference</div> </div> <div id="nav_header_bottom" align="right"> <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span> <div id="nav_header_bottom_left" style="text-align: left;"> / <a href="../../">API Reference</a> / <a href=".">kaddressbook</a> </div> </div> <table id="main" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td valign="top" class="menuheader" height="0"></td> <td id="contentcolumn" valign="top" rowspan="2" > <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;"> <h2><a name="content"></a>kaddressbook</h2> <!-- Generated by Doxygen 1.5.5 --> <div class="contents"> <h1>KAddressBookIconView Class Reference</h1><!-- doxytag: class="KAddressBookIconView" --><!-- doxytag: inherits="KAddressBookView" --><code>#include <<a class="el" href="kaddressbookiconview_8h-source.html">kaddressbookiconview.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for KAddressBookIconView:</div> <div class="dynsection"> <p><center><img src="classKAddressBookIconView.png" usemap="#KAddressBookIconView_map" border="0" alt=""></center> <map name="KAddressBookIconView_map"> <area href="classKAddressBookView.html" alt="KAddressBookView" shape="rect" coords="0,0,147,24"> </map> </div> <p> <a href="classKAddressBookIconView-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> This is an example kaddressbook view that is implemented using KIconView. <p> This view is not the most useful view, but it displays how simple implementing a new view can be. <p>Definition at line <a class="el" href="kaddressbookiconview_8h-source.html#l00042">42</a> of file <a class="el" href="kaddressbookiconview_8h-source.html">kaddressbookiconview.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Slots</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#075c73e9db421280f3d14250cf9e65cc">refresh</a> (const QString &uid=QString())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#fc196129a0a46cfdb56dd0284c7f0998">setSelected</a> (const QString &uid=QString(), bool selected=true)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#ee247538deec4b4fbe1188d10563ffb5">setFirstSelected</a> (bool selected=true)</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43eb636bd61ba87f51056ae3aa309d62"></a><!-- doxytag: member="KAddressBookIconView::KAddressBookIconView" ref="43eb636bd61ba87f51056ae3aa309d62" args="(KAB::Core *core, QWidget *parent, const char *name=0)" --> </td><td class="memItemRight" valign="bottom"><b>KAddressBookIconView</b> (KAB::Core *core, QWidget *parent, const char *name=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#a761cbb529a536749c0e9e3da469d8e0">selectedUids</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#d38fd8305b36d1201edb2aabd223a8c6">type</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual KABC::Field * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#7dcb6a59f2bad4eaaca04514576ee9a9">sortField</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAddressBookIconView.html#ce6c63e9d015e5c4beb9eb7f79f8a9b1">readConfig</a> (KConfig *config)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96df48972a87dcc4d46d199c6e70430c"></a><!-- doxytag: member="KAddressBookIconView::scrollUp" ref="96df48972a87dcc4d46d199c6e70430c" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>scrollUp</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2953ac019b5e71a4a26c4b55cfb16a53"></a><!-- doxytag: member="KAddressBookIconView::scrollDown" ref="2953ac019b5e71a4a26c4b55cfb16a53" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>scrollDown</b> ()</td></tr> <tr><td colspan="2"><br><h2>Protected Slots</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef4ffc268a7a0216554430a529c158bf"></a><!-- doxytag: member="KAddressBookIconView::addresseeExecuted" ref="ef4ffc268a7a0216554430a529c158bf" args="(QIconViewItem *item)" --> void </td><td class="memItemRight" valign="bottom"><b>addresseeExecuted</b> (QIconViewItem *item)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="983e6dc0be7ee1ece40b61dea84cbdb1"></a><!-- doxytag: member="KAddressBookIconView::addresseeSelected" ref="983e6dc0be7ee1ece40b61dea84cbdb1" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>addresseeSelected</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20d90944a8c82bf0db3c0742fc15d202"></a><!-- doxytag: member="KAddressBookIconView::rmbClicked" ref="20d90944a8c82bf0db3c0742fc15d202" args="(QIconViewItem *, const QPoint &)" --> void </td><td class="memItemRight" valign="bottom"><b>rmbClicked</b> (QIconViewItem *, const QPoint &)</td></tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a761cbb529a536749c0e9e3da469d8e0"></a><!-- doxytag: member="KAddressBookIconView::selectedUids" ref="a761cbb529a536749c0e9e3da469d8e0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QStringList KAddressBookIconView::selectedUids </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Must be overloaded in subclasses. <p> Should return a list of all the uids of selected contacts. <p>Implements <a class="el" href="classKAddressBookView.html#8b372380967f1a2150ee2b700b2149a4">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8cpp-source.html#l00185">185</a> of file <a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a>.</p> </div> </div><p> <a class="anchor" name="d38fd8305b36d1201edb2aabd223a8c6"></a><!-- doxytag: member="KAddressBookIconView::type" ref="d38fd8305b36d1201edb2aabd223a8c6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual QString KAddressBookIconView::type </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return the type of the view: Icon, Table, etc. <p> Please make sure that this is the same value that ViewWrapper::type() will return for your view. <p>Implements <a class="el" href="classKAddressBookView.html#76149bcdfe0f05e536a9905af3909eba">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8h-source.html#l00052">52</a> of file <a class="el" href="kaddressbookiconview_8h-source.html">kaddressbookiconview.h</a>.</p> </div> </div><p> <a class="anchor" name="7dcb6a59f2bad4eaaca04514576ee9a9"></a><!-- doxytag: member="KAddressBookIconView::sortField" ref="7dcb6a59f2bad4eaaca04514576ee9a9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">KABC::Field * KAddressBookIconView::sortField </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The current sort field. </dd></dl> <p>Implements <a class="el" href="classKAddressBookView.html#78b2d39633cdf0a8de4000cabcfcee50">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8cpp-source.html#l00164">164</a> of file <a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a>.</p> </div> </div><p> <a class="anchor" name="ce6c63e9d015e5c4beb9eb7f79f8a9b1"></a><!-- doxytag: member="KAddressBookIconView::readConfig" ref="ce6c63e9d015e5c4beb9eb7f79f8a9b1" args="(KConfig *config)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KAddressBookIconView::readConfig </td> <td>(</td> <td class="paramtype">KConfig * </td> <td class="paramname"> <em>config</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Called whenever this view should read the config. <p> This can be used as a sign that the config has changed, therefore the view should assume the worst and rebuild itself if necessary. For example, in a table view this method may be called when the user adds or removes columns from the view.<p> If overloaded in the subclass, do not forget to call super class's method.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>The KConfig object to read from. The group will already be set, so do not change the group. </td></tr> </table> </dl> <p>Reimplemented from <a class="el" href="classKAddressBookView.html#a57dbc0b432a252da27fc8afe81ef898">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8cpp-source.html#l00170">170</a> of file <a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a>.</p> </div> </div><p> <a class="anchor" name="075c73e9db421280f3d14250cf9e65cc"></a><!-- doxytag: member="KAddressBookIconView::refresh" ref="075c73e9db421280f3d14250cf9e65cc" args="(const QString &uid=QString())" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KAddressBookIconView::refresh </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>uid</em> = <code>QString()</code> </td> <td> ) </td> <td width="100%"><code> [virtual, slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Must be overloaded in subclasses to refresh the view. <p> Refreshing includes updating the view to ensure that only items in the document are visible. If <em>uid</em> is valid, only the addressee with uid needs to be refreshed. This is an optimization only. <p>Implements <a class="el" href="classKAddressBookView.html#33052941465838c43b69b61653639d13">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8cpp-source.html#l00202">202</a> of file <a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a>.</p> </div> </div><p> <a class="anchor" name="fc196129a0a46cfdb56dd0284c7f0998"></a><!-- doxytag: member="KAddressBookIconView::setSelected" ref="fc196129a0a46cfdb56dd0284c7f0998" args="(const QString &uid=QString(), bool selected=true)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KAddressBookIconView::setSelected </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>uid</em> = <code>QString()</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>selected</em> = <code>true</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual, slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This method must be overloaded in subclasses. <p> Select (highlight) the addressee matching <em>uid</em>. If uid is equal to QString::null, then all addressees should be selected. <p>Implements <a class="el" href="classKAddressBookView.html#b1f67bf8e83c72484b0aa308533c0979">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8cpp-source.html#l00240">240</a> of file <a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a>.</p> </div> </div><p> <a class="anchor" name="ee247538deec4b4fbe1188d10563ffb5"></a><!-- doxytag: member="KAddressBookIconView::setFirstSelected" ref="ee247538deec4b4fbe1188d10563ffb5" args="(bool selected=true)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KAddressBookIconView::setFirstSelected </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>selected</em> = <code>true</code> </td> <td> ) </td> <td width="100%"><code> [virtual, slot]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Selects the first contact in the view. <p> <p>Implements <a class="el" href="classKAddressBookView.html#c2269e27bb8c8ff06dfe2b9e3b3357c8">KAddressBookView</a>.</p> <p>Definition at line <a class="el" href="kaddressbookiconview_8cpp-source.html#l00261">261</a> of file <a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="kaddressbookiconview_8h-source.html">kaddressbookiconview.h</a><li><a class="el" href="kaddressbookiconview_8cpp-source.html">kaddressbookiconview.cpp</a></ul> </div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>kaddressbook</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul> <!-- <h2>Class Picker</h2> <div style="text-align: center;"> <form name="guideform"> <select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value"> <option value="annotated.html">-- Choose --</option> <option value="classAddressEditDialog.html">addresseditdialog</option>, <option value="classAddressEditWidget.html">addresseditwidget</option>, <option value="classAddresseeUtil.html">addresseeutil</option>, <option value="classAddressTypeDialog.html">addresstypedialog</option>, <option value="classAddViewDialog.html">addviewdialog</option>, <option value="classCardView.html">cardview</option>, <option value="classCardViewItem.html">cardviewitem</option>, <option value="classCardViewLookNFeelPage.html">cardviewlooknfeelpage</option>, <option value="classConfigureCardViewWidget.html">configurecardviewwidget</option>, <option value="classConfigureTableViewWidget.html">configuretableviewwidget</option>, <option value="classDateParser.html">dateparser</option>, <option value="classDistributionListView.html">distributionlistview</option>, <option value="classDynamicTip.html">dynamictip</option>, <option value="classEmailEditWidget.html">emaileditwidget</option>, <option value="classEmailSelector.html">emailselector</option>, <option value="classFilter.html">filter</option>, <option value="classFilterSelectionWidget.html">filterselectionwidget</option>, <option value="classIMAddressLVI.html">imaddresslvi</option>, <option value="classIMAddressWidget.html">imaddresswidget</option>, <option value="classImageButton.html">imagebutton</option>, <option value="classImageLoader.html">imageloader</option>, <option value="classIMEditorWidget.html">imeditorwidget</option>, <option value="classIMEditWidget.html">imeditwidget</option>, <option value="classJumpButtonBar.html">jumpbuttonbar</option>, <option value="classKABPrinting_1_1PrintingWizard.html">kabprinting::printingwizard</option>, <option value="classKABPrinting_1_1PrintProgress.html">kabprinting::printprogress</option>, <option value="classKABPrinting_1_1PrintStyle.html">kabprinting::printstyle</option>, <option value="classKABPrinting_1_1PrintStyleFactory.html">kabprinting::printstylefactory</option>, <option value="classKAddressBookCardView.html">kaddressbookcardview</option>, <option value="classKAddressBookIconView.html">kaddressbookiconview</option>, <option value="classKAddressBookMain.html">kaddressbookmain</option>, <option value="classKAddressBookTableView.html">kaddressbooktableview</option>, <option value="classKAddressBookView.html">kaddressbookview</option>, <option value="classLookAndFeelPage.html">lookandfeelpage</option>, <option value="classNameEditDialog.html">nameeditdialog</option>, <option value="classPhoneEditWidget.html">phoneeditwidget</option>, <option value="classPhoneTypeDialog.html">phonetypedialog</option>, <option value="classTypeCombo.html">typecombo</option>, <option value="classViewConfigureWidget.html">viewconfigurewidget</option>, <option value="classViewManager.html">viewmanager</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li> </ul></div></div> </td> </tr> </table> <span class="doNotDisplay"> <a href="http://www.kde.org/" accesskey="8">KDE Home</a> | <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> | <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a> </span> <div style="height: 8px"></div> <div id="footer"> <div id="footer_left"> Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a> and <a href="mailto:winter@kde.org">Allen Winter</a>. <br/> KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div> <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a> WARNING END --> </body> </html>