eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7989
a21d673a8f99
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog</title>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
21 <body>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
22 <a NAME="top" ID="top"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
24
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing a dialog to select code style message codes.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
29
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
34
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
36
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#CodeStyleCodeSelectionDialog">CodeStyleCodeSelectionDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class implementing a dialog to select code style message codes.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
43
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
47 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
48 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <a NAME="CodeStyleCodeSelectionDialog" ID="CodeStyleCodeSelectionDialog"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h2>CodeStyleCodeSelectionDialog</h2>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
51
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 Class implementing a dialog to select code style message codes.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <h3>Derived from</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 QDialog, Ui_CodeStyleCodeSelectionDialog
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Class Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
58
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <h3>Class Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
63
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <h3>Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
68
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
70
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="#CodeStyleCodeSelectionDialog.__init__">CodeStyleCodeSelectionDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <td>Constructor</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
74 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
75 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td><a href="#CodeStyleCodeSelectionDialog.getSelectedCodes">getSelectedCodes</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <td>Public method to get a comma separated list of codes selected.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <h3>Static Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
81
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
85
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <a NAME="CodeStyleCodeSelectionDialog.__init__" ID="CodeStyleCodeSelectionDialog.__init__"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <h4>CodeStyleCodeSelectionDialog (Constructor)</h4>
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
88 <b>CodeStyleCodeSelectionDialog</b>(<i>codes, categories, showFixCodes, parent=None</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
89
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 Constructor
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
92 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
93 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
94
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
95 <dt><i>codes</i> (str)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dd>
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
97 comma separated list of selected codes
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
98 </dd>
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
99 <dt><i>categories</i> (list of str)</dt>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
100 <dd>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
101 list of message categories to omit
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
102 </dd>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
103 <dt><i>showFixCodes</i> (bool)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 flag indicating to show a list of fixable
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
106 issues
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
107 </dd>
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
108 <dt><i>parent</i> (QWidget)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <dd>
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
110 reference to the parent widget
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
112 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
113 <a NAME="CodeStyleCodeSelectionDialog.getSelectedCodes" ID="CodeStyleCodeSelectionDialog.getSelectedCodes"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <h4>CodeStyleCodeSelectionDialog.getSelectedCodes</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <b>getSelectedCodes</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
116
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 Public method to get a comma separated list of codes selected.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
119 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
120 <dl>
7989
a21d673a8f99 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7609
diff changeset
121 <dt>Return:</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <dd>
7609
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
123 comma separated list of selected codes
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
124 </dd>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
125 </dl>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
126 <dl>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
127 <dt>Return Type:</dt>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
128 <dd>
d5aff4fd0ef8 Code Style Checker: changed the dialog to allow the selection of checker categories.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
129 str
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <div align="right"><a href="#top">Up</a></div>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 <hr />
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 </body></html>

eric ide

mercurial