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

branch
eric7
changeset 10784
521fd465b048
parent 10692
9becf9ca115c
equal deleted inserted replaced
10783:ccf28bec1227 10784:521fd465b048
566 <tr> 566 <tr>
567 <td><a href="#ViewManager.__openFiles">__openFiles</a></td> 567 <td><a href="#ViewManager.__openFiles">__openFiles</a></td>
568 <td>Private slot to open some files.</td> 568 <td>Private slot to open some files.</td>
569 </tr> 569 </tr>
570 <tr> 570 <tr>
571 <td><a href="#ViewManager.__openRemoteFiles">__openRemoteFiles</a></td>
572 <td>Private slot to open some files.</td>
573 </tr>
574 <tr>
571 <td><a href="#ViewManager.__openSourceFile">__openSourceFile</a></td> 575 <td><a href="#ViewManager.__openSourceFile">__openSourceFile</a></td>
572 <td>Private method to open a file from the list of recently opened files.</td> 576 <td>Private method to open a file from the list of recently opened files.</td>
573 </tr> 577 </tr>
574 <tr> 578 <tr>
575 <td><a href="#ViewManager.__previewEditor">__previewEditor</a></td> 579 <td><a href="#ViewManager.__previewEditor">__previewEditor</a></td>
866 <tr> 870 <tr>
867 <td><a href="#ViewManager.closeEditorWindow">closeEditorWindow</a></td> 871 <td><a href="#ViewManager.closeEditorWindow">closeEditorWindow</a></td>
868 <td>Public method to close an arbitrary source editor.</td> 872 <td>Public method to close an arbitrary source editor.</td>
869 </tr> 873 </tr>
870 <tr> 874 <tr>
875 <td><a href="#ViewManager.closeRemoteEditors">closeRemoteEditors</a></td>
876 <td>Public slot to close all editors related to a connected eric-ide server.</td>
877 </tr>
878 <tr>
871 <td><a href="#ViewManager.closeViewManager">closeViewManager</a></td> 879 <td><a href="#ViewManager.closeViewManager">closeViewManager</a></td>
872 <td>Public method to shutdown the viewmanager.</td> 880 <td>Public method to shutdown the viewmanager.</td>
873 </tr> 881 </tr>
874 <tr> 882 <tr>
875 <td><a href="#ViewManager.closeWindow">closeWindow</a></td> 883 <td><a href="#ViewManager.closeWindow">closeWindow</a></td>
1102 <tr> 1110 <tr>
1103 <td><a href="#ViewManager.receive">receive</a></td> 1111 <td><a href="#ViewManager.receive">receive</a></td>
1104 <td>Public slot to handle received editor commands.</td> 1112 <td>Public slot to handle received editor commands.</td>
1105 </tr> 1113 </tr>
1106 <tr> 1114 <tr>
1115 <td><a href="#ViewManager.remoteConnectionChanged">remoteConnectionChanged</a></td>
1116 <td>Public slot handling a change of the connection state to an eric-ide server.</td>
1117 </tr>
1118 <tr>
1107 <td><a href="#ViewManager.removeSplit">removeSplit</a></td> 1119 <td><a href="#ViewManager.removeSplit">removeSplit</a></td>
1108 <td>Public method used to remove the current split view or a split view by index.</td> 1120 <td>Public method used to remove the current split view or a split view by index.</td>
1109 </tr> 1121 </tr>
1110 <tr> 1122 <tr>
1111 <td><a href="#ViewManager.removeWatchedFilePath">removeWatchedFilePath</a></td> 1123 <td><a href="#ViewManager.removeWatchedFilePath">removeWatchedFilePath</a></td>
1120 <td>Public slot to save the contents of the current editor to a new file.</td> 1132 <td>Public slot to save the contents of the current editor to a new file.</td>
1121 </tr> 1133 </tr>
1122 <tr> 1134 <tr>
1123 <td><a href="#ViewManager.saveAsEditorEd">saveAsEditorEd</a></td> 1135 <td><a href="#ViewManager.saveAsEditorEd">saveAsEditorEd</a></td>
1124 <td>Public slot to save the contents of an editor to a new file.</td> 1136 <td>Public slot to save the contents of an editor to a new file.</td>
1137 </tr>
1138 <tr>
1139 <td><a href="#ViewManager.saveAsRemoteCurrentEditor">saveAsRemoteCurrentEditor</a></td>
1140 <td>Public slot to save the contents of the current editor to a new file on a connected eric-ide server.</td>
1141 </tr>
1142 <tr>
1143 <td><a href="#ViewManager.saveAsRemoteEditorEd">saveAsRemoteEditorEd</a></td>
1144 <td>Public slot to save the contents of an editor to a new file on a connected eric-ide server.</td>
1125 </tr> 1145 </tr>
1126 <tr> 1146 <tr>
1127 <td><a href="#ViewManager.saveCopyCurrentEditor">saveCopyCurrentEditor</a></td> 1147 <td><a href="#ViewManager.saveCopyCurrentEditor">saveCopyCurrentEditor</a></td>
1128 <td>Public slot to save the contents of the current editor to a new copy of the file.</td> 1148 <td>Public slot to save the contents of the current editor to a new copy of the file.</td>
1129 </tr> 1149 </tr>
2170 <b>__openFiles</b>(<i></i>) 2190 <b>__openFiles</b>(<i></i>)
2171 <p> 2191 <p>
2172 Private slot to open some files. 2192 Private slot to open some files.
2173 </p> 2193 </p>
2174 2194
2195 <a NAME="ViewManager.__openRemoteFiles" ID="ViewManager.__openRemoteFiles"></a>
2196 <h4>ViewManager.__openRemoteFiles</h4>
2197 <b>__openRemoteFiles</b>(<i></i>)
2198 <p>
2199 Private slot to open some files.
2200 </p>
2201
2175 <a NAME="ViewManager.__openSourceFile" ID="ViewManager.__openSourceFile"></a> 2202 <a NAME="ViewManager.__openSourceFile" ID="ViewManager.__openSourceFile"></a>
2176 <h4>ViewManager.__openSourceFile</h4> 2203 <h4>ViewManager.__openSourceFile</h4>
2177 <b>__openSourceFile</b>(<i>act</i>) 2204 <b>__openSourceFile</b>(<i>act</i>)
2178 <p> 2205 <p>
2179 Private method to open a file from the list of recently opened files. 2206 Private method to open a file from the list of recently opened files.
2669 str 2696 str
2670 </dd> 2697 </dd>
2671 </dl> 2698 </dl>
2672 <a NAME="ViewManager._getOpenStartDir" ID="ViewManager._getOpenStartDir"></a> 2699 <a NAME="ViewManager._getOpenStartDir" ID="ViewManager._getOpenStartDir"></a>
2673 <h4>ViewManager._getOpenStartDir</h4> 2700 <h4>ViewManager._getOpenStartDir</h4>
2674 <b>_getOpenStartDir</b>(<i></i>) 2701 <b>_getOpenStartDir</b>(<i>forRemote=False</i>)
2675 <p> 2702 <p>
2676 Protected method to return the starting directory for a file open 2703 Protected method to return the starting directory for a file open
2677 dialog. 2704 dialog.
2678 </p> 2705 </p>
2679 <p> 2706 <p>
2680 The appropriate starting directory is calculated 2707 The appropriate starting directory is calculated
2681 using the following search order, until a match is found:<br /> 2708 using the following search order, until a match is found:<br />
2682 1: Directory of currently active editor<br /> 2709 1: Directory of currently active editor<br />
2683 2: Directory of currently active Project<br /> 2710 2: Directory of currently active Project<br />
2684 3: CWD 2711 3: Directory defined as the workspace (only for local access)<br />
2685 </p> 2712 4: CWD
2686 2713 </p>
2714
2715 <dl>
2716
2717 <dt><i>forRemote</i> (bool (optional))</dt>
2718 <dd>
2719 flag indicating to get the start directory for a remote
2720 operation (defaults to False)
2721 </dd>
2722 </dl>
2687 <dl> 2723 <dl>
2688 <dt>Return:</dt> 2724 <dt>Return:</dt>
2689 <dd> 2725 <dd>
2690 name of directory to start 2726 name of directory to start
2691 </dd> 2727 </dd>
3204 <dt><i>editor</i> (Editor)</dt> 3240 <dt><i>editor</i> (Editor)</dt>
3205 <dd> 3241 <dd>
3206 editor to be closed 3242 editor to be closed
3207 </dd> 3243 </dd>
3208 </dl> 3244 </dl>
3245 <a NAME="ViewManager.closeRemoteEditors" ID="ViewManager.closeRemoteEditors"></a>
3246 <h4>ViewManager.closeRemoteEditors</h4>
3247 <b>closeRemoteEditors</b>(<i></i>)
3248 <p>
3249 Public slot to close all editors related to a connected eric-ide server.
3250 </p>
3251
3209 <a NAME="ViewManager.closeViewManager" ID="ViewManager.closeViewManager"></a> 3252 <a NAME="ViewManager.closeViewManager" ID="ViewManager.closeViewManager"></a>
3210 <h4>ViewManager.closeViewManager</h4> 3253 <h4>ViewManager.closeViewManager</h4>
3211 <b>closeViewManager</b>(<i></i>) 3254 <b>closeViewManager</b>(<i></i>)
3212 <p> 3255 <p>
3213 Public method to shutdown the viewmanager. 3256 Public method to shutdown the viewmanager.
4385 <dt><i>command</i> (str)</dt> 4428 <dt><i>command</i> (str)</dt>
4386 <dd> 4429 <dd>
4387 command string 4430 command string
4388 </dd> 4431 </dd>
4389 </dl> 4432 </dl>
4433 <a NAME="ViewManager.remoteConnectionChanged" ID="ViewManager.remoteConnectionChanged"></a>
4434 <h4>ViewManager.remoteConnectionChanged</h4>
4435 <b>remoteConnectionChanged</b>(<i>connected</i>)
4436 <p>
4437 Public slot handling a change of the connection state to an eric-ide server.
4438 </p>
4439
4440 <dl>
4441
4442 <dt><i>connected</i> (bool)</dt>
4443 <dd>
4444 flag indicating the connection state
4445 </dd>
4446 </dl>
4390 <a NAME="ViewManager.removeSplit" ID="ViewManager.removeSplit"></a> 4447 <a NAME="ViewManager.removeSplit" ID="ViewManager.removeSplit"></a>
4391 <h4>ViewManager.removeSplit</h4> 4448 <h4>ViewManager.removeSplit</h4>
4392 <b>removeSplit</b>(<i>index=-1</i>) 4449 <b>removeSplit</b>(<i>index=-1</i>)
4393 <p> 4450 <p>
4394 Public method used to remove the current split view or a split view 4451 Public method used to remove the current split view or a split view
4455 <dt><i>ed</i> (Editor)</dt> 4512 <dt><i>ed</i> (Editor)</dt>
4456 <dd> 4513 <dd>
4457 editor to be saved 4514 editor to be saved
4458 </dd> 4515 </dd>
4459 </dl> 4516 </dl>
4517 <a NAME="ViewManager.saveAsRemoteCurrentEditor" ID="ViewManager.saveAsRemoteCurrentEditor"></a>
4518 <h4>ViewManager.saveAsRemoteCurrentEditor</h4>
4519 <b>saveAsRemoteCurrentEditor</b>(<i></i>)
4520 <p>
4521 Public slot to save the contents of the current editor to a new file on a
4522 connected eric-ide server.
4523 </p>
4524
4525 <a NAME="ViewManager.saveAsRemoteEditorEd" ID="ViewManager.saveAsRemoteEditorEd"></a>
4526 <h4>ViewManager.saveAsRemoteEditorEd</h4>
4527 <b>saveAsRemoteEditorEd</b>(<i>ed</i>)
4528 <p>
4529 Public slot to save the contents of an editor to a new file on a
4530 connected eric-ide server.
4531 </p>
4532
4533 <dl>
4534
4535 <dt><i>ed</i> (Editor)</dt>
4536 <dd>
4537 editor to be saved
4538 </dd>
4539 </dl>
4460 <a NAME="ViewManager.saveCopyCurrentEditor" ID="ViewManager.saveCopyCurrentEditor"></a> 4540 <a NAME="ViewManager.saveCopyCurrentEditor" ID="ViewManager.saveCopyCurrentEditor"></a>
4461 <h4>ViewManager.saveCopyCurrentEditor</h4> 4541 <h4>ViewManager.saveCopyCurrentEditor</h4>
4462 <b>saveCopyCurrentEditor</b>(<i></i>) 4542 <b>saveCopyCurrentEditor</b>(<i></i>)
4463 <p> 4543 <p>
4464 Public slot to save the contents of the current editor to a new copy 4544 Public slot to save the contents of the current editor to a new copy
4660 flag indicating an error highlight 4740 flag indicating an error highlight
4661 </dd> 4741 </dd>
4662 </dl> 4742 </dl>
4663 <a NAME="ViewManager.setReferences" ID="ViewManager.setReferences"></a> 4743 <a NAME="ViewManager.setReferences" ID="ViewManager.setReferences"></a>
4664 <h4>ViewManager.setReferences</h4> 4744 <h4>ViewManager.setReferences</h4>
4665 <b>setReferences</b>(<i>ui, dbs</i>) 4745 <b>setReferences</b>(<i>ui, dbs, remoteServerInterface</i>)
4666 <p> 4746 <p>
4667 Public method to set some references needed later on. 4747 Public method to set some references needed later on.
4668 </p> 4748 </p>
4669 4749
4670 <dl> 4750 <dl>
4674 reference to the main user interface 4754 reference to the main user interface
4675 </dd> 4755 </dd>
4676 <dt><i>dbs</i> (DebugServer)</dt> 4756 <dt><i>dbs</i> (DebugServer)</dt>
4677 <dd> 4757 <dd>
4678 reference to the debug server object 4758 reference to the debug server object
4759 </dd>
4760 <dt><i>remoteServerInterface</i> (EricServerInterface)</dt>
4761 <dd>
4762 reference to the 'eric-ide' server interface
4679 </dd> 4763 </dd>
4680 </dl> 4764 </dl>
4681 <a NAME="ViewManager.setSbInfo" ID="ViewManager.setSbInfo"></a> 4765 <a NAME="ViewManager.setSbInfo" ID="ViewManager.setSbInfo"></a>
4682 <h4>ViewManager.setSbInfo</h4> 4766 <h4>ViewManager.setSbInfo</h4>
4683 <b>setSbInfo</b>(<i>sbLine, sbPos, sbWritable, sbEncoding, sbLanguage, sbEol, sbZoom</i>) 4767 <b>setSbInfo</b>(<i>sbLine, sbPos, sbWritable, sbEncoding, sbLanguage, sbEol, sbZoom</i>)

eric ide

mercurial