src/eric7/Documentation/Source/eric7.ViewManager.BookmarkedFilesDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10436
f6881d10e995
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.ViewManager.BookmarkedFilesDialog</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.ViewManager.BookmarkedFilesDialog</h1>
10
11 <p>
12 Module implementing a configuration dialog for the bookmarked files menu.
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="#BookmarkedFilesDialog">BookmarkedFilesDialog</a></td>
25 <td>Class implementing a configuration dialog for the bookmarked files menu.</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="BookmarkedFilesDialog" ID="BookmarkedFilesDialog"></a>
36 <h2>BookmarkedFilesDialog</h2>
37
38 <p>
39 Class implementing a configuration dialog for the bookmarked files menu.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_BookmarkedFilesDialog
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="#BookmarkedFilesDialog.__init__">BookmarkedFilesDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#BookmarkedFilesDialog.__swap">__swap</a></td>
63 <td>Private method used two swap two list entries given by their index.</td>
64 </tr>
65 <tr>
66 <td><a href="#BookmarkedFilesDialog.getBookmarkedFiles">getBookmarkedFiles</a></td>
67 <td>Public method to retrieve the tools list.</td>
68 </tr>
69 <tr>
70 <td><a href="#BookmarkedFilesDialog.on_addButton_clicked">on_addButton_clicked</a></td>
71 <td>Private slot to add a new entry.</td>
72 </tr>
73 <tr>
74 <td><a href="#BookmarkedFilesDialog.on_changeButton_clicked">on_changeButton_clicked</a></td>
75 <td>Private slot to change an entry.</td>
76 </tr>
77 <tr>
78 <td><a href="#BookmarkedFilesDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
79 <td>Private slot to delete the selected entry.</td>
80 </tr>
81 <tr>
82 <td><a href="#BookmarkedFilesDialog.on_downButton_clicked">on_downButton_clicked</a></td>
83 <td>Private slot to move an entry down in the list.</td>
84 </tr>
85 <tr>
86 <td><a href="#BookmarkedFilesDialog.on_filePicker_textChanged">on_filePicker_textChanged</a></td>
87 <td>Private slot to handle the textChanged signal of the file edit.</td>
88 </tr>
89 <tr>
90 <td><a href="#BookmarkedFilesDialog.on_filesList_currentRowChanged">on_filesList_currentRowChanged</a></td>
91 <td>Private slot to set the lineedit depending on the selected entry.</td>
92 </tr>
93 <tr>
94 <td><a href="#BookmarkedFilesDialog.on_upButton_clicked">on_upButton_clicked</a></td>
95 <td>Private slot to move an entry up in the list.</td>
96 </tr>
97 </table>
98 <h3>Static Methods</h3>
99
100 <table>
101 <tr><td>None</td></tr>
102 </table>
103
104 <a NAME="BookmarkedFilesDialog.__init__" ID="BookmarkedFilesDialog.__init__"></a>
105 <h4>BookmarkedFilesDialog (Constructor)</h4>
106 <b>BookmarkedFilesDialog</b>(<i>bookmarks, parent=None</i>)
107
108 <p>
109 Constructor
110 </p>
111 <dl>
112
113 <dt><i>bookmarks</i></dt>
114 <dd>
115 list of bookmarked files (list of strings)
116 </dd>
117 <dt><i>parent</i></dt>
118 <dd>
119 parent widget (QWidget)
120 </dd>
121 </dl>
122 <a NAME="BookmarkedFilesDialog.__swap" ID="BookmarkedFilesDialog.__swap"></a>
123 <h4>BookmarkedFilesDialog.__swap</h4>
124 <b>__swap</b>(<i>itm1, itm2</i>)
125
126 <p>
127 Private method used two swap two list entries given by their index.
128 </p>
129 <dl>
130
131 <dt><i>itm1</i></dt>
132 <dd>
133 index of first entry (int)
134 </dd>
135 <dt><i>itm2</i></dt>
136 <dd>
137 index of second entry (int)
138 </dd>
139 </dl>
140 <a NAME="BookmarkedFilesDialog.getBookmarkedFiles" ID="BookmarkedFilesDialog.getBookmarkedFiles"></a>
141 <h4>BookmarkedFilesDialog.getBookmarkedFiles</h4>
142 <b>getBookmarkedFiles</b>(<i></i>)
143
144 <p>
145 Public method to retrieve the tools list.
146 </p>
147 <dl>
148 <dt>Return:</dt>
149 <dd>
150 a list of filenames (list of strings)
151 </dd>
152 </dl>
153 <a NAME="BookmarkedFilesDialog.on_addButton_clicked" ID="BookmarkedFilesDialog.on_addButton_clicked"></a>
154 <h4>BookmarkedFilesDialog.on_addButton_clicked</h4>
155 <b>on_addButton_clicked</b>(<i></i>)
156
157 <p>
158 Private slot to add a new entry.
159 </p>
160 <a NAME="BookmarkedFilesDialog.on_changeButton_clicked" ID="BookmarkedFilesDialog.on_changeButton_clicked"></a>
161 <h4>BookmarkedFilesDialog.on_changeButton_clicked</h4>
162 <b>on_changeButton_clicked</b>(<i></i>)
163
164 <p>
165 Private slot to change an entry.
166 </p>
167 <a NAME="BookmarkedFilesDialog.on_deleteButton_clicked" ID="BookmarkedFilesDialog.on_deleteButton_clicked"></a>
168 <h4>BookmarkedFilesDialog.on_deleteButton_clicked</h4>
169 <b>on_deleteButton_clicked</b>(<i></i>)
170
171 <p>
172 Private slot to delete the selected entry.
173 </p>
174 <a NAME="BookmarkedFilesDialog.on_downButton_clicked" ID="BookmarkedFilesDialog.on_downButton_clicked"></a>
175 <h4>BookmarkedFilesDialog.on_downButton_clicked</h4>
176 <b>on_downButton_clicked</b>(<i></i>)
177
178 <p>
179 Private slot to move an entry down in the list.
180 </p>
181 <a NAME="BookmarkedFilesDialog.on_filePicker_textChanged" ID="BookmarkedFilesDialog.on_filePicker_textChanged"></a>
182 <h4>BookmarkedFilesDialog.on_filePicker_textChanged</h4>
183 <b>on_filePicker_textChanged</b>(<i>txt</i>)
184
185 <p>
186 Private slot to handle the textChanged signal of the file edit.
187 </p>
188 <dl>
189
190 <dt><i>txt</i></dt>
191 <dd>
192 the text of the file edit (string)
193 </dd>
194 </dl>
195 <a NAME="BookmarkedFilesDialog.on_filesList_currentRowChanged" ID="BookmarkedFilesDialog.on_filesList_currentRowChanged"></a>
196 <h4>BookmarkedFilesDialog.on_filesList_currentRowChanged</h4>
197 <b>on_filesList_currentRowChanged</b>(<i>row</i>)
198
199 <p>
200 Private slot to set the lineedit depending on the selected entry.
201 </p>
202 <dl>
203
204 <dt><i>row</i></dt>
205 <dd>
206 the current row (integer)
207 </dd>
208 </dl>
209 <a NAME="BookmarkedFilesDialog.on_upButton_clicked" ID="BookmarkedFilesDialog.on_upButton_clicked"></a>
210 <h4>BookmarkedFilesDialog.on_upButton_clicked</h4>
211 <b>on_upButton_clicked</b>(<i></i>)
212
213 <p>
214 Private slot to move an entry up in the list.
215 </p>
216 <div align="right"><a href="#top">Up</a></div>
217 <hr />
218 </body></html>

eric ide

mercurial