<?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>KBookmark</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>KBookmark Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> Subclasses: <a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a><br /> <h2>Detailed Description</h2> <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="#MetaDataOverwriteMode">MetaDataOverwriteMode</a> </td><td class="memItemRight" valign="bottom">{ OverwriteMetaData, DontOverwriteMetaData }</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="#KBookmark">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KBookmark">__init__</a> (self, QDomElement elem)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#address">address</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#description">description</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#fullText">fullText</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasParent">hasParent</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#icon">icon</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QDomElement </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalElement">internalElement</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isGroup">isGroup</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isNull">isNull</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSeparator">isSeparator</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QDomNode </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaData">metaData</a> (self, QString owner, bool create)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaDataItem">metaDataItem</a> (self, QString key)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeType">mimeType</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator ==">operator ==</a> (self, <a href="../kio/KBookmark.html">KBookmark</a> rhs)</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="#parentGroup">parentGroup</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#populateMimeData">populateMimeData</a> (self, QMimeData mimeData)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#positionInParent">positionInParent</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDescription">setDescription</a> (self, QString description)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFullText">setFullText</a> (self, QString fullText)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setIcon">setIcon</a> (self, QString icon)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMetaDataItem">setMetaDataItem</a> (self, QString key, QString value, <a href="../kio/KBookmark.html#MetaDataOverwriteMode">KBookmark.MetaDataOverwriteMode</a> mode=KBookmark.OverwriteMetaData)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMimeType">setMimeType</a> (self, QString mimeType)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setShowInToolbar">setShowInToolbar</a> (self, bool show)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUrl">setUrl</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#showInToolbar">showInToolbar</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#text">text</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="#toGroup">toGroup</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateAccessMetadata">updateAccessMetadata</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#url">url</a> (self)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#commonParent">commonParent</a> (QString A, QString B)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#nextAddress">nextAddress</a> (QString address)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#parentAddress">parentAddress</a> (QString address)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#positionInParent">positionInParent</a> (QString address)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#previousAddress">previousAddress</a> (QString address)</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="#standaloneBookmark">standaloneBookmark</a> (QString text, <a href="../kdecore/KUrl.html">KUrl</a> url, QString icon=QString())</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KBookmark"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</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>Constructs a null bookmark, i.e. a bookmark for which isNull() returns true If you want to create a new bookmark use eitehr KBookmarkGroup.addBookmark or if you want an interactive dialog use KBookmarkDialog. </p></div></div><a class="anchor" name="KBookmark"></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">QDomElement </td> <td class="paramname"><em>elem</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates the KBookmark wrapper for </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>elem</em> </td><td> Mostly for internal usage. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="address"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString address</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>Return the "address" of this bookmark in the whole tree. This is used when telling other processes about a change in a given bookmark. The encoding of the address is "/4/2", for instance, to designate the 2nd child inside the 4th child of the root bookmark. </p></div></div><a class="anchor" name="description"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString description</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> Description of the bookmark </dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4 </dd></dl> </p></div></div><a class="anchor" name="fullText"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString fullText</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>Text shown for the bookmark, not truncated. You should not use this - this is mainly for keditbookmarks. </p></div></div><a class="anchor" name="hasParent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool hasParent</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if bookmark is contained by a QDomDocument, if not it is most likely that it has become separated and is thus invalid and/or has been deleted from the bookmarks. </dd></dl> </p></div></div><a class="anchor" name="icon"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString icon</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the pixmap file for this bookmark (i.e. the name of the icon) </dd></dl> </p></div></div><a class="anchor" name="internalElement"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QDomElement internalElement</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><dl class="internal" compact><dt><b>Internal:</b></dt><dd> for KEditBookmarks </dd></dl> </p></div></div><a class="anchor" name="isGroup"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isGroup</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>Whether the bookmark is a group or a normal bookmark </p></div></div><a class="anchor" name="isNull"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isNull</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if this is a null bookmark. This will never be the case for a real bookmark (in a menu), but it's used for instance as the end condition for KBookmarkGroup.next() </dd></dl> </p></div></div><a class="anchor" name="isSeparator"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSeparator</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>Whether the bookmark is a separator </p></div></div><a class="anchor" name="metaData"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QDomNode metaData</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>owner</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>create</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the metadata container node for a certain matadata owner </dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="metaDataItem"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString metaDataItem</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>key</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Get the value of a specific metadata item (owner = "http://www.kde.org"). </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>key</em> </td><td> Name of the metadata item </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Value of the metadata item. QString() is returned in case the specified key does not exist. </dd></dl> </p></div></div><a class="anchor" name="mimeType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString mimeType</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> Mime-Type of this item </dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="operator =="></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator ==</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>rhs</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Comparison operator </p></div></div><a class="anchor" name="parentGroup"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> parentGroup</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the group containing this bookmark </dd></dl> </p></div></div><a class="anchor" name="populateMimeData"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> populateMimeData</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">QMimeData </td> <td class="paramname"><em>mimeData</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Adds this bookmark into the given QMimeData. </p> <p> WARNING: do not call this method multiple times, use KBookmark.List.populateMimeData instead. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>mimeData</em> </td><td> the QMimeData instance used to drag or copy this bookmark </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="positionInParent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int positionInParent</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> position in parent (e.g. /4/5/2 -> 2) </dd></dl> </p></div></div><a class="anchor" name="setDescription"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setDescription</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>description</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the description of the bookmark </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>description</em> </td><td> </td></tr> </table></dl> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4 </dd></dl> </p></div></div><a class="anchor" name="setFullText"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setFullText</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>fullText</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the text shown for the bookmark. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>fullText</em> </td><td> the new bookmark title </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setIcon"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setIcon</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>icon</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the icon name of the bookmark </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>icon</em> </td><td> the new icon name for this bookmark </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setMetaDataItem"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setMetaDataItem</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>key</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KBookmark.html#MetaDataOverwriteMode">KBookmark.MetaDataOverwriteMode</a> </td> <td class="paramname"><em>mode=KBookmark.OverwriteMetaData</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Change the value of a specific metadata item, or create the given item if it doesn't exist already (owner = "http://www.kde.org"). </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>key</em> </td><td> Name of the metadata item to change <tr><td></td><td valign="top"><em>value</em> </td><td> Value to use for the specified metadata item <tr><td></td><td valign="top"><em>mode</em> </td><td> Whether to overwrite the item's value if it exists already or not. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setMimeType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setMimeType</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>mimeType</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the Mime-Type of this item </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>Mime-Type</em> </td><td> </td></tr> </table></dl> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="setShowInToolbar"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setShowInToolbar</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">bool </td> <td class="paramname"><em>show</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set whether this bookmark is show in a filterd toolbar </p></div></div><a class="anchor" name="setUrl"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setUrl</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="../kdecore/KUrl.html">KUrl</a> </td> <td class="paramname"><em>url</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the URL of the bookmark </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>url</em> </td><td> the new bookmark URL </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="showInToolbar"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool showInToolbar</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> if the bookmark should be shown in the toolbar (used by the filtered toolbar) </dd></dl> </p></div></div><a class="anchor" name="text"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString text</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>Text shown for the bookmark If bigger than 40, the text is shortened by replacing middle characters with "..." (see KStringHandler.csqueeze) </p></div></div><a class="anchor" name="toGroup"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> toGroup</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>Convert this to a group - do this only if isGroup() returns true. </p></div></div><a class="anchor" name="updateAccessMetadata"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> updateAccessMetadata</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>Updates the bookmarks access metadata Call when a user accesses the bookmark </p></div></div><a class="anchor" name="url"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> url</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>URL contained by the bookmark </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="commonParent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString commonParent</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>A</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>B</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the common parent of both addresses which has the greatest depth </dd></dl> </p></div></div><a class="anchor" name="nextAddress"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString nextAddress</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>address</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> address of next sibling (e.g. /4/5/2 -> /4/5/3) This doesn't check whether it actually exists </dd></dl> </p></div></div><a class="anchor" name="parentAddress"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString parentAddress</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>address</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> address of parent </dd></dl> </p></div></div><a class="anchor" name="positionInParent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">long positionInParent</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>address</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> position in parent (e.g. /4/5/2 -> 2) </dd></dl> </p></div></div><a class="anchor" name="previousAddress"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString previousAddress</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>address</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> address of previous sibling (e.g. /4/5/2 -> /4/5/1) Returns QString() for a first child </dd></dl> </p></div></div><a class="anchor" name="standaloneBookmark"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KBookmark.html">KBookmark</a> standaloneBookmark</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>text</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">QString </td> <td class="paramname"><em>icon=QString()</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 stand alone bookmark. This is fairly expensive since a new QDom Tree is build. </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="MetaDataOverwriteMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">MetaDataOverwriteMode</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>OverwriteMetaData</em> </td><td><tr><td valign="top"><em>DontOverwriteMetaData</em> </td><td></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>