songexportform¶

The songexportform module provides the wizard for exporting songs to the OpenLyrics format.

class openlp.plugins.songs.forms.songexportform.SongExportForm(parent, plugin)[source]¶

Bases: openlp.core.ui.lib.wizard.OpenLPWizard

This is the Song Export Wizard, which allows easy exporting of Songs to the OpenLyrics format.

add_custom_pages()[source]¶: Add song wizard specific pages.

custom_signals()[source]¶: Song wizard specific signals.

on_check_button_clicked()[source]¶: The check_button has been clicked. Set all visible songs checked.

on_directory_button_clicked()[source]¶: Called when the directory_button was clicked. Opens a dialog and writes the path to directory_line_edit.

on_search_line_edit_changed(text)[source]¶

The search_line_edit’s text has been changed. Update the list of available songs. Note that any song, which does not match the text will be hidden, but not unchecked!

Parameters:	text – The text of the search_line_edit.

on_uncheck_button_clicked()[source]¶: The uncheck_button has been clicked. Set all visible songs unchecked.

perform_wizard()[source]¶: Perform the actual export. This creates an openlyricsexport instance and calls the do_export method.

pre_wizard()[source]¶: Perform pre export tasks.

retranslateUi()[source]¶: Song wizard localisation.

set_defaults()[source]¶: Set default form values for the song export wizard.

setupUi(image)[source]¶: Set up the song wizard UI.

stop_export()[source]¶: Sets the flag for the exporter to stop the export.

validateCurrentPage()[source]¶: Validate the current page before moving on to the next page.

openlp.plugins.songs.forms.songexportform.find_list_widget_items(list_widget, text='')[source]¶

Returns a list of *QListWidgetItem*s of the list_widget. Note, that hidden items are included.

Parameters:	list_widget – The widget to get all items from. (QListWidget) text – The text to search for. (unicode string)

openlp.plugins.songs.forms.songexportform.on_item_activated(item)[source]¶

Called, when an item in the available_list_widget has been triggered. The item is check if it was not checked, whereas it is unchecked when it was checked.

Parameters:	item – The QListWidgetItem which was triggered.