eric6/Documentation/Source/eric6.PipInterface.PipFileSelectionDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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.PipInterface.PipFileSelectionDialog</h1> 23 <h1>eric6.PipInterface.PipFileSelectionDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to enter a file to be processed. 26 Module implementing a dialog to enter a file to be processed.
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="#PipFileSelectionDialog">PipFileSelectionDialog</a></td> 38 <td><a href="#PipFileSelectionDialog">PipFileSelectionDialog</a></td>
34 <td>Class implementing a dialog to enter a file to be processed.</td> 39 <td>Class implementing a dialog to enter a file to be processed.</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="PipFileSelectionDialog" ID="PipFileSelectionDialog"></a> 49 <a NAME="PipFileSelectionDialog" ID="PipFileSelectionDialog"></a>
43 <h2>PipFileSelectionDialog</h2> 50 <h2>PipFileSelectionDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to enter a file to be processed. 53 Class implementing a dialog to enter a file to be processed.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_PipFileSelectionDialog 56 QDialog, Ui_PipFileSelectionDialog
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="#PipFileSelectionDialog.__init__">PipFileSelectionDialog</a></td> 72 <td><a href="#PipFileSelectionDialog.__init__">PipFileSelectionDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#PipFileSelectionDialog.getData">getData</a></td> 76 <td><a href="#PipFileSelectionDialog.getData">getData</a></td>
64 <td>Public method to get the entered data.</td> 77 <td>Public method to get the entered data.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#PipFileSelectionDialog.on_filePicker_textChanged">on_filePicker_textChanged</a></td> 80 <td><a href="#PipFileSelectionDialog.on_filePicker_textChanged">on_filePicker_textChanged</a></td>
67 <td>Private slot to handle entering the name of a file.</td> 81 <td>Private slot to handle entering the name of a file.</td>
68 </tr> 82 </tr>
69 </table> 83 </table>
70 <h3>Static Methods</h3> 84 <h3>Static Methods</h3>
85
71 <table> 86 <table>
72 <tr><td>None</td></tr> 87 <tr><td>None</td></tr>
73 </table> 88 </table>
89
74 <a NAME="PipFileSelectionDialog.__init__" ID="PipFileSelectionDialog.__init__"></a> 90 <a NAME="PipFileSelectionDialog.__init__" ID="PipFileSelectionDialog.__init__"></a>
75 <h4>PipFileSelectionDialog (Constructor)</h4> 91 <h4>PipFileSelectionDialog (Constructor)</h4>
76 <b>PipFileSelectionDialog</b>(<i>pip, mode, install=True, parent=None</i>) 92 <b>PipFileSelectionDialog</b>(<i>pip, mode, install=True, parent=None</i>)
93
77 <p> 94 <p>
78 Constructor 95 Constructor
79 </p><dl> 96 </p>
97 <dl>
98
80 <dt><i>pip</i> (Pip)</dt> 99 <dt><i>pip</i> (Pip)</dt>
81 <dd> 100 <dd>
82 reference to the pip object 101 reference to the pip object
83 </dd><dt><i>mode</i> (str)</dt> 102 </dd>
103 <dt><i>mode</i> (str)</dt>
84 <dd> 104 <dd>
85 mode of the dialog 105 mode of the dialog
86 </dd><dt><i>install</i> (bool)</dt> 106 </dd>
107 <dt><i>install</i> (bool)</dt>
87 <dd> 108 <dd>
88 flag indicating an install action 109 flag indicating an install action
89 </dd><dt><i>parent</i> (QWidget)</dt> 110 </dd>
111 <dt><i>parent</i> (QWidget)</dt>
90 <dd> 112 <dd>
91 reference to the parent widget 113 reference to the parent widget
92 </dd> 114 </dd>
93 </dl><a NAME="PipFileSelectionDialog.getData" ID="PipFileSelectionDialog.getData"></a> 115 </dl>
116 <a NAME="PipFileSelectionDialog.getData" ID="PipFileSelectionDialog.getData"></a>
94 <h4>PipFileSelectionDialog.getData</h4> 117 <h4>PipFileSelectionDialog.getData</h4>
95 <b>getData</b>(<i></i>) 118 <b>getData</b>(<i></i>)
119
96 <p> 120 <p>
97 Public method to get the entered data. 121 Public method to get the entered data.
98 </p><dl> 122 </p>
123 <dl>
99 <dt>Returns:</dt> 124 <dt>Returns:</dt>
100 <dd> 125 <dd>
101 tuple with the name of the selected file and a flag indicating 126 tuple with the name of the selected file and a flag indicating
102 to install to the user install directory 127 to install to the user install directory
103 </dd> 128 </dd>
104 </dl><dl> 129 </dl>
130 <dl>
105 <dt>Return Type:</dt> 131 <dt>Return Type:</dt>
106 <dd> 132 <dd>
107 tuple of (str, bool) 133 tuple of (str, bool)
108 </dd> 134 </dd>
109 </dl><a NAME="PipFileSelectionDialog.on_filePicker_textChanged" ID="PipFileSelectionDialog.on_filePicker_textChanged"></a> 135 </dl>
136 <a NAME="PipFileSelectionDialog.on_filePicker_textChanged" ID="PipFileSelectionDialog.on_filePicker_textChanged"></a>
110 <h4>PipFileSelectionDialog.on_filePicker_textChanged</h4> 137 <h4>PipFileSelectionDialog.on_filePicker_textChanged</h4>
111 <b>on_filePicker_textChanged</b>(<i>txt</i>) 138 <b>on_filePicker_textChanged</b>(<i>txt</i>)
139
112 <p> 140 <p>
113 Private slot to handle entering the name of a file. 141 Private slot to handle entering the name of a file.
114 </p><dl> 142 </p>
143 <dl>
144
115 <dt><i>txt</i> (str)</dt> 145 <dt><i>txt</i> (str)</dt>
116 <dd> 146 <dd>
117 name of the file 147 name of the file
118 </dd> 148 </dd>
119 </dl> 149 </dl>

eric ide

mercurial