eric6/Documentation/Source/eric6.Templates.TemplatePropertiesDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Templates.TemplatePropertiesDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Templates.TemplatePropertiesDialog</h1>
23 <p>
24 Module implementing the templates properties dialog.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#TemplatePropertiesDialog">TemplatePropertiesDialog</a></td>
34 <td>Class implementing the templates properties dialog.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="TemplatePropertiesDialog" ID="TemplatePropertiesDialog"></a>
43 <h2>TemplatePropertiesDialog</h2>
44 <p>
45 Class implementing the templates properties dialog.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_TemplatePropertiesDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#TemplatePropertiesDialog.__init__">TemplatePropertiesDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#TemplatePropertiesDialog.getData">getData</a></td>
64 <td>Public method to get the data entered into the dialog.</td>
65 </tr><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><tr>
69 <td><a href="#TemplatePropertiesDialog.on_helpButton_clicked">on_helpButton_clicked</a></td>
70 <td>Private slot to show some help.</td>
71 </tr><tr>
72 <td><a href="#TemplatePropertiesDialog.setSelectedGroup">setSelectedGroup</a></td>
73 <td>Public method to select a group.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <a NAME="TemplatePropertiesDialog.__init__" ID="TemplatePropertiesDialog.__init__"></a>
81 <h4>TemplatePropertiesDialog (Constructor)</h4>
82 <b>TemplatePropertiesDialog</b>(<i>parent, groupMode=False, itm=None</i>)
83 <p>
84 Constructor
85 </p><dl>
86 <dt><i>parent</i></dt>
87 <dd>
88 the parent widget (QWidget)
89 </dd><dt><i>groupMode</i></dt>
90 <dd>
91 flag indicating group mode (boolean)
92 </dd><dt><i>itm</i></dt>
93 <dd>
94 item (TemplateEntry or TemplateGroup) to
95 read the data from
96 </dd>
97 </dl><a NAME="TemplatePropertiesDialog.getData" ID="TemplatePropertiesDialog.getData"></a>
98 <h4>TemplatePropertiesDialog.getData</h4>
99 <b>getData</b>(<i></i>)
100 <p>
101 Public method to get the data entered into the dialog.
102 </p><dl>
103 <dt>Returns:</dt>
104 <dd>
105 a tuple of two strings (name, language), if the dialog is in
106 group mode, and a tuple of four strings (name, description, group
107 name, template) otherwise.
108 </dd>
109 </dl><a NAME="TemplatePropertiesDialog.keyPressEvent" ID="TemplatePropertiesDialog.keyPressEvent"></a>
110 <h4>TemplatePropertiesDialog.keyPressEvent</h4>
111 <b>keyPressEvent</b>(<i>ev</i>)
112 <p>
113 Protected method to handle the user pressing the escape key.
114 </p><dl>
115 <dt><i>ev</i></dt>
116 <dd>
117 key event (QKeyEvent)
118 </dd>
119 </dl><a NAME="TemplatePropertiesDialog.on_helpButton_clicked" ID="TemplatePropertiesDialog.on_helpButton_clicked"></a>
120 <h4>TemplatePropertiesDialog.on_helpButton_clicked</h4>
121 <b>on_helpButton_clicked</b>(<i></i>)
122 <p>
123 Private slot to show some help.
124 </p><a NAME="TemplatePropertiesDialog.setSelectedGroup" ID="TemplatePropertiesDialog.setSelectedGroup"></a>
125 <h4>TemplatePropertiesDialog.setSelectedGroup</h4>
126 <b>setSelectedGroup</b>(<i>name</i>)
127 <p>
128 Public method to select a group.
129 </p><dl>
130 <dt><i>name</i></dt>
131 <dd>
132 name of the group to be selected (string)
133 </dd>
134 </dl>
135 <div align="right"><a href="#top">Up</a></div>
136 <hr />
137 </body></html>

eric ide

mercurial