core

• common
  • actions
  • applocation
  • db
  • httputils
  • languagemanager
  • languages
  • openlpmixin
  • registry
  • registrymixin
  • registryproperties
  • settings
  • uistrings
  • versionchecker
• lib
  • db
  • exceptions
  • filedialog
  • formattingtags
  • htmlbuilder
  • imagemanager
  • mediamanageritem
  • plugin
  • pluginmanager
  • projector
  • renderer
  • screen
  • searchedit
  • serviceitem
  • settingstab
  • theme
  • ui
• resources
• ui
  • aboutdialog
  • aboutform
  • advancedtab
  • exceptiondialog
  • exceptionform
  • filerenamedialog
  • filerenameform
  • firsttimeform
  • firsttimelanguagedialog
  • firsttimelanguageform
  • firsttimewizard
  • formattingtagcontroller
  • formattingtagdialog
  • formattingtagform
  • generaltab
  • lib
  • maindisplay
  • mainwindow
  • media
  • projector
  • serviceitemeditdialog
  • serviceitemeditform
  • servicemanager
  • servicenoteform
  • settingsdialog
  • settingsform
  • shortcutlistdialog
  • shortcutlistform
  • slidecontroller
  • splashscreen
  • starttimedialog
  • starttimeform
  • themeform
  • themelayoutdialog
  • themelayoutform
  • thememanager
  • themestab
  • themewizard

The core module provides all core application functions

All the core functions of the OpenLP application including the GUI, settings, logging and a plugin framework are contained within the openlp.core module.

class openlp.core.OpenLP(*args, **kwargs)

Bases: openlp.core.common.openlpmixin.OpenLPMixin, PyQt5.QtWidgets.QApplication

The core application class. This class inherits from Qt’s QApplication class in order to provide the core of the application.

args = []

backup_on_upgrade(has_run_wizard, can_show_splash)

Check if OpenLP has been upgraded, and ask if a backup of data should be made

Parameters:

• has_run_wizard – OpenLP has been run before
• can_show_splash – Should OpenLP show the splash screen

event(event)

Enables platform specific event handling i.e. direct file opening on OS X

Parameters:event – The event

exec()

Override exec method to allow the shared memory to be released on exit

hook_exception(exc_type, value, traceback)

Add an exception hook so that any uncaught exceptions are displayed in this window rather than somewhere where users cannot see it and cannot report when we encounter these problems.

Parameters:

• exc_type – The class of exception.
• value – The actual exception object.
• traceback – A traceback object with the details of where the exception occurred.

is_already_running()

Look to see if OpenLP is already running and ask if a 2nd instance is to be started.

is_data_path_missing()

Check if the data folder path exists.

process_events()

Wrapper to make ProcessEvents visible and named correctly

run(args)

Run the OpenLP application.

Parameters:args – Some Args

set_busy_cursor()

Sets the Busy Cursor for the Application

set_normal_cursor()

Sets the Normal Cursor for the Application

openlp.core.main(args=None)

The main function which parses command line options and then runs

Parameters:args – Some args