Documentation/Source/eric5.ViewManager.ViewManager.html

changeset 158
6a561f87bc07
parent 156
478787b5607e
child 365
0686ac00256e
equal deleted inserted replaced
157:c8d5916b9934 158:6a561f87bc07
300 <td>Private method to handle the selection of an export format.</td> 300 <td>Private method to handle the selection of an export format.</td>
301 </tr><tr> 301 </tr><tr>
302 <td><a href="#ViewManager.__findFileName">__findFileName</a></td> 302 <td><a href="#ViewManager.__findFileName">__findFileName</a></td>
303 <td>Private method to handle the search for file action.</td> 303 <td>Private method to handle the search for file action.</td>
304 </tr><tr> 304 </tr><tr>
305 <td><a href="#ViewManager.__getCooperationClient">__getCooperationClient</a></td>
306 <td>Private method to initialize and get a reference to the cooperation client.</td>
307 </tr><tr>
308 <td><a href="#ViewManager.__goto">__goto</a></td> 305 <td><a href="#ViewManager.__goto">__goto</a></td>
309 <td>Private method to handle the goto action.</td> 306 <td>Private method to handle the goto action.</td>
310 </tr><tr> 307 </tr><tr>
311 <td><a href="#ViewManager.__gotoBrace">__gotoBrace</a></td> 308 <td><a href="#ViewManager.__gotoBrace">__gotoBrace</a></td>
312 <td>Private method to handle the goto brace action.</td> 309 <td>Private method to handle the goto brace action.</td>
417 <td>Private slot to handle the quickFindPrev toolbutton action.</td> 414 <td>Private slot to handle the quickFindPrev toolbutton action.</td>
418 </tr><tr> 415 </tr><tr>
419 <td><a href="#ViewManager.__quickSearchText">__quickSearchText</a></td> 416 <td><a href="#ViewManager.__quickSearchText">__quickSearchText</a></td>
420 <td>Private slot to handle the textChanged signal of the quicksearch edit.</td> 417 <td>Private slot to handle the textChanged signal of the quicksearch edit.</td>
421 </tr><tr> 418 </tr><tr>
422 <td><a href="#ViewManager.__receive">__receive</a></td>
423 <td>Private slot to handle received editor commands.</td>
424 </tr><tr>
425 <td><a href="#ViewManager.__replace">__replace</a></td> 419 <td><a href="#ViewManager.__replace">__replace</a></td>
426 <td>Private method to handle the replace action.</td> 420 <td>Private method to handle the replace action.</td>
427 </tr><tr> 421 </tr><tr>
428 <td><a href="#ViewManager.__replaceFiles">__replaceFiles</a></td> 422 <td><a href="#ViewManager.__replaceFiles">__replaceFiles</a></td>
429 <td>Private method to handle the replace in files action.</td> 423 <td>Private method to handle the replace in files action.</td>
549 <td>Public method to signal if splitting of the view is available.</td> 543 <td>Public method to signal if splitting of the view is available.</td>
550 </tr><tr> 544 </tr><tr>
551 <td><a href="#ViewManager.canTile">canTile</a></td> 545 <td><a href="#ViewManager.canTile">canTile</a></td>
552 <td>Public method to signal if tiling of managed windows is available.</td> 546 <td>Public method to signal if tiling of managed windows is available.</td>
553 </tr><tr> 547 </tr><tr>
548 <td><a href="#ViewManager.cancelSharedEdit">cancelSharedEdit</a></td>
549 <td>Public slot to cancel a shared edit session for the current editor.</td>
550 </tr><tr>
554 <td><a href="#ViewManager.cascade">cascade</a></td> 551 <td><a href="#ViewManager.cascade">cascade</a></td>
555 <td>Public method to cascade the managed windows.</td> 552 <td>Public method to cascade the managed windows.</td>
556 </tr><tr> 553 </tr><tr>
557 <td><a href="#ViewManager.checkAllDirty">checkAllDirty</a></td> 554 <td><a href="#ViewManager.checkAllDirty">checkAllDirty</a></td>
558 <td>Public method to check the dirty status of all editors.</td> 555 <td>Public method to check the dirty status of all editors.</td>
711 <td>Public slot to handle changes of the project lexer associations.</td> 708 <td>Public slot to handle changes of the project lexer associations.</td>
712 </tr><tr> 709 </tr><tr>
713 <td><a href="#ViewManager.projectOpened">projectOpened</a></td> 710 <td><a href="#ViewManager.projectOpened">projectOpened</a></td>
714 <td>Public slot to handle the projectOpened signal.</td> 711 <td>Public slot to handle the projectOpened signal.</td>
715 </tr><tr> 712 </tr><tr>
713 <td><a href="#ViewManager.receive">receive</a></td>
714 <td>Public slot to handle received editor commands.</td>
715 </tr><tr>
716 <td><a href="#ViewManager.removeSplit">removeSplit</a></td> 716 <td><a href="#ViewManager.removeSplit">removeSplit</a></td>
717 <td>Public method used to remove the current split view.</td> 717 <td>Public method used to remove the current split view.</td>
718 </tr><tr> 718 </tr><tr>
719 <td><a href="#ViewManager.saveAllEditors">saveAllEditors</a></td> 719 <td><a href="#ViewManager.saveAllEditors">saveAllEditors</a></td>
720 <td>Public slot to save the contents of all editors.</td> 720 <td>Public slot to save the contents of all editors.</td>
744 <td>Public slot to save a list of editors.</td> 744 <td>Public slot to save a list of editors.</td>
745 </tr><tr> 745 </tr><tr>
746 <td><a href="#ViewManager.send">send</a></td> 746 <td><a href="#ViewManager.send">send</a></td>
747 <td>Public method to send an editor command to remote editors.</td> 747 <td>Public method to send an editor command to remote editors.</td>
748 </tr><tr> 748 </tr><tr>
749 <td><a href="#ViewManager.sendSharedEdit">sendSharedEdit</a></td>
750 <td>Public slot to end a shared edit session for the current editor and send the changes.</td>
751 </tr><tr>
752 <td><a href="#ViewManager.setCooperationClient">setCooperationClient</a></td>
753 <td>Public method to set a reference to the cooperation client.</td>
754 </tr><tr>
749 <td><a href="#ViewManager.setEditorName">setEditorName</a></td> 755 <td><a href="#ViewManager.setEditorName">setEditorName</a></td>
750 <td>Public method to change the displayed name of the editor.</td> 756 <td>Public method to change the displayed name of the editor.</td>
751 </tr><tr> 757 </tr><tr>
752 <td><a href="#ViewManager.setFileLine">setFileLine</a></td> 758 <td><a href="#ViewManager.setFileLine">setFileLine</a></td>
753 <td>Public method to update the user interface when the current program or line changes.</td> 759 <td>Public method to update the user interface when the current program or line changes.</td>
759 <td>Public method to transfer statusbar info from the user interface to viewmanager.</td> 765 <td>Public method to transfer statusbar info from the user interface to viewmanager.</td>
760 </tr><tr> 766 </tr><tr>
761 <td><a href="#ViewManager.setSplitOrientation">setSplitOrientation</a></td> 767 <td><a href="#ViewManager.setSplitOrientation">setSplitOrientation</a></td>
762 <td>Public method used to set the orientation of the split view.</td> 768 <td>Public method used to set the orientation of the split view.</td>
763 </tr><tr> 769 </tr><tr>
770 <td><a href="#ViewManager.shareConnected">shareConnected</a></td>
771 <td>Public slot to handle a change of the connected state.</td>
772 </tr><tr>
773 <td><a href="#ViewManager.shareEditor">shareEditor</a></td>
774 <td>Public slot to set the shared status of the current editor.</td>
775 </tr><tr>
764 <td><a href="#ViewManager.showDebugSource">showDebugSource</a></td> 776 <td><a href="#ViewManager.showDebugSource">showDebugSource</a></td>
765 <td>Public method to open the given file and highlight the given line in it.</td> 777 <td>Public method to open the given file and highlight the given line in it.</td>
766 </tr><tr> 778 </tr><tr>
767 <td><a href="#ViewManager.showWindowMenu">showWindowMenu</a></td> 779 <td><a href="#ViewManager.showWindowMenu">showWindowMenu</a></td>
768 <td>Public method to set up the viewmanager part of the Window menu.</td> 780 <td>Public method to set up the viewmanager part of the Window menu.</td>
781 </tr><tr>
782 <td><a href="#ViewManager.startSharedEdit">startSharedEdit</a></td>
783 <td>Public slot to start a shared edit session for the current editor.</td>
769 </tr><tr> 784 </tr><tr>
770 <td><a href="#ViewManager.textForFind">textForFind</a></td> 785 <td><a href="#ViewManager.textForFind">textForFind</a></td>
771 <td>Public method to determine the selection or the current word for the next find operation.</td> 786 <td>Public method to determine the selection or the current word for the next find operation.</td>
772 </tr><tr> 787 </tr><tr>
773 <td><a href="#ViewManager.tile">tile</a></td> 788 <td><a href="#ViewManager.tile">tile</a></td>
1074 </dl><a NAME="ViewManager.__findFileName" ID="ViewManager.__findFileName"></a> 1089 </dl><a NAME="ViewManager.__findFileName" ID="ViewManager.__findFileName"></a>
1075 <h4>ViewManager.__findFileName</h4> 1090 <h4>ViewManager.__findFileName</h4>
1076 <b>__findFileName</b>(<i></i>) 1091 <b>__findFileName</b>(<i></i>)
1077 <p> 1092 <p>
1078 Private method to handle the search for file action. 1093 Private method to handle the search for file action.
1079 </p><a NAME="ViewManager.__getCooperationClient" ID="ViewManager.__getCooperationClient"></a> 1094 </p><a NAME="ViewManager.__goto" ID="ViewManager.__goto"></a>
1080 <h4>ViewManager.__getCooperationClient</h4>
1081 <b>__getCooperationClient</b>(<i></i>)
1082 <p>
1083 Private method to initialize and get a reference to the cooperation
1084 client.
1085 </p><dl>
1086 <dt>Returns:</dt>
1087 <dd>
1088 reference to the cooperation client (CooperationClient)
1089 </dd>
1090 </dl><a NAME="ViewManager.__goto" ID="ViewManager.__goto"></a>
1091 <h4>ViewManager.__goto</h4> 1095 <h4>ViewManager.__goto</h4>
1092 <b>__goto</b>(<i></i>) 1096 <b>__goto</b>(<i></i>)
1093 <p> 1097 <p>
1094 Private method to handle the goto action. 1098 Private method to handle the goto action.
1095 </p><a NAME="ViewManager.__gotoBrace" ID="ViewManager.__gotoBrace"></a> 1099 </p><a NAME="ViewManager.__gotoBrace" ID="ViewManager.__gotoBrace"></a>
1296 </p><a NAME="ViewManager.__quickSearchText" ID="ViewManager.__quickSearchText"></a> 1300 </p><a NAME="ViewManager.__quickSearchText" ID="ViewManager.__quickSearchText"></a>
1297 <h4>ViewManager.__quickSearchText</h4> 1301 <h4>ViewManager.__quickSearchText</h4>
1298 <b>__quickSearchText</b>(<i></i>) 1302 <b>__quickSearchText</b>(<i></i>)
1299 <p> 1303 <p>
1300 Private slot to handle the textChanged signal of the quicksearch edit. 1304 Private slot to handle the textChanged signal of the quicksearch edit.
1301 </p><a NAME="ViewManager.__receive" ID="ViewManager.__receive"></a> 1305 </p><a NAME="ViewManager.__replace" ID="ViewManager.__replace"></a>
1302 <h4>ViewManager.__receive</h4>
1303 <b>__receive</b>(<i>hash, fileName, command</i>)
1304 <p>
1305 Private slot to handle received editor commands.
1306 </p><dl>
1307 <dt><i>hash</i></dt>
1308 <dd>
1309 hash of the project (string)
1310 </dd><dt><i>fileName</i></dt>
1311 <dd>
1312 project relative file name of the editor (string)
1313 </dd><dt><i>command</i></dt>
1314 <dd>
1315 command string (string)
1316 </dd>
1317 </dl><a NAME="ViewManager.__replace" ID="ViewManager.__replace"></a>
1318 <h4>ViewManager.__replace</h4> 1306 <h4>ViewManager.__replace</h4>
1319 <b>__replace</b>(<i></i>) 1307 <b>__replace</b>(<i></i>)
1320 <p> 1308 <p>
1321 Private method to handle the replace action. 1309 Private method to handle the replace action.
1322 </p><a NAME="ViewManager.__replaceFiles" ID="ViewManager.__replaceFiles"></a> 1310 </p><a NAME="ViewManager.__replaceFiles" ID="ViewManager.__replaceFiles"></a>
1699 </dl><dl> 1687 </dl><dl>
1700 <dt>Raises <b>RuntimeError</b>:</dt> 1688 <dt>Raises <b>RuntimeError</b>:</dt>
1701 <dd> 1689 <dd>
1702 Not implemented 1690 Not implemented
1703 </dd> 1691 </dd>
1704 </dl><a NAME="ViewManager.cascade" ID="ViewManager.cascade"></a> 1692 </dl><a NAME="ViewManager.cancelSharedEdit" ID="ViewManager.cancelSharedEdit"></a>
1693 <h4>ViewManager.cancelSharedEdit</h4>
1694 <b>cancelSharedEdit</b>(<i></i>)
1695 <p>
1696 Public slot to cancel a shared edit session for the current editor.
1697 </p><a NAME="ViewManager.cascade" ID="ViewManager.cascade"></a>
1705 <h4>ViewManager.cascade</h4> 1698 <h4>ViewManager.cascade</h4>
1706 <b>cascade</b>(<i></i>) 1699 <b>cascade</b>(<i></i>)
1707 <p> 1700 <p>
1708 Public method to cascade the managed windows. 1701 Public method to cascade the managed windows.
1709 </p><dl> 1702 </p><dl>
2303 </p><a NAME="ViewManager.projectOpened" ID="ViewManager.projectOpened"></a> 2296 </p><a NAME="ViewManager.projectOpened" ID="ViewManager.projectOpened"></a>
2304 <h4>ViewManager.projectOpened</h4> 2297 <h4>ViewManager.projectOpened</h4>
2305 <b>projectOpened</b>(<i></i>) 2298 <b>projectOpened</b>(<i></i>)
2306 <p> 2299 <p>
2307 Public slot to handle the projectOpened signal. 2300 Public slot to handle the projectOpened signal.
2308 </p><a NAME="ViewManager.removeSplit" ID="ViewManager.removeSplit"></a> 2301 </p><a NAME="ViewManager.receive" ID="ViewManager.receive"></a>
2302 <h4>ViewManager.receive</h4>
2303 <b>receive</b>(<i>hash, fileName, command</i>)
2304 <p>
2305 Public slot to handle received editor commands.
2306 </p><dl>
2307 <dt><i>hash</i></dt>
2308 <dd>
2309 hash of the project (string)
2310 </dd><dt><i>fileName</i></dt>
2311 <dd>
2312 project relative file name of the editor (string)
2313 </dd><dt><i>command</i></dt>
2314 <dd>
2315 command string (string)
2316 </dd>
2317 </dl><a NAME="ViewManager.removeSplit" ID="ViewManager.removeSplit"></a>
2309 <h4>ViewManager.removeSplit</h4> 2318 <h4>ViewManager.removeSplit</h4>
2310 <b>removeSplit</b>(<i></i>) 2319 <b>removeSplit</b>(<i></i>)
2311 <p> 2320 <p>
2312 Public method used to remove the current split view. 2321 Public method used to remove the current split view.
2313 </p><dl> 2322 </p><dl>
2406 file name of the editor (string) 2415 file name of the editor (string)
2407 </dd><dt><i>message</i></dt> 2416 </dd><dt><i>message</i></dt>
2408 <dd> 2417 <dd>
2409 command message to be sent (string) 2418 command message to be sent (string)
2410 </dd> 2419 </dd>
2420 </dl><a NAME="ViewManager.sendSharedEdit" ID="ViewManager.sendSharedEdit"></a>
2421 <h4>ViewManager.sendSharedEdit</h4>
2422 <b>sendSharedEdit</b>(<i></i>)
2423 <p>
2424 Public slot to end a shared edit session for the current editor and
2425 send the changes.
2426 </p><a NAME="ViewManager.setCooperationClient" ID="ViewManager.setCooperationClient"></a>
2427 <h4>ViewManager.setCooperationClient</h4>
2428 <b>setCooperationClient</b>(<i>client</i>)
2429 <p>
2430 Public method to set a reference to the cooperation client.
2431 </p><dl>
2432 <dt><i>client</i></dt>
2433 <dd>
2434 reference to the cooperation client (CooperationClient)
2435 </dd>
2411 </dl><a NAME="ViewManager.setEditorName" ID="ViewManager.setEditorName"></a> 2436 </dl><a NAME="ViewManager.setEditorName" ID="ViewManager.setEditorName"></a>
2412 <h4>ViewManager.setEditorName</h4> 2437 <h4>ViewManager.setEditorName</h4>
2413 <b>setEditorName</b>(<i>editor, newName</i>) 2438 <b>setEditorName</b>(<i>editor, newName</i>)
2414 <p> 2439 <p>
2415 Public method to change the displayed name of the editor. 2440 Public method to change the displayed name of the editor.
2499 <dt><i>orientation</i></dt> 2524 <dt><i>orientation</i></dt>
2500 <dd> 2525 <dd>
2501 orientation of the split 2526 orientation of the split
2502 (Qt.Horizontal or Qt.Vertical) 2527 (Qt.Horizontal or Qt.Vertical)
2503 </dd> 2528 </dd>
2529 </dl><a NAME="ViewManager.shareConnected" ID="ViewManager.shareConnected"></a>
2530 <h4>ViewManager.shareConnected</h4>
2531 <b>shareConnected</b>(<i>connected</i>)
2532 <p>
2533 Public slot to handle a change of the connected state.
2534 </p><dl>
2535 <dt><i>connected</i></dt>
2536 <dd>
2537 flag indicating the connected state (boolean)
2538 </dd>
2539 </dl><a NAME="ViewManager.shareEditor" ID="ViewManager.shareEditor"></a>
2540 <h4>ViewManager.shareEditor</h4>
2541 <b>shareEditor</b>(<i>share</i>)
2542 <p>
2543 Public slot to set the shared status of the current editor.
2544 </p><dl>
2545 <dt><i>share</i></dt>
2546 <dd>
2547 flag indicating the share status (boolean)
2548 </dd>
2504 </dl><a NAME="ViewManager.showDebugSource" ID="ViewManager.showDebugSource"></a> 2549 </dl><a NAME="ViewManager.showDebugSource" ID="ViewManager.showDebugSource"></a>
2505 <h4>ViewManager.showDebugSource</h4> 2550 <h4>ViewManager.showDebugSource</h4>
2506 <b>showDebugSource</b>(<i>fn, line</i>) 2551 <b>showDebugSource</b>(<i>fn, line</i>)
2507 <p> 2552 <p>
2508 Public method to open the given file and highlight the given line in it. 2553 Public method to open the given file and highlight the given line in it.
2527 </dl><dl> 2572 </dl><dl>
2528 <dt>Raises <b>RuntimeError</b>:</dt> 2573 <dt>Raises <b>RuntimeError</b>:</dt>
2529 <dd> 2574 <dd>
2530 Not implemented 2575 Not implemented
2531 </dd> 2576 </dd>
2532 </dl><a NAME="ViewManager.textForFind" ID="ViewManager.textForFind"></a> 2577 </dl><a NAME="ViewManager.startSharedEdit" ID="ViewManager.startSharedEdit"></a>
2578 <h4>ViewManager.startSharedEdit</h4>
2579 <b>startSharedEdit</b>(<i></i>)
2580 <p>
2581 Public slot to start a shared edit session for the current editor.
2582 </p><a NAME="ViewManager.textForFind" ID="ViewManager.textForFind"></a>
2533 <h4>ViewManager.textForFind</h4> 2583 <h4>ViewManager.textForFind</h4>
2534 <b>textForFind</b>(<i>getCurrentWord = True</i>) 2584 <b>textForFind</b>(<i>getCurrentWord = True</i>)
2535 <p> 2585 <p>
2536 Public method to determine the selection or the current word for the next 2586 Public method to determine the selection or the current word for the next
2537 find operation. 2587 find operation.

eric ide

mercurial