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

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7989
a21d673a8f99
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Templates.TemplatePropertiesDialog</h1> 23 <h1>eric6.Templates.TemplatePropertiesDialog</h1>
24
23 <p> 25 <p>
24 Module implementing the templates properties dialog. 26 Module implementing the templates properties dialog.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#TemplatePropertiesDialog">TemplatePropertiesDialog</a></td> 38 <td><a href="#TemplatePropertiesDialog">TemplatePropertiesDialog</a></td>
34 <td>Class implementing the templates properties dialog.</td> 39 <td>Class implementing the templates properties dialog.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="TemplatePropertiesDialog" ID="TemplatePropertiesDialog"></a> 49 <a NAME="TemplatePropertiesDialog" ID="TemplatePropertiesDialog"></a>
43 <h2>TemplatePropertiesDialog</h2> 50 <h2>TemplatePropertiesDialog</h2>
51
44 <p> 52 <p>
45 Class implementing the templates properties dialog. 53 Class implementing the templates properties dialog.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_TemplatePropertiesDialog 56 QDialog, Ui_TemplatePropertiesDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#TemplatePropertiesDialog.__init__">TemplatePropertiesDialog</a></td> 72 <td><a href="#TemplatePropertiesDialog.__init__">TemplatePropertiesDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#TemplatePropertiesDialog.getData">getData</a></td> 76 <td><a href="#TemplatePropertiesDialog.getData">getData</a></td>
64 <td>Public method to get the data entered into the dialog.</td> 77 <td>Public method to get the data entered into the dialog.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#TemplatePropertiesDialog.keyPressEvent">keyPressEvent</a></td> 80 <td><a href="#TemplatePropertiesDialog.keyPressEvent">keyPressEvent</a></td>
67 <td>Protected method to handle the user pressing the escape key.</td> 81 <td>Protected method to handle the user pressing the escape key.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#TemplatePropertiesDialog.on_helpButton_clicked">on_helpButton_clicked</a></td> 84 <td><a href="#TemplatePropertiesDialog.on_helpButton_clicked">on_helpButton_clicked</a></td>
70 <td>Private slot to show some help.</td> 85 <td>Private slot to show some help.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#TemplatePropertiesDialog.setSelectedGroup">setSelectedGroup</a></td> 88 <td><a href="#TemplatePropertiesDialog.setSelectedGroup">setSelectedGroup</a></td>
73 <td>Public method to select a group.</td> 89 <td>Public method to select a group.</td>
74 </tr> 90 </tr>
75 </table> 91 </table>
76 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
93
77 <table> 94 <table>
78 <tr><td>None</td></tr> 95 <tr><td>None</td></tr>
79 </table> 96 </table>
97
80 <a NAME="TemplatePropertiesDialog.__init__" ID="TemplatePropertiesDialog.__init__"></a> 98 <a NAME="TemplatePropertiesDialog.__init__" ID="TemplatePropertiesDialog.__init__"></a>
81 <h4>TemplatePropertiesDialog (Constructor)</h4> 99 <h4>TemplatePropertiesDialog (Constructor)</h4>
82 <b>TemplatePropertiesDialog</b>(<i>parent, groupMode=False, itm=None</i>) 100 <b>TemplatePropertiesDialog</b>(<i>parent, groupMode=False, itm=None</i>)
101
83 <p> 102 <p>
84 Constructor 103 Constructor
85 </p><dl> 104 </p>
105 <dl>
106
86 <dt><i>parent</i></dt> 107 <dt><i>parent</i></dt>
87 <dd> 108 <dd>
88 the parent widget (QWidget) 109 the parent widget (QWidget)
89 </dd><dt><i>groupMode</i></dt> 110 </dd>
111 <dt><i>groupMode</i></dt>
90 <dd> 112 <dd>
91 flag indicating group mode (boolean) 113 flag indicating group mode (boolean)
92 </dd><dt><i>itm</i></dt> 114 </dd>
115 <dt><i>itm</i></dt>
93 <dd> 116 <dd>
94 item (TemplateEntry or TemplateGroup) to 117 item (TemplateEntry or TemplateGroup) to
95 read the data from 118 read the data from
96 </dd> 119 </dd>
97 </dl><a NAME="TemplatePropertiesDialog.getData" ID="TemplatePropertiesDialog.getData"></a> 120 </dl>
121 <a NAME="TemplatePropertiesDialog.getData" ID="TemplatePropertiesDialog.getData"></a>
98 <h4>TemplatePropertiesDialog.getData</h4> 122 <h4>TemplatePropertiesDialog.getData</h4>
99 <b>getData</b>(<i></i>) 123 <b>getData</b>(<i></i>)
124
100 <p> 125 <p>
101 Public method to get the data entered into the dialog. 126 Public method to get the data entered into the dialog.
102 </p><dl> 127 </p>
128 <dl>
103 <dt>Returns:</dt> 129 <dt>Returns:</dt>
104 <dd> 130 <dd>
105 a tuple of two strings (name, language), if the dialog is in 131 a tuple of two strings (name, language), if the dialog is in
106 group mode, and a tuple of four strings (name, description, group 132 group mode, and a tuple of four strings (name, description, group
107 name, template) otherwise. 133 name, template) otherwise.
108 </dd> 134 </dd>
109 </dl><a NAME="TemplatePropertiesDialog.keyPressEvent" ID="TemplatePropertiesDialog.keyPressEvent"></a> 135 </dl>
136 <a NAME="TemplatePropertiesDialog.keyPressEvent" ID="TemplatePropertiesDialog.keyPressEvent"></a>
110 <h4>TemplatePropertiesDialog.keyPressEvent</h4> 137 <h4>TemplatePropertiesDialog.keyPressEvent</h4>
111 <b>keyPressEvent</b>(<i>ev</i>) 138 <b>keyPressEvent</b>(<i>ev</i>)
139
112 <p> 140 <p>
113 Protected method to handle the user pressing the escape key. 141 Protected method to handle the user pressing the escape key.
114 </p><dl> 142 </p>
143 <dl>
144
115 <dt><i>ev</i></dt> 145 <dt><i>ev</i></dt>
116 <dd> 146 <dd>
117 key event (QKeyEvent) 147 key event (QKeyEvent)
118 </dd> 148 </dd>
119 </dl><a NAME="TemplatePropertiesDialog.on_helpButton_clicked" ID="TemplatePropertiesDialog.on_helpButton_clicked"></a> 149 </dl>
150 <a NAME="TemplatePropertiesDialog.on_helpButton_clicked" ID="TemplatePropertiesDialog.on_helpButton_clicked"></a>
120 <h4>TemplatePropertiesDialog.on_helpButton_clicked</h4> 151 <h4>TemplatePropertiesDialog.on_helpButton_clicked</h4>
121 <b>on_helpButton_clicked</b>(<i></i>) 152 <b>on_helpButton_clicked</b>(<i></i>)
153
122 <p> 154 <p>
123 Private slot to show some help. 155 Private slot to show some help.
124 </p><a NAME="TemplatePropertiesDialog.setSelectedGroup" ID="TemplatePropertiesDialog.setSelectedGroup"></a> 156 </p>
157 <a NAME="TemplatePropertiesDialog.setSelectedGroup" ID="TemplatePropertiesDialog.setSelectedGroup"></a>
125 <h4>TemplatePropertiesDialog.setSelectedGroup</h4> 158 <h4>TemplatePropertiesDialog.setSelectedGroup</h4>
126 <b>setSelectedGroup</b>(<i>name</i>) 159 <b>setSelectedGroup</b>(<i>name</i>)
160
127 <p> 161 <p>
128 Public method to select a group. 162 Public method to select a group.
129 </p><dl> 163 </p>
164 <dl>
165
130 <dt><i>name</i></dt> 166 <dt><i>name</i></dt>
131 <dd> 167 <dd>
132 name of the group to be selected (string) 168 name of the group to be selected (string)
133 </dd> 169 </dd>
134 </dl> 170 </dl>

eric ide

mercurial