Documentation/Source/eric5.Preferences.ProgramsDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Preferences.ProgramsDialog</h1> 23 <h1>eric5.Preferences.ProgramsDialog</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;. 25 Module implementing the Programs page.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#ProgramsDialog">ProgramsDialog</a></td> 34 <td><a href="#ProgramsDialog">ProgramsDialog</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;.</td> 35 <td>Class implementing the Programs page.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="ProgramsDialog" ID="ProgramsDialog"></a> 43 <a NAME="ProgramsDialog" ID="ProgramsDialog"></a>
44 <h2>ProgramsDialog</h2> 44 <h2>ProgramsDialog</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;. 46 Class implementing the Programs page.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QDialog, Ui_ProgramsDialog 49 QDialog, Ui_ProgramsDialog
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td> 57 <td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td> 60 <td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td>
61 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y.</td> 61 <td>Private method to generate a program entry.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td> 63 <td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td>
64 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y.</td> 64 <td>Private method to generate a program entry.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#ProgramsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 66 <td><a href="#ProgramsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
67 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.</td> 67 <td>Private slot called by a button of the button box clicked.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td> 69 <td><a href="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td>
70 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#97;&#114;&#99;&#104; &#102;&#111;&#114; &#97;&#108;&#108; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;/&#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#112;&#114;&#111;&#103;&#114;&#97;&#109;&#115;.</td> 70 <td>Private slot to search for all supported/required programs.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#ProgramsDialog.show">show</a></td> 72 <td><a href="#ProgramsDialog.show">show</a></td>
73 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.</td> 73 <td>Public slot to show the dialog.</td>
74 </tr> 74 </tr>
75 </table> 75 </table>
76 <a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a> 76 <a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a>
77 <h4>ProgramsDialog (Constructor)</h4> 77 <h4>ProgramsDialog (Constructor)</h4>
78 <b>ProgramsDialog</b>(<i>parent = None</i>) 78 <b>ProgramsDialog</b>(<i>parent = None</i>)
79 <p> 79 <p>
80 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 80 Constructor
81 </p><dl> 81 </p><dl>
82 <dt><i>parent</i></dt> 82 <dt><i>parent</i></dt>
83 <dd> 83 <dd>
84 &#84;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103;. (&#81;&#87;&#105;&#100;&#103;&#101;&#116;) 84 The parent widget of this dialog. (QWidget)
85 </dd> 85 </dd>
86 </dl><a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a> 86 </dl><a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a>
87 <h4>ProgramsDialog.__createEntry</h4> 87 <h4>ProgramsDialog.__createEntry</h4>
88 <b>__createEntry</b>(<i>description, entryText, entryVersion</i>) 88 <b>__createEntry</b>(<i>description, entryText, entryVersion</i>)
89 <p> 89 <p>
90 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y. 90 Private method to generate a program entry.
91 </p><dl> 91 </p><dl>
92 <dt><i>description</i></dt> 92 <dt><i>description</i></dt>
93 <dd> 93 <dd>
94 &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;v&#101; &#116;&#101;x&#116; (&#115;&#116;&#114;&#105;&#110;&#103;) 94 descriptive text (string)
95 </dd><dt><i>entryText</i></dt> 95 </dd><dt><i>entryText</i></dt>
96 <dd> 96 <dd>
97 &#116;&#101;x&#116; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;) 97 text to show (string)
98 </dd><dt><i>entryVersion</i></dt> 98 </dd><dt><i>entryVersion</i></dt>
99 <dd> 99 <dd>
100 v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;). 100 version string to show (string).
101 </dd> 101 </dd>
102 </dl><a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a> 102 </dl><a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a>
103 <h4>ProgramsDialog.__createProgramEntry</h4> 103 <h4>ProgramsDialog.__createProgramEntry</h4>
104 <b>__createProgramEntry</b>(<i>description, exe, versionCommand = "", versionStartsWith = "", versionPosition = 0, version = "", versionCleanup = None, versionRe = None</i>) 104 <b>__createProgramEntry</b>(<i>description, exe, versionCommand = "", versionStartsWith = "", versionPosition = 0, version = "", versionCleanup = None, versionRe = None</i>)
105 <p> 105 <p>
106 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y. 106 Private method to generate a program entry.
107 </p><dl> 107 </p><dl>
108 <dt><i>description</i></dt> 108 <dt><i>description</i></dt>
109 <dd> 109 <dd>
110 &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;v&#101; &#116;&#101;x&#116; (&#115;&#116;&#114;&#105;&#110;&#103;) 110 descriptive text (string)
111 </dd><dt><i>exe</i></dt> 111 </dd><dt><i>exe</i></dt>
112 <dd> 112 <dd>
113 &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#112;&#114;&#111;&#103;&#114;&#97;&#109; (&#115;&#116;&#114;&#105;&#110;&#103;) 113 name of the executable program (string)
114 </dd><dt><i>versionCommand</i></dt> 114 </dd><dt><i>versionCommand</i></dt>
115 <dd> 115 <dd>
116 &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#108;&#105;&#110;&#101; &#115;w&#105;&#116;&#99;&#104; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;) 116 command line switch to get the version info (string)
117 &#105;&#102; &#116;&#104;&#105;&#115; &#105;&#115; &#101;&#109;&#112;&#116;y, &#116;&#104;&#101; &#103;&#105;v&#101;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; w&#105;&#108;&#108; &#98;&#101; &#115;&#104;&#111;w&#110;. 117 if this is empty, the given version will be shown.
118 </dd><dt><i>versionStartsWith</i></dt> 118 </dd><dt><i>versionStartsWith</i></dt>
119 <dd> 119 <dd>
120 &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#108;&#105;&#110;&#101; &#105;&#100;&#101;&#110;&#116;&#105;&#102;y&#105;&#110;&#103; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;) 120 start of line identifying version info (string)
121 </dd><dt><i>versionPosition</i></dt> 121 </dd><dt><i>versionPosition</i></dt>
122 <dd> 122 <dd>
123 &#105;&#110;&#100;&#101;x &#111;&#102; &#112;&#97;&#114;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) 123 index of part containing the version info (integer)
124 </dd><dt><i>version=</i></dt> 124 </dd><dt><i>version=</i></dt>
125 <dd> 125 <dd>
126 v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;) 126 version string to show (string)
127 </dd><dt><i>versionCleanup=</i></dt> 127 </dd><dt><i>versionCleanup=</i></dt>
128 <dd> 128 <dd>
129 &#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;w&#111; &#105;&#110;&#116;&#101;&#103;&#101;&#114;&#115; &#103;&#105;v&#105;&#110;&#103; &#115;&#116;&#114;&#105;&#110;&#103; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;&#115; 129 tuple of two integers giving string positions
130 &#115;&#116;&#97;&#114;&#116; &#97;&#110;&#100; &#115;&#116;&#111;&#112; &#102;&#111;&#114; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; (&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#105;&#110;&#116;&#101;&#103;&#101;&#114;&#115;) 130 start and stop for the version string (tuple of integers)
131 </dd><dt><i>versionRe=</i></dt> 131 </dd><dt><i>versionRe=</i></dt>
132 <dd> 132 <dd>
133 &#114;&#101;&#103;&#101;x&#112; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101; &#116;&#104;&#101; &#108;&#105;&#110;&#101; &#105;&#100;&#101;&#110;&#116;&#105;&#102;y&#105;&#110;&#103; v&#101;&#114;&#115;&#105;&#111;&#110; 133 regexp to determine the line identifying version
134 &#105;&#110;&#102;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;). &#84;&#97;&#107;&#101;&#115; &#112;&#114;&#101;&#99;&#101;&#100;&#101;&#110;&#99;&#101; &#111;v&#101;&#114; v&#101;&#114;&#115;&#105;&#111;&#110;&#83;&#116;&#97;&#114;&#116;&#115;&#87;&#105;&#116;&#104;. 134 info (string). Takes precedence over versionStartsWith.
135 </dd> 135 </dd>
136 </dl><dl> 136 </dl><dl>
137 <dt>Returns:</dt> 137 <dt>Returns:</dt>
138 <dd> 138 <dd>
139 v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; &#111;&#102; &#100;&#101;&#116;&#101;&#99;&#116;&#101;&#100; &#111;&#114; &#103;&#105;v&#101;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 139 version string of detected or given version (string)
140 </dd> 140 </dd>
141 </dl><a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a> 141 </dl><a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a>
142 <h4>ProgramsDialog.on_buttonBox_clicked</h4> 142 <h4>ProgramsDialog.on_buttonBox_clicked</h4>
143 <b>on_buttonBox_clicked</b>(<i>button</i>) 143 <b>on_buttonBox_clicked</b>(<i>button</i>)
144 <p> 144 <p>
145 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;. 145 Private slot called by a button of the button box clicked.
146 </p><dl> 146 </p><dl>
147 <dt><i>button</i></dt> 147 <dt><i>button</i></dt>
148 <dd> 148 <dd>
149 &#98;&#117;&#116;&#116;&#111;&#110; &#116;&#104;&#97;&#116; w&#97;&#115; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#65;&#98;&#115;&#116;&#114;&#97;&#99;&#116;&#66;&#117;&#116;&#116;&#111;&#110;) 149 button that was clicked (QAbstractButton)
150 </dd> 150 </dd>
151 </dl><a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a> 151 </dl><a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a>
152 <h4>ProgramsDialog.on_programsSearchButton_clicked</h4> 152 <h4>ProgramsDialog.on_programsSearchButton_clicked</h4>
153 <b>on_programsSearchButton_clicked</b>(<i></i>) 153 <b>on_programsSearchButton_clicked</b>(<i></i>)
154 <p> 154 <p>
155 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#97;&#114;&#99;&#104; &#102;&#111;&#114; &#97;&#108;&#108; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;/&#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#112;&#114;&#111;&#103;&#114;&#97;&#109;&#115;. 155 Private slot to search for all supported/required programs.
156 </p><a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a> 156 </p><a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a>
157 <h4>ProgramsDialog.show</h4> 157 <h4>ProgramsDialog.show</h4>
158 <b>show</b>(<i></i>) 158 <b>show</b>(<i></i>)
159 <p> 159 <p>
160 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;. 160 Public slot to show the dialog.
161 </p> 161 </p>
162 <div align="right"><a href="#top">Up</a></div> 162 <div align="right"><a href="#top">Up</a></div>
163 <hr /> 163 <hr />
164 </body></html> 164 </body></html>

eric ide

mercurial