raoul/openlp
1
0
Fork 0
forked from openlp/openlp
Code Issues Pull Requests Projects Releases Wiki Activity

Add more docstrings

Browse Source
This commit is contained in:
Arjan Schrijver 2013-03-18 14:43:45 +01:00
parent 50da75cfdb
commit 185754f9b5
2 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
openlp/plugins/images/forms/addgroupform.py
View File

@ -36,7 +36,7 @@ from openlp.plugins.images.forms.addgroupdialog import Ui_AddGroupDialog
class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog): class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog):
""" """
Class documentation goes here. This class implements the 'Add group' form for the Images plugin.
""" """
def __init__(self, parent=None): def __init__(self, parent=None):
""" """
@ -46,6 +46,18 @@ class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog):
self.setupUi(self) self.setupUi(self)
def exec_(self, clear=True, show_top_level_group=False, selected_group=None): def exec_(self, clear=True, show_top_level_group=False, selected_group=None):
"""
Show the form
``clear``
Set to False if the text input box should not be cleared when showing the dialog (default: True)
``show_top_level_group``
Set to True when "-- Top level group --" should be showed as first item (default: False)
``selected_group``
The ID of the group that should be selected by default when showing the dialog
"""
if clear: if clear:
self.name_edit.clear() self.name_edit.clear()
self.name_edit.setFocus() self.name_edit.setFocus()
@ -59,6 +71,9 @@ class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog):
return QtGui.QDialog.exec_(self) return QtGui.QDialog.exec_(self)
def accept(self): def accept(self):
"""
Override the accept() method from QDialog to make sure something is entered in the text input box
"""
if not self.name_edit.text(): if not self.name_edit.text():
critical_error_message_box(message=translate('ImagePlugin.AddGroupForm', critical_error_message_box(message=translate('ImagePlugin.AddGroupForm',
'You need to type in a group name.')) 'You need to type in a group name.'))

8
openlp/plugins/images/forms/choosegroupform.py
View File

@ -34,7 +34,7 @@ from openlp.plugins.images.forms.choosegroupdialog import Ui_ChooseGroupDialog
class ChooseGroupForm(QtGui.QDialog, Ui_ChooseGroupDialog): class ChooseGroupForm(QtGui.QDialog, Ui_ChooseGroupDialog):
""" """
Class documentation goes here. This class implements the 'Choose group' form for the Images plugin.
""" """
def __init__(self, parent=None): def __init__(self, parent=None):
""" """
@ -44,6 +44,12 @@ class ChooseGroupForm(QtGui.QDialog, Ui_ChooseGroupDialog):
self.setupUi(self) self.setupUi(self)
def exec_(self, selected_group=None): def exec_(self, selected_group=None):
"""
Show the form
``selected_group``
The ID of the group that should be selected by default when showing the dialog
"""
if selected_group is not None: if selected_group is not None:
for i in range(self.group_combobox.count()): for i in range(self.group_combobox.count()):
if self.group_combobox.itemData(i) == selected_group: if self.group_combobox.itemData(i) == selected_group: