<?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>KIO.JobUiDelegate</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.4 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>JobUiDelegate Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> Inherits: <a href="../kdeui/KDialogJobUiDelegate.html">KDialogJobUiDelegate</a> → <a href="../kdecore/KJobUiDelegate.html">KJobUiDelegate</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br /> Namespace: KIO.JobUiDelegate<br /> <h2>Detailed Description</h2> <p>A UI delegate tuned to be used with KIO Jobs. </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="#ConfirmationType">ConfirmationType</a> </td><td class="memItemRight" valign="bottom">{ DefaultConfirmation, ForceConfirmation }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#DeletionType">DeletionType</a> </td><td class="memItemRight" valign="bottom">{ Delete, Trash }</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="#JobUiDelegate">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#askDeleteConfirmation">askDeleteConfirmation</a> (self, <a href="../kdecore/KUrl.List.html">KUrl.List</a> urls, <a href="../kio/KIO.JobUiDelegate.html#DeletionType">KIO.JobUiDelegate.DeletionType</a> deletionType, <a href="../kio/KIO.JobUiDelegate.html#ConfirmationType">KIO.JobUiDelegate.ConfirmationType</a> confirmationType)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.html#RenameDialog_Result">KIO.RenameDialog_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#askFileRename">askFileRename</a> (self, <a href="../kdecore/KJob.html">KJob</a> job, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> src, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> dest, <a href="../kio/KIO.html#RenameDialog_Mode">KIO.RenameDialog_Mode</a> mode, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> newDest, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> sizeSrc=-1, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> sizeDest=-1, <a href="../kdecore/time_t.html">time_t</a> ctimeSrc=-1, <a href="../kdecore/time_t.html">time_t</a> ctimeDest=-1, <a href="../kdecore/time_t.html">time_t</a> mtimeSrc=-1, <a href="../kdecore/time_t.html">time_t</a> mtimeDest=-1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.html#SkipDialog_Result">KIO.SkipDialog_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#askSkip">askSkip</a> (self, <a href="../kdecore/KJob.html">KJob</a> job, bool multi, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> error_text)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setWindow">setWindow</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> window)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="JobUiDelegate"></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 new KIO Job UI delegate. </p></div></div><a class="anchor" name="askDeleteConfirmation"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool askDeleteConfirmation</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.List.html">KUrl.List</a> </td> <td class="paramname"><em>urls</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.JobUiDelegate.html#DeletionType">KIO.JobUiDelegate.DeletionType</a> </td> <td class="paramname"><em>deletionType</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.JobUiDelegate.html#ConfirmationType">KIO.JobUiDelegate.ConfirmationType</a> </td> <td class="paramname"><em>confirmationType</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Ask for confirmation before deleting/trashing <b>urls.</b> </p> <p> Note that this method is not called automatically by KIO jobs. It's the application's responsibility to ask the user for confirmation before calling KIO.del() or KIO.trash(). </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>urls</em> </td><td> the urls about to be deleted/trashed <tr><td></td><td valign="top"><em>method</em> </td><td> the type of deletion (Delete for real deletion, Trash otherwise) <tr><td></td><td valign="top"><em>confirmation</em> </td><td> see ConfirmationType. Normally set to DefaultConfirmation. Note: the window passed to setWindow is used as the parent for the message box. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if confirmed </dd></dl> </p></div></div><a class="anchor" name="askFileRename"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KIO.html#RenameDialog_Result">KIO.RenameDialog_Result</a> askFileRename</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/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>caption</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>dest</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.html#RenameDialog_Mode">KIO.RenameDialog_Mode</a> </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>newDest</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> </td> <td class="paramname"><em>sizeSrc=-1</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> </td> <td class="paramname"><em>sizeDest=-1</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td> <td class="paramname"><em>ctimeSrc=-1</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td> <td class="paramname"><em>ctimeDest=-1</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td> <td class="paramname"><em>mtimeSrc=-1</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td> <td class="paramname"><em>mtimeDest=-1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Construct a modal, parent-less "rename" dialog, and return a result code, as well as the new dest. Much easier to use than the class RenameDialog directly. </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>caption</em> </td><td> the caption for the dialog box <tr><td></td><td valign="top"><em>src</em> </td><td> the URL of the file/dir we're trying to copy, as it's part of the text message <tr><td></td><td valign="top"><em>dest</em> </td><td> the URL of the destination file/dir, i.e. the one that already exists <tr><td></td><td valign="top"><em>mode</em> </td><td> parameters for the dialog (which buttons to show...), see RenameDialog_Mode <tr><td></td><td valign="top"><em>newDestPath</em> </td><td> the new destination path, valid if R_RENAME was returned. <tr><td></td><td valign="top"><em>sizeSrc</em> </td><td> size of source file <tr><td></td><td valign="top"><em>sizeDest</em> </td><td> size of destination file <tr><td></td><td valign="top"><em>ctimeSrc</em> </td><td> creation time of source file <tr><td></td><td valign="top"><em>ctimeDest</em> </td><td> creation time of destination file <tr><td></td><td valign="top"><em>mtimeSrc</em> </td><td> modification time of source file <tr><td></td><td valign="top"><em>mtimeDest</em> </td><td> modification time of destination file </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the result </dd></dl> </p></div></div><a class="anchor" name="askSkip"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KIO.html#SkipDialog_Result">KIO.SkipDialog_Result</a> askSkip</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/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>multi</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>error_text</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="internal" compact><dt><b>Internal:</b></dt><dd> See skipdialog.h </dd></dl> </p></div></div><a class="anchor" name="setWindow"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setWindow</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </td> <td class="paramname"><em>window</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Associate this job with a window given by <b>window.</b> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>window</em> </td><td> the window to associate to </td></tr> </table></dl> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> window() </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ConfirmationType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">ConfirmationType</td> </tr> </table> </div> <div class="memdoc"><p>ForceConfirmation: always ask the user for confirmation DefaultConfirmation: don't ask the user if he/she said "don't ask again". </p> <p> Used by askDeleteConfirmation. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>DefaultConfirmation</em> </td><td><tr><td valign="top"><em>ForceConfirmation</em> </td><td></table> </dl> </div></div><p><a class="anchor" name="DeletionType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">DeletionType</td> </tr> </table> </div> <div class="memdoc"><p>The type of deletion: real deletion, or moving the files to the trash Used by askDeleteConfirmation. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Delete</em> </td><td><tr><td valign="top"><em>Trash</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>