E5Gui/E5ToolBarDialog.py

changeset 2953
703452a2876f
parent 2763
e4794166ad70
child 2990
583beaf0b4b8
diff -r 94fc661a54a2 -r 703452a2876f E5Gui/E5ToolBarDialog.py
--- a/E5Gui/E5ToolBarDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/E5Gui/E5ToolBarDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -151,7 +151,7 @@
     @pyqtSlot()
     def on_removeButton_clicked(self):
         """
-        Private slot to remove a custom toolbar
+        Private slot to remove a custom toolbar.
         """
         name = self.toolbarComboBox.currentText()
         res = E5MessageBox.yesNo(self,
@@ -253,13 +253,21 @@
     def on_actionsTree_currentItemChanged(self, current, previous):
         """
         Private slot called, when the currently selected action changes.
+        
+        @param current reference to the current item (QTreeWidgetItem)
+        @param previous reference to the previous current item
+            (QTreeWidgetItem)
         """
         self.__setupButtons()
     
     @pyqtSlot(QListWidgetItem, QListWidgetItem)
     def on_toolbarActionsList_currentItemChanged(self, current, previous):
         """
-        Slot documentation goes here.
+        Private slot to handle a change of the current item.
+        
+        @param current reference to the current item (QListWidgetItem)
+        @param previous reference to the previous current item
+            (QListWidgetItem)
         """
         self.__setupButtons()
     
@@ -358,6 +366,8 @@
     def on_buttonBox_clicked(self, button):
         """
         Private slot called, when a button of the button box was clicked.
+        
+        @param button reference to the button clicked (QAbstractButton)
         """
         if button == self.buttonBox.button(QDialogButtonBox.Cancel):
             self.reject()
@@ -377,6 +387,8 @@
     def __saveToolBars(self):
         """
         Private method to save the configured toolbars.
+        
+        @exception RuntimeError raised to indicate an invalid action
         """
         # step 1: remove toolbars marked for deletion
         for tbID in self.__removedToolBarIDs:

eric ide

mercurial