<?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" xml:lang="en"> <head> <title>KBookmarkDialog</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.9 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>KBookmarkDialog Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> Inherits: <a href="../kdeui/KDialog.html">KDialog</a> → QDialog → QWidget → QObject<br /> <h2>Detailed Description</h2> <p>This class provides a Dialog for editing properties, adding Bookmarks and creating new folders. It can be used to show dialogs for common tasks with bookmarks. </p> <p> It is used by KBookmarkMenu to show a dialog for "Properties", "Add Bookmark" and "Create New Folder". If you want to customize those dialogs, derive from KBookmarkOwner and reimplement bookmarkDialog(), return a KBookmarkDialog subclass and reimplement initLayout(), aboutToShow() and save(). </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#BookmarkDialogMode">BookmarkDialogMode</a> </td><td class="memItemRight" valign="bottom">{ NewFolder, NewBookmark, EditBookmark, NewMultipleBookmarks, SelectFolder }</td></tr> <tr><td colspan="2"><br><h2>Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KBookmarkDialog">__init__</a> (self, <a href="../kio/KBookmarkManager.html">KBookmarkManager</a> a0, QWidget a1=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutToShow">aboutToShow</a> (self, <a href="../kio/KBookmarkDialog.html#BookmarkDialogMode">KBookmarkDialog.BookmarkDialogMode</a> mode)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmark.html">KBookmark</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addBookmark">addBookmark</a> (self, QString title, <a href="../kdecore/KUrl.html">KUrl</a> url, <a href="../kio/KBookmark.html">KBookmark</a> parent=KBookmark())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addBookmarks">addBookmarks</a> (self, [(QString,QString)] list, QString name=QString(), <a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> parent=KBookmarkGroup())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createNewFolder">createNewFolder</a> (self, QString name, <a href="../kio/KBookmark.html">KBookmark</a> parent=KBookmark())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmark.html">KBookmark</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#editBookmark">editBookmark</a> (self, <a href="../kio/KBookmark.html">KBookmark</a> bm)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fillGroup">fillGroup</a> (self, QTreeWidgetItem parentItem, <a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> group)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#initLayout">initLayout</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#initLayoutPrivate">initLayoutPrivate</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#newFolderButton">newFolderButton</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#parentBookmark">parentBookmark</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#save">save</a> (self, <a href="../kio/KBookmarkDialog.html#BookmarkDialogMode">KBookmarkDialog.BookmarkDialogMode</a> mode, <a href="../kio/KBookmark.html">KBookmark</a> a1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectFolder">selectFolder</a> (self, <a href="../kio/KBookmark.html">KBookmark</a> start=KBookmark())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setParentBookmark">setParentBookmark</a> (self, <a href="../kio/KBookmark.html">KBookmark</a> bm)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotButtonClicked">slotButtonClicked</a> (self, int a0)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KBookmarkDialog"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmarkManager.html">KBookmarkManager</a> </td> <td class="paramname"><em>a0</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QWidget </td> <td class="paramname"><em>a1=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates a new KBookmarkDialog </p></div></div><a class="anchor" name="aboutToShow"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> aboutToShow</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmarkDialog.html#BookmarkDialogMode">KBookmarkDialog.BookmarkDialogMode</a> </td> <td class="paramname"><em>mode</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>aboutToShow is called immediately before exec() Reimplement this to show or hide UI elements for certain modes. </p></div></div><a class="anchor" name="addBookmark"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmark.html">KBookmark</a> addBookmark</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>title</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td> <td class="paramname"><em>url</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td> <td class="paramname"><em>parent=KBookmark()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>shows a add Bookmark dialog Note: That this updates the bookmark and calls KBookmarkManager.emitChanged </p></div></div><a class="anchor" name="addBookmarks"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> addBookmarks</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">[(QString,QString)] </td> <td class="paramname"><em>list</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>name=QString()</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td> <td class="paramname"><em>parent=KBookmarkGroup()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates a folder from a list of bookmarks Note: That this updates the bookmark and calls KBookmarkManager.emitChanged </p></div></div><a class="anchor" name="createNewFolder"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> createNewFolder</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>name</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td> <td class="paramname"><em>parent=KBookmark()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>A dialog to create a new folder. </p></div></div><a class="anchor" name="editBookmark"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmark.html">KBookmark</a> editBookmark</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td> <td class="paramname"><em>bm</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>shows a propeties dialog Note: That this updates the bookmark and calls KBookmarkManager.emitChanged </p></div></div><a class="anchor" name="fillGroup"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> fillGroup</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QTreeWidgetItem </td> <td class="paramname"><em>parentItem</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td> <td class="paramname"><em>group</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="initLayout"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> initLayout</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>initLayout is called to set the dialog up, indepent from the mode If you want to add widgets or a custom layout, reimplement this function. The default implementation is rather simple, take a look at the source. </p></div></div><a class="anchor" name="initLayoutPrivate"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> initLayoutPrivate</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"></div></div><a class="anchor" name="newFolderButton"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> newFolderButton</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"></div></div><a class="anchor" name="parentBookmark"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> parentBookmark</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>returns the selected bookmark in the folder tree, or the root (top-level) bookmark if none was selected </p></div></div><a class="anchor" name="save"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> save</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmarkDialog.html#BookmarkDialogMode">KBookmarkDialog.BookmarkDialogMode</a> </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td> <td class="paramname"><em>a1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>save all your custom data in this method This is called after the users has accepted() the dialog. </p></div></div><a class="anchor" name="selectFolder"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> selectFolder</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td> <td class="paramname"><em>start=KBookmark()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>A dialog to select a folder. </p></div></div><a class="anchor" name="setParentBookmark"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setParentBookmark</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td> <td class="paramname"><em>bm</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>selects the specified bookmark in the folder tree </p></div></div><a class="anchor" name="slotButtonClicked"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotButtonClicked</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>a0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="BookmarkDialogMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">BookmarkDialogMode</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"></table> </dl> </div></div><p> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" 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> </body> </html>