src/eric7/Documentation/Source/eric7.UI.FindFileFilterPropertiesDialog.html

branch
eric7
changeset 10493
f795d68d8e09
equal deleted inserted replaced
10492:53eac4c7d10b 10493:f795d68d8e09
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.UI.FindFileFilterPropertiesDialog</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.UI.FindFileFilterPropertiesDialog</h1>
10 <p>
11 Module implementing a dialog to enter the file filter properties.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#FindFileFilterPropertiesDialog">FindFileFilterPropertiesDialog</a></td>
23 <td>Class implementing a dialog to enter the file filter properties.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="FindFileFilterPropertiesDialog" ID="FindFileFilterPropertiesDialog"></a>
35 <h2>FindFileFilterPropertiesDialog</h2>
36 <p>
37 Class implementing a dialog to enter the file filter properties.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_FindFileFilterPropertiesDialog
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46
47 <h3>Class Methods</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51
52 <h3>Methods</h3>
53 <table>
54 <tr>
55 <td><a href="#FindFileFilterPropertiesDialog.__init__">FindFileFilterPropertiesDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#FindFileFilterPropertiesDialog.__updateOKAndError">__updateOKAndError</a></td>
60 <td>Private slot to set the enabled state of the OK button.</td>
61 </tr>
62 <tr>
63 <td><a href="#FindFileFilterPropertiesDialog.getProperties">getProperties</a></td>
64 <td>Public method to retrieve the entered filter properties.</td>
65 </tr>
66 </table>
67
68 <h3>Static Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72
73
74 <a NAME="FindFileFilterPropertiesDialog.__init__" ID="FindFileFilterPropertiesDialog.__init__"></a>
75 <h4>FindFileFilterPropertiesDialog (Constructor)</h4>
76 <b>FindFileFilterPropertiesDialog</b>(<i>currentFilters, properties=None, parent=None</i>)
77 <p>
78 Constructor
79 </p>
80
81 <dl>
82
83 <dt><i>currentFilters</i> (list of str)</dt>
84 <dd>
85 list of existing filters to check against
86 </dd>
87 <dt><i>properties</i> (tuple of (str, str) (optional))</dt>
88 <dd>
89 tuple containing the filter name and pattern
90 to be edited (defaults to None)
91 </dd>
92 <dt><i>parent</i> (QWidget (optional))</dt>
93 <dd>
94 reference to the parent widget (defaults to None)
95 </dd>
96 </dl>
97 <a NAME="FindFileFilterPropertiesDialog.__updateOKAndError" ID="FindFileFilterPropertiesDialog.__updateOKAndError"></a>
98 <h4>FindFileFilterPropertiesDialog.__updateOKAndError</h4>
99 <b>__updateOKAndError</b>(<i></i>)
100 <p>
101 Private slot to set the enabled state of the OK button.
102 </p>
103
104 <a NAME="FindFileFilterPropertiesDialog.getProperties" ID="FindFileFilterPropertiesDialog.getProperties"></a>
105 <h4>FindFileFilterPropertiesDialog.getProperties</h4>
106 <b>getProperties</b>(<i></i>)
107 <p>
108 Public method to retrieve the entered filter properties.
109 </p>
110
111 <dl>
112 <dt>Return:</dt>
113 <dd>
114 tuple cotaining the filter name and pattern
115 </dd>
116 </dl>
117 <dl>
118 <dt>Return Type:</dt>
119 <dd>
120 tuple of (str, str)
121 </dd>
122 </dl>
123 <div align="right"><a href="#top">Up</a></div>
124 <hr />
125 </body></html>

eric ide

mercurial