Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Templates.TemplatePropertiesDialog.html
src/eric7/Documentation/Source/eric7.Templates.TemplatePropertiesDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Templates.TemplatePropertiesDialog</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>eric7.Templates.TemplatePropertiesDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the templates properties dialog. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#TemplatePropertiesDialog">TemplatePropertiesDialog</a></td> | |
| 25 <td>Class implementing the templates properties dialog.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="TemplatePropertiesDialog" ID="TemplatePropertiesDialog"></a> | |
| 36 <h2>TemplatePropertiesDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the templates properties dialog. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_TemplatePropertiesDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#TemplatePropertiesDialog.__init__">TemplatePropertiesDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#TemplatePropertiesDialog.getData">getData</a></td> | |
| 63 <td>Public method to get the data entered into the dialog.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#TemplatePropertiesDialog.keyPressEvent">keyPressEvent</a></td> | |
| 67 <td>Protected method to handle the user pressing the escape key.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#TemplatePropertiesDialog.on_helpButton_clicked">on_helpButton_clicked</a></td> | |
| 71 <td>Private slot to show some help.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#TemplatePropertiesDialog.setSelectedGroup">setSelectedGroup</a></td> | |
| 75 <td>Public method to select a group.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="TemplatePropertiesDialog.__init__" ID="TemplatePropertiesDialog.__init__"></a> | |
| 85 <h4>TemplatePropertiesDialog (Constructor)</h4> | |
| 86 <b>TemplatePropertiesDialog</b>(<i>parent, groupMode=False, itm=None</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>parent</i></dt> | |
| 94 <dd> | |
| 95 the parent widget (QWidget) | |
| 96 </dd> | |
| 97 <dt><i>groupMode</i></dt> | |
| 98 <dd> | |
| 99 flag indicating group mode (boolean) | |
| 100 </dd> | |
| 101 <dt><i>itm</i></dt> | |
| 102 <dd> | |
| 103 item (TemplateEntry or TemplateGroup) to | |
| 104 read the data from | |
| 105 </dd> | |
| 106 </dl> | |
| 107 <a NAME="TemplatePropertiesDialog.getData" ID="TemplatePropertiesDialog.getData"></a> | |
| 108 <h4>TemplatePropertiesDialog.getData</h4> | |
| 109 <b>getData</b>(<i></i>) | |
| 110 | |
| 111 <p> | |
| 112 Public method to get the data entered into the dialog. | |
| 113 </p> | |
| 114 <dl> | |
| 115 <dt>Return:</dt> | |
| 116 <dd> | |
| 117 a tuple of two strings (name, language), if the dialog is in | |
| 118 group mode, and a tuple of four strings (name, description, group | |
| 119 name, template) otherwise. | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <a NAME="TemplatePropertiesDialog.keyPressEvent" ID="TemplatePropertiesDialog.keyPressEvent"></a> | |
| 123 <h4>TemplatePropertiesDialog.keyPressEvent</h4> | |
| 124 <b>keyPressEvent</b>(<i>ev</i>) | |
| 125 | |
| 126 <p> | |
| 127 Protected method to handle the user pressing the escape key. | |
| 128 </p> | |
| 129 <dl> | |
| 130 | |
| 131 <dt><i>ev</i></dt> | |
| 132 <dd> | |
| 133 key event (QKeyEvent) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="TemplatePropertiesDialog.on_helpButton_clicked" ID="TemplatePropertiesDialog.on_helpButton_clicked"></a> | |
| 137 <h4>TemplatePropertiesDialog.on_helpButton_clicked</h4> | |
| 138 <b>on_helpButton_clicked</b>(<i></i>) | |
| 139 | |
| 140 <p> | |
| 141 Private slot to show some help. | |
| 142 </p> | |
| 143 <a NAME="TemplatePropertiesDialog.setSelectedGroup" ID="TemplatePropertiesDialog.setSelectedGroup"></a> | |
| 144 <h4>TemplatePropertiesDialog.setSelectedGroup</h4> | |
| 145 <b>setSelectedGroup</b>(<i>name</i>) | |
| 146 | |
| 147 <p> | |
| 148 Public method to select a group. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>name</i></dt> | |
| 153 <dd> | |
| 154 name of the group to be selected (string) | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <div align="right"><a href="#top">Up</a></div> | |
| 158 <hr /> | |
| 159 </body></html> |
