songsplugin

The songsplugin module contains the Plugin class for the Songs plugin.

class openlp.plugins.songs.songsplugin.SongsPlugin

Bases: openlp.core.lib.plugin.Plugin

This plugin enables the user to create, edit and display songs. Songs are divided into verses, and the verse order can be specified. Authors, topics and song books can be assigned to songs as well.

static about()

Provides information for the plugin manager to display.

Returns:A translatable string with some basic information about the Songs plugin

add_export_menu_item(export_menu)

Give the Songs plugin the opportunity to add items to the Export menu.

Parameters:export_menu – The actual Export menu item, so that your actions can use it as their parent.

add_import_menu_item(import_menu)

Give the Songs plugin the opportunity to add items to the Import menu.

Parameters:import_menu – The actual Import menu item, so that your actions can use it as their parent.

add_tools_menu_item(tools_menu)

Give the Songs plugin the opportunity to add items to the Tools menu.

Parameters:tools_menu – The actual Tools menu item, so that your actions can use it as their parent.

check_pre_conditions()

Check the plugin can run.

finalise()

Time to tidy up on exit

first_time()

If the first time wizard has run, this function is run to import all the new songs into the database.

import_songs(import_format, **kwargs)

Add the correct importer class

Parameters:

• import_format – The import_format to be used
• kwargs – The arguments

Returns:

the correct importer

initialise()

Initialise the plugin

new_service_created()

Remove temporary songs from the database

on_import_songselect_item_triggered()

Run the SongSelect importer.

on_song_export_item_clicked()

Run the song export wizard.

on_song_import_item_clicked()

Run the song import wizard.

on_tools_find_duplicates_triggered()

Search for duplicates in the song database.

on_tools_reindex_item_triggered()

Rebuild each song.

static on_tools_report_song_list_triggered()

rename_theme(old_theme, new_theme)

Renames a theme the song plugin is using making the plugin use the new name.

Parameters:

• old_theme – The name of the theme the plugin should stop using.
• new_theme – The new name the plugin should now use.

set_plugin_text_strings()

Called to define all translatable texts of the plugin

uses_theme(theme)

Called to find out if the song plugin is currently using a theme.

Parameters:theme – The theme to check for usage Returns:count of the number of times the theme is used.