|
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>eric5.Preferences.ProgramsDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Preferences.ProgramsDialog</h1> |
|
12 <p> |
|
13 Module implementing the Programs page. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#ProgramsDialog">ProgramsDialog</a></td> |
|
23 <td>Class implementing the Programs page.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="ProgramsDialog" ID="ProgramsDialog"></a> |
|
32 <h2>ProgramsDialog</h2> |
|
33 <p> |
|
34 Class implementing the Programs page. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QDialog, Ui_ProgramsDialog |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td> |
|
49 <td>Private method to generate a program entry.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td> |
|
52 <td>Private method to generate a program entry.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#ProgramsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
55 <td>Private slot called by a button of the button box clicked.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td> |
|
58 <td>Private slot to search for all supported/required programs.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#ProgramsDialog.show">show</a></td> |
|
61 <td>Public slot to show the dialog.</td> |
|
62 </tr> |
|
63 </table> |
|
64 <a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a> |
|
65 <h4>ProgramsDialog (Constructor)</h4> |
|
66 <b>ProgramsDialog</b>(<i>parent = None</i>) |
|
67 <p> |
|
68 Constructor |
|
69 </p><dl> |
|
70 <dt><i>parent</i></dt> |
|
71 <dd> |
|
72 The parent widget of this dialog. (QWidget) |
|
73 </dd> |
|
74 </dl><a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a> |
|
75 <h4>ProgramsDialog.__createEntry</h4> |
|
76 <b>__createEntry</b>(<i>description, entryText, entryVersion</i>) |
|
77 <p> |
|
78 Private method to generate a program entry. |
|
79 </p><dl> |
|
80 <dt><i>description</i></dt> |
|
81 <dd> |
|
82 descriptive text (string) |
|
83 </dd><dt><i>entryText</i></dt> |
|
84 <dd> |
|
85 text to show (string) |
|
86 </dd><dt><i>entryVersion</i></dt> |
|
87 <dd> |
|
88 version string to show (string). |
|
89 </dd> |
|
90 </dl><a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a> |
|
91 <h4>ProgramsDialog.__createProgramEntry</h4> |
|
92 <b>__createProgramEntry</b>(<i>description, exe, versionCommand = "", versionStartsWith = "", versionPosition = 0, version = "", versionCleanup = None, versionRe = None</i>) |
|
93 <p> |
|
94 Private method to generate a program entry. |
|
95 </p><dl> |
|
96 <dt><i>description</i></dt> |
|
97 <dd> |
|
98 descriptive text (string) |
|
99 </dd><dt><i>exe</i></dt> |
|
100 <dd> |
|
101 name of the executable program (string) |
|
102 </dd><dt><i>versionCommand</i></dt> |
|
103 <dd> |
|
104 command line switch to get the version info (string) |
|
105 if this is empty, the given version will be shown. |
|
106 </dd><dt><i>versionStartsWith</i></dt> |
|
107 <dd> |
|
108 start of line identifying version info (string) |
|
109 </dd><dt><i>versionPosition</i></dt> |
|
110 <dd> |
|
111 index of part containing the version info (integer) |
|
112 </dd><dt><i>version=</i></dt> |
|
113 <dd> |
|
114 version string to show (string) |
|
115 </dd><dt><i>versionCleanup=</i></dt> |
|
116 <dd> |
|
117 tuple of two integers giving string positions |
|
118 start and stop for the version string (tuple of integers) |
|
119 </dd><dt><i>versionRe=</i></dt> |
|
120 <dd> |
|
121 regexp to determine the line identifying version |
|
122 info (string). Takes precedence over versionStartsWith. |
|
123 </dd> |
|
124 </dl><dl> |
|
125 <dt>Returns:</dt> |
|
126 <dd> |
|
127 version string of detected or given version (string) |
|
128 </dd> |
|
129 </dl><a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a> |
|
130 <h4>ProgramsDialog.on_buttonBox_clicked</h4> |
|
131 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
132 <p> |
|
133 Private slot called by a button of the button box clicked. |
|
134 </p><dl> |
|
135 <dt><i>button</i></dt> |
|
136 <dd> |
|
137 button that was clicked (QAbstractButton) |
|
138 </dd> |
|
139 </dl><a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a> |
|
140 <h4>ProgramsDialog.on_programsSearchButton_clicked</h4> |
|
141 <b>on_programsSearchButton_clicked</b>(<i></i>) |
|
142 <p> |
|
143 Private slot to search for all supported/required programs. |
|
144 </p><a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a> |
|
145 <h4>ProgramsDialog.show</h4> |
|
146 <b>show</b>(<i></i>) |
|
147 <p> |
|
148 Public slot to show the dialog. |
|
149 </p> |
|
150 <div align="right"><a href="#top">Up</a></div> |
|
151 <hr /> |
|
152 </body></html> |