Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.QtHelpDocumentationDialog.html

Documentation/Source/eric5.Helpviewer.QtHelpDocumentationDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.QtHelpDocumentationDialog</h1> 23 <h1>eric5.Helpviewer.QtHelpDocumentationDialog</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#109;&#97;&#110;&#97;&#103;&#101; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;. 25 Module implementing a dialog to manage the QtHelp documentation database.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td> 34 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#109;&#97;&#110;&#97;&#103;&#101; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td> 35 <td>Class implementing a dialog to manage the QtHelp documentation database.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a> 43 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a>
44 <h2>QtHelpDocumentationDialog</h2> 44 <h2>QtHelpDocumentationDialog</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#109;&#97;&#110;&#97;&#103;&#101; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;. 46 Class implementing a dialog to manage the QtHelp documentation database.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QDialog, Ui_QtHelpDocumentationDialog 49 QDialog, Ui_QtHelpDocumentationDialog
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> 57 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> 60 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td>
61 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#98;&#115; &#116;&#111; &#99;&#108;&#111;&#115;&#101;.</td> 61 <td>Public method to get the list of tabs to close.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td> 63 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td>
64 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#116;&#101;&#115;&#116; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#99;&#104;&#97;&#110;&#103;&#101;&#115;.</td> 64 <td>Public slot to test the dialog for changes.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td> 66 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td>
67 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#97;&#100;&#100; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#115; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td> 67 <td>Private slot to add documents to the help database.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> 69 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td>
70 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#110;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#115; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110;.</td> 70 <td>Private slot handling a change of the documents selection.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> 72 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
73 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#109;&#111;v&#101; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td> 73 <td>Private slot to remove a document from the help database.</td>
74 </tr> 74 </tr>
75 </table> 75 </table>
76 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> 76 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a>
77 <h4>QtHelpDocumentationDialog (Constructor)</h4> 77 <h4>QtHelpDocumentationDialog (Constructor)</h4>
78 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) 78 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>)
79 <p> 79 <p>
80 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 80 Constructor
81 </p><dl> 81 </p><dl>
82 <dt><i>engine</i></dt> 82 <dt><i>engine</i></dt>
83 <dd> 83 <dd>
84 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#101;&#110;&#103;&#105;&#110;&#101; (&#81;&#72;&#101;&#108;&#112;&#69;&#110;&#103;&#105;&#110;&#101;) 84 reference to the help engine (QHelpEngine)
85 </dd><dt><i>parent</i></dt> 85 </dd><dt><i>parent</i></dt>
86 <dd> 86 <dd>
87 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;) 87 reference to the parent widget (QWidget)
88 </dd> 88 </dd>
89 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> 89 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a>
90 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> 90 <h4>QtHelpDocumentationDialog.getTabsToClose</h4>
91 <b>getTabsToClose</b>(<i></i>) 91 <b>getTabsToClose</b>(<i></i>)
92 <p> 92 <p>
93 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#98;&#115; &#116;&#111; &#99;&#108;&#111;&#115;&#101;. 93 Public method to get the list of tabs to close.
94 </p><dl> 94 </p><dl>
95 <dt>Returns:</dt> 95 <dt>Returns:</dt>
96 <dd> 96 <dd>
97 &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#98; &#105;&#100;&#115; &#116;&#111; &#98;&#101; &#99;&#108;&#111;&#115;&#101;&#100; (&#108;&#105;&#115;&#116; &#111;&#102; &#105;&#110;&#116;&#101;&#103;&#101;&#114;&#115;) 97 list of tab ids to be closed (list of integers)
98 </dd> 98 </dd>
99 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a> 99 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a>
100 <h4>QtHelpDocumentationDialog.hasChanges</h4> 100 <h4>QtHelpDocumentationDialog.hasChanges</h4>
101 <b>hasChanges</b>(<i></i>) 101 <b>hasChanges</b>(<i></i>)
102 <p> 102 <p>
103 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#116;&#101;&#115;&#116; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#99;&#104;&#97;&#110;&#103;&#101;&#115;. 103 Public slot to test the dialog for changes.
104 </p><dl> 104 </p><dl>
105 <dt>Returns:</dt> 105 <dt>Returns:</dt>
106 <dd> 106 <dd>
107 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#112;&#114;&#101;&#115;&#101;&#110;&#99;&#101; &#111;&#102; &#99;&#104;&#97;&#110;&#103;&#101;&#115; 107 flag indicating presence of changes
108 </dd> 108 </dd>
109 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a> 109 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a>
110 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4> 110 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4>
111 <b>on_addButton_clicked</b>(<i></i>) 111 <b>on_addButton_clicked</b>(<i></i>)
112 <p> 112 <p>
113 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#97;&#100;&#100; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#115; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;. 113 Private slot to add documents to the help database.
114 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> 114 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a>
115 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> 115 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4>
116 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) 116 <b>on_documentsList_itemSelectionChanged</b>(<i></i>)
117 <p> 117 <p>
118 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#110;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#115; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110;. 118 Private slot handling a change of the documents selection.
119 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a> 119 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a>
120 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4> 120 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4>
121 <b>on_removeButton_clicked</b>(<i></i>) 121 <b>on_removeButton_clicked</b>(<i></i>)
122 <p> 122 <p>
123 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#109;&#111;v&#101; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;. 123 Private slot to remove a document from the help database.
124 </p> 124 </p>
125 <div align="right"><a href="#top">Up</a></div> 125 <div align="right"><a href="#top">Up</a></div>
126 <hr /> 126 <hr />
127 </body></html> 127 </body></html>

Mercurial Repository: eric

eric ide

mercurial