Documentation/Source/eric4.Templates.TemplatePropertiesDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Templates.TemplatePropertiesDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Templates.TemplatePropertiesDialog</h1>
24 <p>
25 Module implementing the templates properties dialog.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#TemplatePropertiesDialog">TemplatePropertiesDialog</a></td>
35 <td>Class implementing the templates properties dialog.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="TemplatePropertiesDialog" ID="TemplatePropertiesDialog"></a>
44 <h2>TemplatePropertiesDialog</h2>
45 <p>
46 Class implementing the templates properties dialog.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_TemplatePropertiesDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#TemplatePropertiesDialog.__init__">TemplatePropertiesDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#TemplatePropertiesDialog.getData">getData</a></td>
61 <td>Public method to get the data entered into the dialog.</td>
62 </tr><tr>
63 <td><a href="#TemplatePropertiesDialog.keyPressEvent">keyPressEvent</a></td>
64 <td>Re-implemented to handle the user pressing the escape key.</td>
65 </tr><tr>
66 <td><a href="#TemplatePropertiesDialog.on_helpButton_clicked">on_helpButton_clicked</a></td>
67 <td>Public slot to show some help.</td>
68 </tr><tr>
69 <td><a href="#TemplatePropertiesDialog.setSelectedGroup">setSelectedGroup</a></td>
70 <td>Public method to select a group.</td>
71 </tr>
72 </table>
73 <a NAME="TemplatePropertiesDialog.__init__" ID="TemplatePropertiesDialog.__init__"></a>
74 <h4>TemplatePropertiesDialog (Constructor)</h4>
75 <b>TemplatePropertiesDialog</b>(<i>parent, groupMode = False, itm = None</i>)
76 <p>
77 Constructor
78 </p><dl>
79 <dt><i>parent</i></dt>
80 <dd>
81 the parent widget (QWidget)
82 </dd><dt><i>groupMode</i></dt>
83 <dd>
84 flag indicating group mode (boolean)
85 </dd><dt><i>itm</i></dt>
86 <dd>
87 item (TemplateEntry or TemplateGroup) to
88 read the data from
89 </dd>
90 </dl><a NAME="TemplatePropertiesDialog.getData" ID="TemplatePropertiesDialog.getData"></a>
91 <h4>TemplatePropertiesDialog.getData</h4>
92 <b>getData</b>(<i></i>)
93 <p>
94 Public method to get the data entered into the dialog.
95 </p><dl>
96 <dt>Returns:</dt>
97 <dd>
98 a tuple of two strings (name, language), if the dialog is in group mode,
99 and a tuple of four strings (name, description, group name, template)
100 otherwise.
101 </dd>
102 </dl><a NAME="TemplatePropertiesDialog.keyPressEvent" ID="TemplatePropertiesDialog.keyPressEvent"></a>
103 <h4>TemplatePropertiesDialog.keyPressEvent</h4>
104 <b>keyPressEvent</b>(<i>ev</i>)
105 <p>
106 Re-implemented to handle the user pressing the escape key.
107 </p><dl>
108 <dt><i>ev</i></dt>
109 <dd>
110 key event (QKeyEvent)
111 </dd>
112 </dl><a NAME="TemplatePropertiesDialog.on_helpButton_clicked" ID="TemplatePropertiesDialog.on_helpButton_clicked"></a>
113 <h4>TemplatePropertiesDialog.on_helpButton_clicked</h4>
114 <b>on_helpButton_clicked</b>(<i></i>)
115 <p>
116 Public slot to show some help.
117 </p><a NAME="TemplatePropertiesDialog.setSelectedGroup" ID="TemplatePropertiesDialog.setSelectedGroup"></a>
118 <h4>TemplatePropertiesDialog.setSelectedGroup</h4>
119 <b>setSelectedGroup</b>(<i>name</i>)
120 <p>
121 Public method to select a group.
122 </p><dl>
123 <dt><i>name</i></dt>
124 <dd>
125 name of the group to be selected (string)
126 </dd>
127 </dl>
128 <div align="right"><a href="#top">Up</a></div>
129 <hr />
130 </body></html>

eric ide

mercurial