Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.E4Gui.E4ToolBarDialog.html

Documentation/Source/eric4.E4Gui.E4ToolBarDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.E4Gui.E4ToolBarDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.E4Gui.E4ToolBarDialog</h1>
24 <p>
25 Module implementing a toolbar configuration dialog.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#E4ToolBarDialog">E4ToolBarDialog</a></td>
35 <td>Class implementing a toolbar configuration dialog.</td>
36 </tr><tr>
37 <td><a href="#E4ToolBarItem">E4ToolBarItem</a></td>
38 <td>Class storing data belonging to a toolbar entry of the toolbar dialog.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="E4ToolBarDialog" ID="E4ToolBarDialog"></a>
47 <h2>E4ToolBarDialog</h2>
48 <p>
49 Class implementing a toolbar configuration dialog.
50 </p>
51 <h3>Derived from</h3>
52 QDialog, Ui_E4ToolBarDialog
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>ActionIdRole</td></tr><tr><td>WidgetActionRole</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#E4ToolBarDialog.__init__">E4ToolBarDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#E4ToolBarDialog.__resetCurrentToolbar">__resetCurrentToolbar</a></td>
64 <td>Private method to revert all changes made to the current toolbar.</td>
65 </tr><tr>
66 <td><a href="#E4ToolBarDialog.__restoreCurrentToolbar">__restoreCurrentToolbar</a></td>
67 <td>Private methdo to restore the current toolbar to the given list of actions.</td>
68 </tr><tr>
69 <td><a href="#E4ToolBarDialog.__restoreCurrentToolbarToDefault">__restoreCurrentToolbarToDefault</a></td>
70 <td>Private method to set the current toolbar to it's default configuration.</td>
71 </tr><tr>
72 <td><a href="#E4ToolBarDialog.__saveToolBars">__saveToolBars</a></td>
73 <td>Private method to save the configured toolbars.</td>
74 </tr><tr>
75 <td><a href="#E4ToolBarDialog.__setupButtons">__setupButtons</a></td>
76 <td>Private slot to set the buttons state.</td>
77 </tr><tr>
78 <td><a href="#E4ToolBarDialog.__toolbarComboBox_currentIndexChanged">__toolbarComboBox_currentIndexChanged</a></td>
79 <td>Private slot called upon a selection of the current toolbar.</td>
80 </tr><tr>
81 <td><a href="#E4ToolBarDialog.on_actionsTree_currentItemChanged">on_actionsTree_currentItemChanged</a></td>
82 <td>Private slot called, when the currently selected action changes.</td>
83 </tr><tr>
84 <td><a href="#E4ToolBarDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
85 <td>Private slot called, when a button of the button box was clicked.</td>
86 </tr><tr>
87 <td><a href="#E4ToolBarDialog.on_downButton_clicked">on_downButton_clicked</a></td>
88 <td>Private slot used to move an action down in the list.</td>
89 </tr><tr>
90 <td><a href="#E4ToolBarDialog.on_leftButton_clicked">on_leftButton_clicked</a></td>
91 <td>Private slot to delete an action from the list.</td>
92 </tr><tr>
93 <td><a href="#E4ToolBarDialog.on_newButton_clicked">on_newButton_clicked</a></td>
94 <td>Private slot to create a new toolbar.</td>
95 </tr><tr>
96 <td><a href="#E4ToolBarDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
97 <td>Private slot to remove a custom toolbar</td>
98 </tr><tr>
99 <td><a href="#E4ToolBarDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
100 <td>Private slot to rename a custom toolbar.</td>
101 </tr><tr>
102 <td><a href="#E4ToolBarDialog.on_rightButton_clicked">on_rightButton_clicked</a></td>
103 <td>Private slot to add an action to the list.</td>
104 </tr><tr>
105 <td><a href="#E4ToolBarDialog.on_toolbarActionsList_currentItemChanged">on_toolbarActionsList_currentItemChanged</a></td>
106 <td>Slot documentation goes here.</td>
107 </tr><tr>
108 <td><a href="#E4ToolBarDialog.on_upButton_clicked">on_upButton_clicked</a></td>
109 <td>Private slot used to move an action up in the list.</td>
110 </tr>
111 </table>
112 <a NAME="E4ToolBarDialog.__init__" ID="E4ToolBarDialog.__init__"></a>
113 <h4>E4ToolBarDialog (Constructor)</h4>
114 <b>E4ToolBarDialog</b>(<i>toolBarManager, parent = None</i>)
115 <p>
116 Constructor
117 </p><dl>
118 <dt><i>toolBarManager</i></dt>
119 <dd>
120 reference to a toolbar manager object (E4ToolBarManager)
121 </dd><dt><i>parent</i></dt>
122 <dd>
123 reference to the parent widget (QWidget)
124 </dd>
125 </dl><a NAME="E4ToolBarDialog.__resetCurrentToolbar" ID="E4ToolBarDialog.__resetCurrentToolbar"></a>
126 <h4>E4ToolBarDialog.__resetCurrentToolbar</h4>
127 <b>__resetCurrentToolbar</b>(<i></i>)
128 <p>
129 Private method to revert all changes made to the current toolbar.
130 </p><a NAME="E4ToolBarDialog.__restoreCurrentToolbar" ID="E4ToolBarDialog.__restoreCurrentToolbar"></a>
131 <h4>E4ToolBarDialog.__restoreCurrentToolbar</h4>
132 <b>__restoreCurrentToolbar</b>(<i>actions</i>)
133 <p>
134 Private methdo to restore the current toolbar to the given list of actions.
135 </p><dl>
136 <dt><i>actions</i></dt>
137 <dd>
138 list of actions to set for the current toolbar (list of QAction)
139 </dd>
140 </dl><a NAME="E4ToolBarDialog.__restoreCurrentToolbarToDefault" ID="E4ToolBarDialog.__restoreCurrentToolbarToDefault"></a>
141 <h4>E4ToolBarDialog.__restoreCurrentToolbarToDefault</h4>
142 <b>__restoreCurrentToolbarToDefault</b>(<i></i>)
143 <p>
144 Private method to set the current toolbar to it's default configuration.
145 </p><a NAME="E4ToolBarDialog.__saveToolBars" ID="E4ToolBarDialog.__saveToolBars"></a>
146 <h4>E4ToolBarDialog.__saveToolBars</h4>
147 <b>__saveToolBars</b>(<i></i>)
148 <p>
149 Private method to save the configured toolbars.
150 </p><a NAME="E4ToolBarDialog.__setupButtons" ID="E4ToolBarDialog.__setupButtons"></a>
151 <h4>E4ToolBarDialog.__setupButtons</h4>
152 <b>__setupButtons</b>(<i></i>)
153 <p>
154 Private slot to set the buttons state.
155 </p><a NAME="E4ToolBarDialog.__toolbarComboBox_currentIndexChanged" ID="E4ToolBarDialog.__toolbarComboBox_currentIndexChanged"></a>
156 <h4>E4ToolBarDialog.__toolbarComboBox_currentIndexChanged</h4>
157 <b>__toolbarComboBox_currentIndexChanged</b>(<i>index</i>)
158 <p>
159 Private slot called upon a selection of the current toolbar.
160 </p><dl>
161 <dt><i>index</i></dt>
162 <dd>
163 index of the new current toolbar (integer)
164 </dd>
165 </dl><a NAME="E4ToolBarDialog.on_actionsTree_currentItemChanged" ID="E4ToolBarDialog.on_actionsTree_currentItemChanged"></a>
166 <h4>E4ToolBarDialog.on_actionsTree_currentItemChanged</h4>
167 <b>on_actionsTree_currentItemChanged</b>(<i>current, previous</i>)
168 <p>
169 Private slot called, when the currently selected action changes.
170 </p><a NAME="E4ToolBarDialog.on_buttonBox_clicked" ID="E4ToolBarDialog.on_buttonBox_clicked"></a>
171 <h4>E4ToolBarDialog.on_buttonBox_clicked</h4>
172 <b>on_buttonBox_clicked</b>(<i>button</i>)
173 <p>
174 Private slot called, when a button of the button box was clicked.
175 </p><a NAME="E4ToolBarDialog.on_downButton_clicked" ID="E4ToolBarDialog.on_downButton_clicked"></a>
176 <h4>E4ToolBarDialog.on_downButton_clicked</h4>
177 <b>on_downButton_clicked</b>(<i></i>)
178 <p>
179 Private slot used to move an action down in the list.
180 </p><a NAME="E4ToolBarDialog.on_leftButton_clicked" ID="E4ToolBarDialog.on_leftButton_clicked"></a>
181 <h4>E4ToolBarDialog.on_leftButton_clicked</h4>
182 <b>on_leftButton_clicked</b>(<i></i>)
183 <p>
184 Private slot to delete an action from the list.
185 </p><a NAME="E4ToolBarDialog.on_newButton_clicked" ID="E4ToolBarDialog.on_newButton_clicked"></a>
186 <h4>E4ToolBarDialog.on_newButton_clicked</h4>
187 <b>on_newButton_clicked</b>(<i></i>)
188 <p>
189 Private slot to create a new toolbar.
190 </p><a NAME="E4ToolBarDialog.on_removeButton_clicked" ID="E4ToolBarDialog.on_removeButton_clicked"></a>
191 <h4>E4ToolBarDialog.on_removeButton_clicked</h4>
192 <b>on_removeButton_clicked</b>(<i></i>)
193 <p>
194 Private slot to remove a custom toolbar
195 </p><a NAME="E4ToolBarDialog.on_renameButton_clicked" ID="E4ToolBarDialog.on_renameButton_clicked"></a>
196 <h4>E4ToolBarDialog.on_renameButton_clicked</h4>
197 <b>on_renameButton_clicked</b>(<i></i>)
198 <p>
199 Private slot to rename a custom toolbar.
200 </p><a NAME="E4ToolBarDialog.on_rightButton_clicked" ID="E4ToolBarDialog.on_rightButton_clicked"></a>
201 <h4>E4ToolBarDialog.on_rightButton_clicked</h4>
202 <b>on_rightButton_clicked</b>(<i></i>)
203 <p>
204 Private slot to add an action to the list.
205 </p><a NAME="E4ToolBarDialog.on_toolbarActionsList_currentItemChanged" ID="E4ToolBarDialog.on_toolbarActionsList_currentItemChanged"></a>
206 <h4>E4ToolBarDialog.on_toolbarActionsList_currentItemChanged</h4>
207 <b>on_toolbarActionsList_currentItemChanged</b>(<i>current, previous</i>)
208 <p>
209 Slot documentation goes here.
210 </p><a NAME="E4ToolBarDialog.on_upButton_clicked" ID="E4ToolBarDialog.on_upButton_clicked"></a>
211 <h4>E4ToolBarDialog.on_upButton_clicked</h4>
212 <b>on_upButton_clicked</b>(<i></i>)
213 <p>
214 Private slot used to move an action up in the list.
215 </p>
216 <div align="right"><a href="#top">Up</a></div>
217 <hr /><hr />
218 <a NAME="E4ToolBarItem" ID="E4ToolBarItem"></a>
219 <h2>E4ToolBarItem</h2>
220 <p>
221 Class storing data belonging to a toolbar entry of the toolbar dialog.
222 </p>
223 <h3>Derived from</h3>
224 object
225 <h3>Class Attributes</h3>
226 <table>
227 <tr><td>None</td></tr>
228 </table>
229 <h3>Methods</h3>
230 <table>
231 <tr>
232 <td><a href="#E4ToolBarItem.__init__">E4ToolBarItem</a></td>
233 <td>Constructor</td>
234 </tr>
235 </table>
236 <a NAME="E4ToolBarItem.__init__" ID="E4ToolBarItem.__init__"></a>
237 <h4>E4ToolBarItem (Constructor)</h4>
238 <b>E4ToolBarItem</b>(<i>toolBarId, actionIDs, default</i>)
239 <p>
240 Constructor
241 </p><dl>
242 <dt><i>toolBarId</i></dt>
243 <dd>
244 id of the toolbar object (integer)
245 </dd><dt><i>actionIDs</i></dt>
246 <dd>
247 list of action IDs belonging to the toolbar (list of integer)
248 </dd><dt><i>default</i></dt>
249 <dd>
250 flag indicating a default toolbar (boolean)
251 </dd>
252 </dl>
253 <div align="right"><a href="#top">Up</a></div>
254 <hr />
255 </body></html>

Mercurial Repository: eric

eric ide

mercurial