Mercurial Repositories > IRC client / file comparison
comparison: ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog.html
ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog.html
- changeset 3
- 51c2c37bde76
equal
deleted
inserted
replaced
| 2:5b635dc8895f | 3:51c2c37bde76 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog</h1> | |
| 10 <p> | |
| 11 Module implementing a dialog to edit channel data. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#IrcChannelEditDialog">IrcChannelEditDialog</a></td> | |
| 23 <td>Class implementing a dialog to edit channel data.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="IrcChannelEditDialog" ID="IrcChannelEditDialog"></a> | |
| 35 <h2>IrcChannelEditDialog</h2> | |
| 36 <p> | |
| 37 Class implementing a dialog to edit channel data. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 QDialog, Ui_IrcChannelEditDialog | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>None</td></tr> | |
| 45 </table> | |
| 46 | |
| 47 <h3>Class Methods</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#IrcChannelEditDialog.__init__">IrcChannelEditDialog</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#IrcChannelEditDialog.getData">getData</a></td> | |
| 60 <td>Public method to get the channel data.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#IrcChannelEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> | |
| 64 <td>Private slot to handle changes of the given name.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 | |
| 68 <h3>Static Methods</h3> | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 | |
| 73 | |
| 74 <a NAME="IrcChannelEditDialog.__init__" ID="IrcChannelEditDialog.__init__"></a> | |
| 75 <h4>IrcChannelEditDialog (Constructor)</h4> | |
| 76 <b>IrcChannelEditDialog</b>(<i>name, key, autoJoin, edit, parent=None</i>) | |
| 77 <p> | |
| 78 Constructor | |
| 79 </p> | |
| 80 | |
| 81 <dl> | |
| 82 | |
| 83 <dt><i>name</i> (str)</dt> | |
| 84 <dd> | |
| 85 channel name | |
| 86 </dd> | |
| 87 <dt><i>key</i> (str)</dt> | |
| 88 <dd> | |
| 89 channel key | |
| 90 </dd> | |
| 91 <dt><i>autoJoin</i> (bool)</dt> | |
| 92 <dd> | |
| 93 flag indicating, that the channel should | |
| 94 be joined automatically | |
| 95 </dd> | |
| 96 <dt><i>edit</i> (bool)</dt> | |
| 97 <dd> | |
| 98 flag indicating an edit of an existing | |
| 99 channel | |
| 100 </dd> | |
| 101 <dt><i>parent</i> (QWidget)</dt> | |
| 102 <dd> | |
| 103 reference to the parent widget | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <a NAME="IrcChannelEditDialog.getData" ID="IrcChannelEditDialog.getData"></a> | |
| 107 <h4>IrcChannelEditDialog.getData</h4> | |
| 108 <b>getData</b>(<i></i>) | |
| 109 <p> | |
| 110 Public method to get the channel data. | |
| 111 </p> | |
| 112 | |
| 113 <dl> | |
| 114 <dt>Return:</dt> | |
| 115 <dd> | |
| 116 tuple giving the channel name, channel key and a flag | |
| 117 indicating, that the channel should be joined automatically | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <dl> | |
| 121 <dt>Return Type:</dt> | |
| 122 <dd> | |
| 123 tuple of (str, str, bool) | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <a NAME="IrcChannelEditDialog.on_nameEdit_textChanged" ID="IrcChannelEditDialog.on_nameEdit_textChanged"></a> | |
| 127 <h4>IrcChannelEditDialog.on_nameEdit_textChanged</h4> | |
| 128 <b>on_nameEdit_textChanged</b>(<i>txt</i>) | |
| 129 <p> | |
| 130 Private slot to handle changes of the given name. | |
| 131 </p> | |
| 132 | |
| 133 <dl> | |
| 134 | |
| 135 <dt><i>txt</i> (str)</dt> | |
| 136 <dd> | |
| 137 text of the edit | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <div align="right"><a href="#top">Up</a></div> | |
| 141 <hr /> | |
| 142 </body></html> |
