diff -r c9982bcd00f8 -r c7951eb9d525 Documentation/Source/eric6.E5Gui.E5PathPicker.html --- a/Documentation/Source/eric6.E5Gui.E5PathPicker.html Sun Dec 06 19:09:32 2015 +0100 +++ b/Documentation/Source/eric6.E5Gui.E5PathPicker.html Sat Dec 12 12:38:50 2015 +0100 @@ -36,6 +36,9 @@ <td><a href="#E5PathPicker">E5PathPicker</a></td> <td>Class implementing a path picker widget consisting of a line edit and a tool button to open a file dialog.</td> </tr><tr> +<td><a href="#E5PathPickerBase">E5PathPickerBase</a></td> +<td>Class implementing the base of a path picker widget consisting of a line edit or combo box and a tool button to open a file dialog.</td> +</tr><tr> <td><a href="#E5PathPickerModes">E5PathPickerModes</a></td> <td>Class implementing the path picker modes.</td> </tr> @@ -69,10 +72,10 @@ </dd> </dl> <h3>Derived from</h3> -QWidget +E5PathPickerBase <h3>Class Attributes</h3> <table> -<tr><td>DefaultMode</td></tr> +<tr><td>None</td></tr> </table> <h3>Class Methods</h3> <table> @@ -83,102 +86,6 @@ <tr> <td><a href="#E5ComboPathPicker.__init__">E5ComboPathPicker</a></td> <td>Constructor</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.__showPathPickerDialog">__showPathPickerDialog</a></td> -<td>Private slot to show the path picker dialog.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.addItem">addItem</a></td> -<td>Public method to add a paths to the current list.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.addItems">addItems</a></td> -<td>Public method to add paths to the current list.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.buttonToolTip">buttonToolTip</a></td> -<td>Public method to get the tool button tool tip.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.clear">clear</a></td> -<td>Public method to clear the list of paths.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.clearEditText">clearEditText</a></td> -<td>Public method to clear the current path.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.currentText">currentText</a></td> -<td>Public method to get the current path.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.defaultDirectory">defaultDirectory</a></td> -<td>Public method to get the default directory.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.editorEnabled">editorEnabled</a></td> -<td>Public method to get the path editor's enabled state.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.editorToolTip">editorToolTip</a></td> -<td>Public method to get the editor tool tip.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.filters">filters</a></td> -<td>Public methods to get the filter string.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.firstPath">firstPath</a></td> -<td>Public method to get the first path of a list of entered paths.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.isPickerEnabled">isPickerEnabled</a></td> -<td>Public method to get the file dialog button enabled state.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.lastPath">lastPath</a></td> -<td>Public method to get the last path of a list of entered paths.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.mode">mode</a></td> -<td>Public method to get the path picker mode.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.path">path</a></td> -<td>Public method to get the current path.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.paths">paths</a></td> -<td>Public method to get the list of entered paths.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setButtonToolTip">setButtonToolTip</a></td> -<td>Public method to set the tool button tool tip.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setCurrentIndex">setCurrentIndex</a></td> -<td>Public slot to set the current index.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setDefaultDirectory">setDefaultDirectory</a></td> -<td>Public method to set the default directory.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setEditText">setEditText</a></td> -<td>Public method to set the current path.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setEditorEnabled">setEditorEnabled</a></td> -<td>Public method to set the path editor's enabled state.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setEditorToolTip">setEditorToolTip</a></td> -<td>Public method to set the editor tool tip.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setFilters">setFilters</a></td> -<td>Public method to set the filters for the path picker dialog.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setInsertPolicy">setInsertPolicy</a></td> -<td>Public method to set the insertion policy of the combo box.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setMode">setMode</a></td> -<td>Public method to set the path picker mode.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setPath">setPath</a></td> -<td>Public method to set the current path.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setPathsList">setPathsList</a></td> -<td>Public method to set the paths list.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setPickerEnabled">setPickerEnabled</a></td> -<td>Public method to set the enabled state of the file dialog button.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setSizeAdjustPolicy">setSizeAdjustPolicy</a></td> -<td>Public method to set the size adjust policy of the combo box.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.setWindowTitle">setWindowTitle</a></td> -<td>Public method to set the path picker dialog window title.</td> -</tr><tr> -<td><a href="#E5ComboPathPicker.windowTitle">windowTitle</a></td> -<td>Public method to get the path picker dialog's window title.</td> </tr> </table> <h3>Static Methods</h3> @@ -195,378 +102,6 @@ <dd> reference to the parent widget </dd> -</dl><a NAME="E5ComboPathPicker.__showPathPickerDialog" ID="E5ComboPathPicker.__showPathPickerDialog"></a> -<h4>E5ComboPathPicker.__showPathPickerDialog</h4> -<b>__showPathPickerDialog</b>(<i></i>) -<p> - Private slot to show the path picker dialog. -</p><a NAME="E5ComboPathPicker.addItem" ID="E5ComboPathPicker.addItem"></a> -<h4>E5ComboPathPicker.addItem</h4> -<b>addItem</b>(<i>path</i>) -<p> - Public method to add a paths to the current list. -</p><dl> -<dt><i>path</i> (str)</dt> -<dd> -path to add -</dd> -</dl><a NAME="E5ComboPathPicker.addItems" ID="E5ComboPathPicker.addItems"></a> -<h4>E5ComboPathPicker.addItems</h4> -<b>addItems</b>(<i>pathsList</i>) -<p> - Public method to add paths to the current list. -</p><dl> -<dt><i>pathsList</i> (list of str)</dt> -<dd> -list of paths to add -</dd> -</dl><a NAME="E5ComboPathPicker.buttonToolTip" ID="E5ComboPathPicker.buttonToolTip"></a> -<h4>E5ComboPathPicker.buttonToolTip</h4> -<b>buttonToolTip</b>(<i></i>) -<p> - Public method to get the tool button tool tip. -</p><dl> -<dt>Returns:</dt> -<dd> -tool tip text -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.clear" ID="E5ComboPathPicker.clear"></a> -<h4>E5ComboPathPicker.clear</h4> -<b>clear</b>(<i></i>) -<p> - Public method to clear the list of paths. -</p><a NAME="E5ComboPathPicker.clearEditText" ID="E5ComboPathPicker.clearEditText"></a> -<h4>E5ComboPathPicker.clearEditText</h4> -<b>clearEditText</b>(<i></i>) -<p> - Public method to clear the current path. -</p><a NAME="E5ComboPathPicker.currentText" ID="E5ComboPathPicker.currentText"></a> -<h4>E5ComboPathPicker.currentText</h4> -<b>currentText</b>(<i></i>) -<p> - Public method to get the current path. -</p><dl> -<dt>Returns:</dt> -<dd> -current path -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.defaultDirectory" ID="E5ComboPathPicker.defaultDirectory"></a> -<h4>E5ComboPathPicker.defaultDirectory</h4> -<b>defaultDirectory</b>(<i></i>) -<p> - Public method to get the default directory. -</p><dl> -<dt>Returns:</dt> -<dd> -default directory -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.editorEnabled" ID="E5ComboPathPicker.editorEnabled"></a> -<h4>E5ComboPathPicker.editorEnabled</h4> -<b>editorEnabled</b>(<i></i>) -<p> - Public method to get the path editor's enabled state. -</p><dl> -<dt>Returns:</dt> -<dd> -flag indicating the enabled state -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl><a NAME="E5ComboPathPicker.editorToolTip" ID="E5ComboPathPicker.editorToolTip"></a> -<h4>E5ComboPathPicker.editorToolTip</h4> -<b>editorToolTip</b>(<i></i>) -<p> - Public method to get the editor tool tip. -</p><dl> -<dt>Returns:</dt> -<dd> -tool tip text -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.filters" ID="E5ComboPathPicker.filters"></a> -<h4>E5ComboPathPicker.filters</h4> -<b>filters</b>(<i></i>) -<p> - Public methods to get the filter string. -</p><dl> -<dt>Returns:</dt> -<dd> -filter string -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.firstPath" ID="E5ComboPathPicker.firstPath"></a> -<h4>E5ComboPathPicker.firstPath</h4> -<b>firstPath</b>(<i></i>) -<p> - Public method to get the first path of a list of entered paths. -</p><dl> -<dt>Returns:</dt> -<dd> -first path -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.isPickerEnabled" ID="E5ComboPathPicker.isPickerEnabled"></a> -<h4>E5ComboPathPicker.isPickerEnabled</h4> -<b>isPickerEnabled</b>(<i></i>) -<p> - Public method to get the file dialog button enabled state. -</p><dl> -<dt>Returns:</dt> -<dd> -flag indicating the enabled state -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl><a NAME="E5ComboPathPicker.lastPath" ID="E5ComboPathPicker.lastPath"></a> -<h4>E5ComboPathPicker.lastPath</h4> -<b>lastPath</b>(<i></i>) -<p> - Public method to get the last path of a list of entered paths. -</p><dl> -<dt>Returns:</dt> -<dd> -first path -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.mode" ID="E5ComboPathPicker.mode"></a> -<h4>E5ComboPathPicker.mode</h4> -<b>mode</b>(<i></i>) -<p> - Public method to get the path picker mode. -</p><dl> -<dt>Returns:</dt> -<dd> -path picker mode -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -E5PathPickerModes -</dd> -</dl><a NAME="E5ComboPathPicker.path" ID="E5ComboPathPicker.path"></a> -<h4>E5ComboPathPicker.path</h4> -<b>path</b>(<i></i>) -<p> - Public method to get the current path. -</p><dl> -<dt>Returns:</dt> -<dd> -current path -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="E5ComboPathPicker.paths" ID="E5ComboPathPicker.paths"></a> -<h4>E5ComboPathPicker.paths</h4> -<b>paths</b>(<i></i>) -<p> - Public method to get the list of entered paths. -</p><dl> -<dt>Returns:</dt> -<dd> -entered paths -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -list of str -</dd> -</dl><a NAME="E5ComboPathPicker.setButtonToolTip" ID="E5ComboPathPicker.setButtonToolTip"></a> -<h4>E5ComboPathPicker.setButtonToolTip</h4> -<b>setButtonToolTip</b>(<i>tooltip</i>) -<p> - Public method to set the tool button tool tip. -</p><dl> -<dt><i>tooltip</i> (str)</dt> -<dd> -text to be set as a tool tip -</dd> -</dl><a NAME="E5ComboPathPicker.setCurrentIndex" ID="E5ComboPathPicker.setCurrentIndex"></a> -<h4>E5ComboPathPicker.setCurrentIndex</h4> -<b>setCurrentIndex</b>(<i>index</i>) -<p> - Public slot to set the current index. -</p><dl> -<dt><i>index</i> (int)</dt> -<dd> -index of the item to set current -</dd> -</dl><a NAME="E5ComboPathPicker.setDefaultDirectory" ID="E5ComboPathPicker.setDefaultDirectory"></a> -<h4>E5ComboPathPicker.setDefaultDirectory</h4> -<b>setDefaultDirectory</b>(<i>directory</i>) -<p> - Public method to set the default directory. -</p><dl> -<dt><i>directory</i> (str)</dt> -<dd> -default directory -</dd> -</dl><a NAME="E5ComboPathPicker.setEditText" ID="E5ComboPathPicker.setEditText"></a> -<h4>E5ComboPathPicker.setEditText</h4> -<b>setEditText</b>(<i>path</i>) -<p> - Public method to set the current path. -</p><dl> -<dt><i>path</i> (str)</dt> -<dd> -path to be set -</dd> -</dl><a NAME="E5ComboPathPicker.setEditorEnabled" ID="E5ComboPathPicker.setEditorEnabled"></a> -<h4>E5ComboPathPicker.setEditorEnabled</h4> -<b>setEditorEnabled</b>(<i>enable</i>) -<p> - Public method to set the path editor's enabled state. -</p><dl> -<dt><i>enable</i> (bool)</dt> -<dd> -flag indicating the enable state -</dd> -</dl><a NAME="E5ComboPathPicker.setEditorToolTip" ID="E5ComboPathPicker.setEditorToolTip"></a> -<h4>E5ComboPathPicker.setEditorToolTip</h4> -<b>setEditorToolTip</b>(<i>tooltip</i>) -<p> - Public method to set the editor tool tip. -</p><dl> -<dt><i>tooltip</i> (str)</dt> -<dd> -text to be set as a tool tip -</dd> -</dl><a NAME="E5ComboPathPicker.setFilters" ID="E5ComboPathPicker.setFilters"></a> -<h4>E5ComboPathPicker.setFilters</h4> -<b>setFilters</b>(<i>filters</i>) -<p> - Public method to set the filters for the path picker dialog. -</p><p> - Note: Multiple filters must be separated by ';;'. -</p><dl> -<dt><i>filters</i> (str)</dt> -<dd> -string containing the file filters -</dd> -</dl><a NAME="E5ComboPathPicker.setInsertPolicy" ID="E5ComboPathPicker.setInsertPolicy"></a> -<h4>E5ComboPathPicker.setInsertPolicy</h4> -<b>setInsertPolicy</b>(<i>policy</i>) -<p> - Public method to set the insertion policy of the combo box. -</p><dl> -<dt><i>policy</i> (QComboBox.InsertPolicy)</dt> -<dd> -insertion policy -</dd> -</dl><a NAME="E5ComboPathPicker.setMode" ID="E5ComboPathPicker.setMode"></a> -<h4>E5ComboPathPicker.setMode</h4> -<b>setMode</b>(<i>mode</i>) -<p> - Public method to set the path picker mode. -</p><dl> -<dt><i>mode</i> (E5PathPickerModes)</dt> -<dd> -picker mode -</dd> -</dl><a NAME="E5ComboPathPicker.setPath" ID="E5ComboPathPicker.setPath"></a> -<h4>E5ComboPathPicker.setPath</h4> -<b>setPath</b>(<i>path</i>) -<p> - Public method to set the current path. -</p><dl> -<dt><i>path</i> (str)</dt> -<dd> -path to be set -</dd> -</dl><a NAME="E5ComboPathPicker.setPathsList" ID="E5ComboPathPicker.setPathsList"></a> -<h4>E5ComboPathPicker.setPathsList</h4> -<b>setPathsList</b>(<i>pathsList</i>) -<p> - Public method to set the paths list. -</p><dl> -<dt><i>pathsList</i> (list of str)</dt> -<dd> -list of paths -</dd> -</dl><a NAME="E5ComboPathPicker.setPickerEnabled" ID="E5ComboPathPicker.setPickerEnabled"></a> -<h4>E5ComboPathPicker.setPickerEnabled</h4> -<b>setPickerEnabled</b>(<i>enable</i>) -<p> - Public method to set the enabled state of the file dialog button. -</p><dl> -<dt><i>enable</i> (bool)</dt> -<dd> -flag indicating the enabled state -</dd> -</dl><a NAME="E5ComboPathPicker.setSizeAdjustPolicy" ID="E5ComboPathPicker.setSizeAdjustPolicy"></a> -<h4>E5ComboPathPicker.setSizeAdjustPolicy</h4> -<b>setSizeAdjustPolicy</b>(<i>policy</i>) -<p> - Public method to set the size adjust policy of the combo box. -</p><dl> -<dt><i>policy</i> (QComboBox.SizeAdjustPolicy)</dt> -<dd> -size adjust policy -</dd> -</dl><a NAME="E5ComboPathPicker.setWindowTitle" ID="E5ComboPathPicker.setWindowTitle"></a> -<h4>E5ComboPathPicker.setWindowTitle</h4> -<b>setWindowTitle</b>(<i>title</i>) -<p> - Public method to set the path picker dialog window title. -</p><dl> -<dt><i>title</i> (str)</dt> -<dd> -window title -</dd> -</dl><a NAME="E5ComboPathPicker.windowTitle" ID="E5ComboPathPicker.windowTitle"></a> -<h4>E5ComboPathPicker.windowTitle</h4> -<b>windowTitle</b>(<i></i>) -<p> - Public method to get the path picker dialog's window title. -</p><dl> -<dt>Returns:</dt> -<dd> -window title -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -594,10 +129,10 @@ </dd> </dl> <h3>Derived from</h3> -QWidget +E5PathPickerBase <h3>Class Attributes</h3> <table> -<tr><td>DefaultMode</td></tr> +<tr><td>None</td></tr> </table> <h3>Class Methods</h3> <table> @@ -608,87 +143,6 @@ <tr> <td><a href="#E5PathPicker.__init__">E5PathPicker</a></td> <td>Constructor</td> -</tr><tr> -<td><a href="#E5PathPicker.__pathEdited">__pathEdited</a></td> -<td>Private slot handling editing of the path.</td> -</tr><tr> -<td><a href="#E5PathPicker.__showPathPickerDialog">__showPathPickerDialog</a></td> -<td>Private slot to show the path picker dialog.</td> -</tr><tr> -<td><a href="#E5PathPicker.buttonToolTip">buttonToolTip</a></td> -<td>Public method to get the tool button tool tip.</td> -</tr><tr> -<td><a href="#E5PathPicker.clear">clear</a></td> -<td>Public method to clear the current path.</td> -</tr><tr> -<td><a href="#E5PathPicker.defaultDirectory">defaultDirectory</a></td> -<td>Public method to get the default directory.</td> -</tr><tr> -<td><a href="#E5PathPicker.editorEnabled">editorEnabled</a></td> -<td>Public method to get the path editor's enabled state.</td> -</tr><tr> -<td><a href="#E5PathPicker.editorToolTip">editorToolTip</a></td> -<td>Public method to get the editor tool tip.</td> -</tr><tr> -<td><a href="#E5PathPicker.filters">filters</a></td> -<td>Public methods to get the filter string.</td> -</tr><tr> -<td><a href="#E5PathPicker.firstPath">firstPath</a></td> -<td>Public method to get the first path of a list of entered paths.</td> -</tr><tr> -<td><a href="#E5PathPicker.isPickerEnabled">isPickerEnabled</a></td> -<td>Public method to get the file dialog button enabled state.</td> -</tr><tr> -<td><a href="#E5PathPicker.lastPath">lastPath</a></td> -<td>Public method to get the last path of a list of entered paths.</td> -</tr><tr> -<td><a href="#E5PathPicker.mode">mode</a></td> -<td>Public method to get the path picker mode.</td> -</tr><tr> -<td><a href="#E5PathPicker.path">path</a></td> -<td>Public method to get the current path.</td> -</tr><tr> -<td><a href="#E5PathPicker.paths">paths</a></td> -<td>Public method to get the list of entered paths.</td> -</tr><tr> -<td><a href="#E5PathPicker.setButtonToolTip">setButtonToolTip</a></td> -<td>Public method to set the tool button tool tip.</td> -</tr><tr> -<td><a href="#E5PathPicker.setDefaultDirectory">setDefaultDirectory</a></td> -<td>Public method to set the default directory.</td> -</tr><tr> -<td><a href="#E5PathPicker.setEditorEnabled">setEditorEnabled</a></td> -<td>Public method to set the path editor's enabled state.</td> -</tr><tr> -<td><a href="#E5PathPicker.setEditorToolTip">setEditorToolTip</a></td> -<td>Public method to set the editor tool tip.</td> -</tr><tr> -<td><a href="#E5PathPicker.setFilters">setFilters</a></td> -<td>Public method to set the filters for the path picker dialog.</td> -</tr><tr> -<td><a href="#E5PathPicker.setMode">setMode</a></td> -<td>Public method to set the path picker mode.</td> -</tr><tr> -<td><a href="#E5PathPicker.setNameFilters">setNameFilters</a></td> -<td>Public method to set the name filters for the completer.</td> -</tr><tr> -<td><a href="#E5PathPicker.setPath">setPath</a></td> -<td>Public method to set the current path.</td> -</tr><tr> -<td><a href="#E5PathPicker.setPickerEnabled">setPickerEnabled</a></td> -<td>Public method to set the enabled state of the file dialog button.</td> -</tr><tr> -<td><a href="#E5PathPicker.setText">setText</a></td> -<td>Public method to set the current path.</td> -</tr><tr> -<td><a href="#E5PathPicker.setWindowTitle">setWindowTitle</a></td> -<td>Public method to set the path picker dialog window title.</td> -</tr><tr> -<td><a href="#E5PathPicker.text">text</a></td> -<td>Public method to get the current path.</td> -</tr><tr> -<td><a href="#E5PathPicker.windowTitle">windowTitle</a></td> -<td>Public method to get the path picker dialog's window title.</td> </tr> </table> <h3>Static Methods</h3> @@ -705,8 +159,187 @@ <dd> reference to the parent widget </dd> -</dl><a NAME="E5PathPicker.__pathEdited" ID="E5PathPicker.__pathEdited"></a> -<h4>E5PathPicker.__pathEdited</h4> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="E5PathPickerBase" ID="E5PathPickerBase"></a> +<h2>E5PathPickerBase</h2> +<p> + Class implementing the base of a path picker widget consisting of a + line edit or combo box and a tool button to open a file dialog. +</p><h3>Signals</h3> +<dl> +<dt>aboutToShowPathPickerDialog</dt> +<dd> +emitted before the file dialog is shown +</dd><dt>editTextChanged(path)</dt> +<dd> +emitted when the entered path has changed + (combo box based widget) +</dd><dt>pathSelected(path)</dt> +<dd> +emitted after a path has been selected via the + file dialog +</dd><dt>pickerButtonClicked</dt> +<dd> +emitted when the picker button was pressed and + the widget mode is custom +</dd><dt>textChanged(path)</dt> +<dd> +emitted when the entered path has changed + (line edit based widget) +</dd> +</dl> +<h3>Derived from</h3> +QWidget +<h3>Class Attributes</h3> +<table> +<tr><td>DefaultMode</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#E5PathPickerBase.__init__">E5PathPickerBase</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#E5PathPickerBase.__pathEdited">__pathEdited</a></td> +<td>Private slot handling editing of the path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.__showPathPickerDialog">__showPathPickerDialog</a></td> +<td>Private slot to show the path picker dialog.</td> +</tr><tr> +<td><a href="#E5PathPickerBase._editorText">_editorText</a></td> +<td>Protected method to get the text of the editor.</td> +</tr><tr> +<td><a href="#E5PathPickerBase._setEditorText">_setEditorText</a></td> +<td>Protected method to set the text of the editor.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.addItem">addItem</a></td> +<td>Public method to add a paths to the current list.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.addItems">addItems</a></td> +<td>Public method to add paths to the current list.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.buttonToolTip">buttonToolTip</a></td> +<td>Public method to get the tool button tool tip.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.clear">clear</a></td> +<td>Public method to clear the current path or list of paths.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.clearEditText">clearEditText</a></td> +<td>Public method to clear the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.currentText">currentText</a></td> +<td>Public method to get the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.defaultDirectory">defaultDirectory</a></td> +<td>Public method to get the default directory.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.editorEnabled">editorEnabled</a></td> +<td>Public method to get the path editor's enabled state.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.editorToolTip">editorToolTip</a></td> +<td>Public method to get the editor tool tip.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.filters">filters</a></td> +<td>Public methods to get the filter string.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.firstPath">firstPath</a></td> +<td>Public method to get the first path of a list of entered paths.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.isPickerEnabled">isPickerEnabled</a></td> +<td>Public method to get the file dialog button enabled state.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.lastPath">lastPath</a></td> +<td>Public method to get the last path of a list of entered paths.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.mode">mode</a></td> +<td>Public method to get the path picker mode.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.path">path</a></td> +<td>Public method to get the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.paths">paths</a></td> +<td>Public method to get the list of entered paths.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setButtonToolTip">setButtonToolTip</a></td> +<td>Public method to set the tool button tool tip.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setCurrentIndex">setCurrentIndex</a></td> +<td>Public slot to set the current index.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setDefaultDirectory">setDefaultDirectory</a></td> +<td>Public method to set the default directory.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setEditText">setEditText</a></td> +<td>Public method to set the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setEditorEnabled">setEditorEnabled</a></td> +<td>Public method to set the path editor's enabled state.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setEditorToolTip">setEditorToolTip</a></td> +<td>Public method to set the editor tool tip.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setFilters">setFilters</a></td> +<td>Public method to set the filters for the path picker dialog.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setInsertPolicy">setInsertPolicy</a></td> +<td>Public method to set the insertion policy of the combo box.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setMode">setMode</a></td> +<td>Public method to set the path picker mode.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setNameFilters">setNameFilters</a></td> +<td>Public method to set the name filters for the completer.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setPath">setPath</a></td> +<td>Public method to set the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setPathsList">setPathsList</a></td> +<td>Public method to set the paths list.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setPickerEnabled">setPickerEnabled</a></td> +<td>Public method to set the enabled state of the file dialog button.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setSizeAdjustPolicy">setSizeAdjustPolicy</a></td> +<td>Public method to set the size adjust policy of the combo box.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setText">setText</a></td> +<td>Public method to set the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.setWindowTitle">setWindowTitle</a></td> +<td>Public method to set the path picker dialog window title.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.text">text</a></td> +<td>Public method to get the current path.</td> +</tr><tr> +<td><a href="#E5PathPickerBase.windowTitle">windowTitle</a></td> +<td>Public method to get the path picker dialog's window title.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="E5PathPickerBase.__init__" ID="E5PathPickerBase.__init__"></a> +<h4>E5PathPickerBase (Constructor)</h4> +<b>E5PathPickerBase</b>(<i>parent=None, useLineEdit=True</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd><dt><i>useLineEdit</i> (bool)</dt> +<dd> +flag indicating the use of a line edit +</dd> +</dl><a NAME="E5PathPickerBase.__pathEdited" ID="E5PathPickerBase.__pathEdited"></a> +<h4>E5PathPickerBase.__pathEdited</h4> <b>__pathEdited</b>(<i>path</i>) <p> Private slot handling editing of the path. @@ -715,13 +348,58 @@ <dd> current text of the path line edit </dd> -</dl><a NAME="E5PathPicker.__showPathPickerDialog" ID="E5PathPicker.__showPathPickerDialog"></a> -<h4>E5PathPicker.__showPathPickerDialog</h4> +</dl><a NAME="E5PathPickerBase.__showPathPickerDialog" ID="E5PathPickerBase.__showPathPickerDialog"></a> +<h4>E5PathPickerBase.__showPathPickerDialog</h4> <b>__showPathPickerDialog</b>(<i></i>) <p> Private slot to show the path picker dialog. -</p><a NAME="E5PathPicker.buttonToolTip" ID="E5PathPicker.buttonToolTip"></a> -<h4>E5PathPicker.buttonToolTip</h4> +</p><a NAME="E5PathPickerBase._editorText" ID="E5PathPickerBase._editorText"></a> +<h4>E5PathPickerBase._editorText</h4> +<b>_editorText</b>(<i></i>) +<p> + Protected method to get the text of the editor. +</p><dl> +<dt>Returns:</dt> +<dd> +text of the editor +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="E5PathPickerBase._setEditorText" ID="E5PathPickerBase._setEditorText"></a> +<h4>E5PathPickerBase._setEditorText</h4> +<b>_setEditorText</b>(<i>text</i>) +<p> + Protected method to set the text of the editor. +</p><dl> +<dt><i>text</i> (str)</dt> +<dd> +text to set +</dd> +</dl><a NAME="E5PathPickerBase.addItem" ID="E5PathPickerBase.addItem"></a> +<h4>E5PathPickerBase.addItem</h4> +<b>addItem</b>(<i>path</i>) +<p> + Public method to add a paths to the current list. +</p><dl> +<dt><i>path</i> (str)</dt> +<dd> +path to add +</dd> +</dl><a NAME="E5PathPickerBase.addItems" ID="E5PathPickerBase.addItems"></a> +<h4>E5PathPickerBase.addItems</h4> +<b>addItems</b>(<i>pathsList</i>) +<p> + Public method to add paths to the current list. +</p><dl> +<dt><i>pathsList</i> (list of str)</dt> +<dd> +list of paths to add +</dd> +</dl><a NAME="E5PathPickerBase.buttonToolTip" ID="E5PathPickerBase.buttonToolTip"></a> +<h4>E5PathPickerBase.buttonToolTip</h4> <b>buttonToolTip</b>(<i></i>) <p> Public method to get the tool button tool tip. @@ -735,13 +413,33 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.clear" ID="E5PathPicker.clear"></a> -<h4>E5PathPicker.clear</h4> +</dl><a NAME="E5PathPickerBase.clear" ID="E5PathPickerBase.clear"></a> +<h4>E5PathPickerBase.clear</h4> <b>clear</b>(<i></i>) <p> + Public method to clear the current path or list of paths. +</p><a NAME="E5PathPickerBase.clearEditText" ID="E5PathPickerBase.clearEditText"></a> +<h4>E5PathPickerBase.clearEditText</h4> +<b>clearEditText</b>(<i></i>) +<p> Public method to clear the current path. -</p><a NAME="E5PathPicker.defaultDirectory" ID="E5PathPicker.defaultDirectory"></a> -<h4>E5PathPicker.defaultDirectory</h4> +</p><a NAME="E5PathPickerBase.currentText" ID="E5PathPickerBase.currentText"></a> +<h4>E5PathPickerBase.currentText</h4> +<b>currentText</b>(<i></i>) +<p> + Public method to get the current path. +</p><dl> +<dt>Returns:</dt> +<dd> +current path +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="E5PathPickerBase.defaultDirectory" ID="E5PathPickerBase.defaultDirectory"></a> +<h4>E5PathPickerBase.defaultDirectory</h4> <b>defaultDirectory</b>(<i></i>) <p> Public method to get the default directory. @@ -755,8 +453,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.editorEnabled" ID="E5PathPicker.editorEnabled"></a> -<h4>E5PathPicker.editorEnabled</h4> +</dl><a NAME="E5PathPickerBase.editorEnabled" ID="E5PathPickerBase.editorEnabled"></a> +<h4>E5PathPickerBase.editorEnabled</h4> <b>editorEnabled</b>(<i></i>) <p> Public method to get the path editor's enabled state. @@ -770,8 +468,8 @@ <dd> bool </dd> -</dl><a NAME="E5PathPicker.editorToolTip" ID="E5PathPicker.editorToolTip"></a> -<h4>E5PathPicker.editorToolTip</h4> +</dl><a NAME="E5PathPickerBase.editorToolTip" ID="E5PathPickerBase.editorToolTip"></a> +<h4>E5PathPickerBase.editorToolTip</h4> <b>editorToolTip</b>(<i></i>) <p> Public method to get the editor tool tip. @@ -785,8 +483,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.filters" ID="E5PathPicker.filters"></a> -<h4>E5PathPicker.filters</h4> +</dl><a NAME="E5PathPickerBase.filters" ID="E5PathPickerBase.filters"></a> +<h4>E5PathPickerBase.filters</h4> <b>filters</b>(<i></i>) <p> Public methods to get the filter string. @@ -800,8 +498,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.firstPath" ID="E5PathPicker.firstPath"></a> -<h4>E5PathPicker.firstPath</h4> +</dl><a NAME="E5PathPickerBase.firstPath" ID="E5PathPickerBase.firstPath"></a> +<h4>E5PathPickerBase.firstPath</h4> <b>firstPath</b>(<i></i>) <p> Public method to get the first path of a list of entered paths. @@ -815,8 +513,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.isPickerEnabled" ID="E5PathPicker.isPickerEnabled"></a> -<h4>E5PathPicker.isPickerEnabled</h4> +</dl><a NAME="E5PathPickerBase.isPickerEnabled" ID="E5PathPickerBase.isPickerEnabled"></a> +<h4>E5PathPickerBase.isPickerEnabled</h4> <b>isPickerEnabled</b>(<i></i>) <p> Public method to get the file dialog button enabled state. @@ -830,8 +528,8 @@ <dd> bool </dd> -</dl><a NAME="E5PathPicker.lastPath" ID="E5PathPicker.lastPath"></a> -<h4>E5PathPicker.lastPath</h4> +</dl><a NAME="E5PathPickerBase.lastPath" ID="E5PathPickerBase.lastPath"></a> +<h4>E5PathPickerBase.lastPath</h4> <b>lastPath</b>(<i></i>) <p> Public method to get the last path of a list of entered paths. @@ -845,8 +543,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.mode" ID="E5PathPicker.mode"></a> -<h4>E5PathPicker.mode</h4> +</dl><a NAME="E5PathPickerBase.mode" ID="E5PathPickerBase.mode"></a> +<h4>E5PathPickerBase.mode</h4> <b>mode</b>(<i></i>) <p> Public method to get the path picker mode. @@ -860,8 +558,8 @@ <dd> E5PathPickerModes </dd> -</dl><a NAME="E5PathPicker.path" ID="E5PathPicker.path"></a> -<h4>E5PathPicker.path</h4> +</dl><a NAME="E5PathPickerBase.path" ID="E5PathPickerBase.path"></a> +<h4>E5PathPickerBase.path</h4> <b>path</b>(<i></i>) <p> Public method to get the current path. @@ -875,8 +573,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.paths" ID="E5PathPicker.paths"></a> -<h4>E5PathPicker.paths</h4> +</dl><a NAME="E5PathPickerBase.paths" ID="E5PathPickerBase.paths"></a> +<h4>E5PathPickerBase.paths</h4> <b>paths</b>(<i></i>) <p> Public method to get the list of entered paths. @@ -890,8 +588,8 @@ <dd> list of str </dd> -</dl><a NAME="E5PathPicker.setButtonToolTip" ID="E5PathPicker.setButtonToolTip"></a> -<h4>E5PathPicker.setButtonToolTip</h4> +</dl><a NAME="E5PathPickerBase.setButtonToolTip" ID="E5PathPickerBase.setButtonToolTip"></a> +<h4>E5PathPickerBase.setButtonToolTip</h4> <b>setButtonToolTip</b>(<i>tooltip</i>) <p> Public method to set the tool button tool tip. @@ -900,8 +598,18 @@ <dd> text to be set as a tool tip </dd> -</dl><a NAME="E5PathPicker.setDefaultDirectory" ID="E5PathPicker.setDefaultDirectory"></a> -<h4>E5PathPicker.setDefaultDirectory</h4> +</dl><a NAME="E5PathPickerBase.setCurrentIndex" ID="E5PathPickerBase.setCurrentIndex"></a> +<h4>E5PathPickerBase.setCurrentIndex</h4> +<b>setCurrentIndex</b>(<i>index</i>) +<p> + Public slot to set the current index. +</p><dl> +<dt><i>index</i> (int)</dt> +<dd> +index of the item to set current +</dd> +</dl><a NAME="E5PathPickerBase.setDefaultDirectory" ID="E5PathPickerBase.setDefaultDirectory"></a> +<h4>E5PathPickerBase.setDefaultDirectory</h4> <b>setDefaultDirectory</b>(<i>directory</i>) <p> Public method to set the default directory. @@ -910,8 +618,18 @@ <dd> default directory </dd> -</dl><a NAME="E5PathPicker.setEditorEnabled" ID="E5PathPicker.setEditorEnabled"></a> -<h4>E5PathPicker.setEditorEnabled</h4> +</dl><a NAME="E5PathPickerBase.setEditText" ID="E5PathPickerBase.setEditText"></a> +<h4>E5PathPickerBase.setEditText</h4> +<b>setEditText</b>(<i>path</i>) +<p> + Public method to set the current path. +</p><dl> +<dt><i>path</i> (str)</dt> +<dd> +path to be set +</dd> +</dl><a NAME="E5PathPickerBase.setEditorEnabled" ID="E5PathPickerBase.setEditorEnabled"></a> +<h4>E5PathPickerBase.setEditorEnabled</h4> <b>setEditorEnabled</b>(<i>enable</i>) <p> Public method to set the path editor's enabled state. @@ -920,8 +638,8 @@ <dd> flag indicating the enable state </dd> -</dl><a NAME="E5PathPicker.setEditorToolTip" ID="E5PathPicker.setEditorToolTip"></a> -<h4>E5PathPicker.setEditorToolTip</h4> +</dl><a NAME="E5PathPickerBase.setEditorToolTip" ID="E5PathPickerBase.setEditorToolTip"></a> +<h4>E5PathPickerBase.setEditorToolTip</h4> <b>setEditorToolTip</b>(<i>tooltip</i>) <p> Public method to set the editor tool tip. @@ -930,8 +648,8 @@ <dd> text to be set as a tool tip </dd> -</dl><a NAME="E5PathPicker.setFilters" ID="E5PathPicker.setFilters"></a> -<h4>E5PathPicker.setFilters</h4> +</dl><a NAME="E5PathPickerBase.setFilters" ID="E5PathPickerBase.setFilters"></a> +<h4>E5PathPickerBase.setFilters</h4> <b>setFilters</b>(<i>filters</i>) <p> Public method to set the filters for the path picker dialog. @@ -942,8 +660,18 @@ <dd> string containing the file filters </dd> -</dl><a NAME="E5PathPicker.setMode" ID="E5PathPicker.setMode"></a> -<h4>E5PathPicker.setMode</h4> +</dl><a NAME="E5PathPickerBase.setInsertPolicy" ID="E5PathPickerBase.setInsertPolicy"></a> +<h4>E5PathPickerBase.setInsertPolicy</h4> +<b>setInsertPolicy</b>(<i>policy</i>) +<p> + Public method to set the insertion policy of the combo box. +</p><dl> +<dt><i>policy</i> (QComboBox.InsertPolicy)</dt> +<dd> +insertion policy +</dd> +</dl><a NAME="E5PathPickerBase.setMode" ID="E5PathPickerBase.setMode"></a> +<h4>E5PathPickerBase.setMode</h4> <b>setMode</b>(<i>mode</i>) <p> Public method to set the path picker mode. @@ -952,8 +680,8 @@ <dd> picker mode </dd> -</dl><a NAME="E5PathPicker.setNameFilters" ID="E5PathPicker.setNameFilters"></a> -<h4>E5PathPicker.setNameFilters</h4> +</dl><a NAME="E5PathPickerBase.setNameFilters" ID="E5PathPickerBase.setNameFilters"></a> +<h4>E5PathPickerBase.setNameFilters</h4> <b>setNameFilters</b>(<i>filters</i>) <p> Public method to set the name filters for the completer. @@ -962,8 +690,8 @@ <dd> list of file name filters </dd> -</dl><a NAME="E5PathPicker.setPath" ID="E5PathPicker.setPath"></a> -<h4>E5PathPicker.setPath</h4> +</dl><a NAME="E5PathPickerBase.setPath" ID="E5PathPickerBase.setPath"></a> +<h4>E5PathPickerBase.setPath</h4> <b>setPath</b>(<i>path</i>) <p> Public method to set the current path. @@ -972,8 +700,18 @@ <dd> path to be set </dd> -</dl><a NAME="E5PathPicker.setPickerEnabled" ID="E5PathPicker.setPickerEnabled"></a> -<h4>E5PathPicker.setPickerEnabled</h4> +</dl><a NAME="E5PathPickerBase.setPathsList" ID="E5PathPickerBase.setPathsList"></a> +<h4>E5PathPickerBase.setPathsList</h4> +<b>setPathsList</b>(<i>pathsList</i>) +<p> + Public method to set the paths list. +</p><dl> +<dt><i>pathsList</i> (list of str)</dt> +<dd> +list of paths +</dd> +</dl><a NAME="E5PathPickerBase.setPickerEnabled" ID="E5PathPickerBase.setPickerEnabled"></a> +<h4>E5PathPickerBase.setPickerEnabled</h4> <b>setPickerEnabled</b>(<i>enable</i>) <p> Public method to set the enabled state of the file dialog button. @@ -982,8 +720,18 @@ <dd> flag indicating the enabled state </dd> -</dl><a NAME="E5PathPicker.setText" ID="E5PathPicker.setText"></a> -<h4>E5PathPicker.setText</h4> +</dl><a NAME="E5PathPickerBase.setSizeAdjustPolicy" ID="E5PathPickerBase.setSizeAdjustPolicy"></a> +<h4>E5PathPickerBase.setSizeAdjustPolicy</h4> +<b>setSizeAdjustPolicy</b>(<i>policy</i>) +<p> + Public method to set the size adjust policy of the combo box. +</p><dl> +<dt><i>policy</i> (QComboBox.SizeAdjustPolicy)</dt> +<dd> +size adjust policy +</dd> +</dl><a NAME="E5PathPickerBase.setText" ID="E5PathPickerBase.setText"></a> +<h4>E5PathPickerBase.setText</h4> <b>setText</b>(<i>path</i>) <p> Public method to set the current path. @@ -992,8 +740,8 @@ <dd> path to be set </dd> -</dl><a NAME="E5PathPicker.setWindowTitle" ID="E5PathPicker.setWindowTitle"></a> -<h4>E5PathPicker.setWindowTitle</h4> +</dl><a NAME="E5PathPickerBase.setWindowTitle" ID="E5PathPickerBase.setWindowTitle"></a> +<h4>E5PathPickerBase.setWindowTitle</h4> <b>setWindowTitle</b>(<i>title</i>) <p> Public method to set the path picker dialog window title. @@ -1002,8 +750,8 @@ <dd> window title </dd> -</dl><a NAME="E5PathPicker.text" ID="E5PathPicker.text"></a> -<h4>E5PathPicker.text</h4> +</dl><a NAME="E5PathPickerBase.text" ID="E5PathPickerBase.text"></a> +<h4>E5PathPickerBase.text</h4> <b>text</b>(<i></i>) <p> Public method to get the current path. @@ -1017,8 +765,8 @@ <dd> str </dd> -</dl><a NAME="E5PathPicker.windowTitle" ID="E5PathPicker.windowTitle"></a> -<h4>E5PathPicker.windowTitle</h4> +</dl><a NAME="E5PathPickerBase.windowTitle" ID="E5PathPickerBase.windowTitle"></a> +<h4>E5PathPickerBase.windowTitle</h4> <b>windowTitle</b>(<i></i>) <p> Public method to get the path picker dialog's window title.