src/eric7/Documentation/Source/eric7.Preferences.SubstyleDefinitionDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.SubstyleDefinitionDialog</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.Preferences.SubstyleDefinitionDialog</h1>
10
11 <p>
12 Module implementing the sub-style definition 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="#SubstyleDefinitionDialog">SubstyleDefinitionDialog</a></td>
25 <td>Class implementing the sub-style definition 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="SubstyleDefinitionDialog" ID="SubstyleDefinitionDialog"></a>
36 <h2>SubstyleDefinitionDialog</h2>
37
38 <p>
39 Class implementing the sub-style definition dialog.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_SubstyleDefinitionDialog
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="#SubstyleDefinitionDialog.__init__">SubstyleDefinitionDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#SubstyleDefinitionDialog.__updateOk">__updateOk</a></td>
63 <td>Private slot to update the state of the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#SubstyleDefinitionDialog.getData">getData</a></td>
67 <td>Public method to get the entered data.</td>
68 </tr>
69 <tr>
70 <td><a href="#SubstyleDefinitionDialog.on_defaultButton_clicked">on_defaultButton_clicked</a></td>
71 <td>Private slot to set the dialog contents to default values.</td>
72 </tr>
73 <tr>
74 <td><a href="#SubstyleDefinitionDialog.on_descriptionEdit_textChanged">on_descriptionEdit_textChanged</a></td>
75 <td>Private slot handling changes of the description.</td>
76 </tr>
77 <tr>
78 <td><a href="#SubstyleDefinitionDialog.on_resetButton_clicked">on_resetButton_clicked</a></td>
79 <td>Private slot to reset the dialog contents.</td>
80 </tr>
81 <tr>
82 <td><a href="#SubstyleDefinitionDialog.on_wordsEdit_textChanged">on_wordsEdit_textChanged</a></td>
83 <td>Private slot handling changes of the word list.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="SubstyleDefinitionDialog.__init__" ID="SubstyleDefinitionDialog.__init__"></a>
93 <h4>SubstyleDefinitionDialog (Constructor)</h4>
94 <b>SubstyleDefinitionDialog</b>(<i>lexer, style, substyle, parent=None</i>)
95
96 <p>
97 Constructor
98 </p>
99 <dl>
100
101 <dt><i>lexer</i> (PreferencesLexer)</dt>
102 <dd>
103 reference to the lexer object
104 </dd>
105 <dt><i>style</i> (int)</dt>
106 <dd>
107 style number
108 </dd>
109 <dt><i>substyle</i> (int)</dt>
110 <dd>
111 sub-style number
112 </dd>
113 <dt><i>parent</i> (QWidget)</dt>
114 <dd>
115 reference to the parent widget
116 </dd>
117 </dl>
118 <a NAME="SubstyleDefinitionDialog.__updateOk" ID="SubstyleDefinitionDialog.__updateOk"></a>
119 <h4>SubstyleDefinitionDialog.__updateOk</h4>
120 <b>__updateOk</b>(<i></i>)
121
122 <p>
123 Private slot to update the state of the OK button.
124 </p>
125 <a NAME="SubstyleDefinitionDialog.getData" ID="SubstyleDefinitionDialog.getData"></a>
126 <h4>SubstyleDefinitionDialog.getData</h4>
127 <b>getData</b>(<i></i>)
128
129 <p>
130 Public method to get the entered data.
131 </p>
132 <dl>
133 <dt>Return:</dt>
134 <dd>
135 tuple containing the sub-style description and words list.
136 </dd>
137 </dl>
138 <dl>
139 <dt>Return Type:</dt>
140 <dd>
141 tuple of (str, str)
142 </dd>
143 </dl>
144 <a NAME="SubstyleDefinitionDialog.on_defaultButton_clicked" ID="SubstyleDefinitionDialog.on_defaultButton_clicked"></a>
145 <h4>SubstyleDefinitionDialog.on_defaultButton_clicked</h4>
146 <b>on_defaultButton_clicked</b>(<i></i>)
147
148 <p>
149 Private slot to set the dialog contents to default values.
150 </p>
151 <a NAME="SubstyleDefinitionDialog.on_descriptionEdit_textChanged" ID="SubstyleDefinitionDialog.on_descriptionEdit_textChanged"></a>
152 <h4>SubstyleDefinitionDialog.on_descriptionEdit_textChanged</h4>
153 <b>on_descriptionEdit_textChanged</b>(<i>txt</i>)
154
155 <p>
156 Private slot handling changes of the description.
157 </p>
158 <dl>
159
160 <dt><i>txt</i> (str)</dt>
161 <dd>
162 text of the description
163 </dd>
164 </dl>
165 <a NAME="SubstyleDefinitionDialog.on_resetButton_clicked" ID="SubstyleDefinitionDialog.on_resetButton_clicked"></a>
166 <h4>SubstyleDefinitionDialog.on_resetButton_clicked</h4>
167 <b>on_resetButton_clicked</b>(<i></i>)
168
169 <p>
170 Private slot to reset the dialog contents.
171 </p>
172 <a NAME="SubstyleDefinitionDialog.on_wordsEdit_textChanged" ID="SubstyleDefinitionDialog.on_wordsEdit_textChanged"></a>
173 <h4>SubstyleDefinitionDialog.on_wordsEdit_textChanged</h4>
174 <b>on_wordsEdit_textChanged</b>(<i></i>)
175
176 <p>
177 Private slot handling changes of the word list.
178 </p>
179 <div align="right"><a href="#top">Up</a></div>
180 <hr />
181 </body></html>

eric ide

mercurial