Process::ProjectFilesApplicationPlugin Class Reference

Inheritance diagram for Process::ProjectFilesApplicationPlugin:

Detailed Description

Adds the project file-management entries to the File menu, and tells the user when a document it just loaded is missing some of its media.

Public Member Functions
	ProjectFilesApplicationPlugin (const score::GUIApplicationContext &ctx)
score::GUIElements	makeGUIElements () override
	makeGUIElements
void	on_loadedDocument (score::Document &doc) override
	on_loadedDocument Will be called only after a document has been loaded
void	on_documentSaveAs (score::Document &doc, const QString &newFileName) override
	on_documentSaveAs Called just before a document is written to newFileName, while it still knows where it used to live.
Public Member Functions inherited from score::GUIApplicationPlugin
	GUIApplicationPlugin (const score::GUIApplicationContext &presenter)
virtual void	initialize ()
	initialize
Document *	currentDocument () const
	currentDocument
virtual bool	handleLoading ()
	afterStartup Returns true if the start-up was handled by this plug-in.
virtual void	afterStartup ()
	afterStartup Called after all the documents have been created / loaded
virtual void	on_initDocument (score::Document &doc)
	on_initDocument Will be called after the document has been created, for new, load, and restore, and before anything is loaded.
virtual void	on_closeDocument (score::Document &doc)
	on_closeDocument Will be called before closing the document.
virtual void	on_newDocument (score::Document &doc)
	on_newDocument Will be called only when a new, empty document is created; classes inheriting from SerializableDocumentPlugin should be instantiated and added to the document at this point.
virtual void	on_createdDocument (score::Document &doc)
	on_createdDocument Will be called after either on_newDocument or on_loadedDocument was called on every plug-in.
virtual void	prepareNewDocument ()
	prepareNewDocument Will be called just before a document switch. It is possible to check if we are in the process of document switching via DocumentManager::preparingNewDocument.
virtual void	on_documentChanged (score::Document *olddoc, score::Document *newdoc)
	on_documentChanged Will be called after a document switch. If newdoc isn't null, it means that it is currently being focused by score.
virtual void	on_activeWindowChanged ()
	on_activeWindowChanged Can be used to check if the focus moves out of the main window.
virtual void	on_keyPressEvent (QKeyEvent &event)
	on_keyPressEvent Called with key events in the main document view.
virtual void	on_keyReleaseEvent (QKeyEvent &event)
	on_keyPressEvent Called with key events in the main document view.

Additional Inherited Members
Public Types inherited from score::GUIApplicationPlugin
using	GUIElements = score::GUIElements
Public Attributes inherited from score::GUIApplicationPlugin
const GUIApplicationContext &	context

Member Function Documentation

makeGUIElements()

score::GUIElements Process::ProjectFilesApplicationPlugin::makeGUIElements ( )

overridevirtual

makeGUIElements

This function allows a plug-in to provide custom elements to put in toolbars, menus, etc.

When returned here, they will afterwards be available through an score::ApplicationContext.

See also

score::GUIElements

Reimplemented from score::GUIApplicationPlugin.

on_documentSaveAs()

void Process::ProjectFilesApplicationPlugin::on_documentSaveAs ( score::Document &  doc, const QString &  newFileName  )

overridevirtual

on_documentSaveAs Called just before a document is written to newFileName, while it still knows where it used to live.

This is the moment at which everything the document stores relatively to its own folder becomes wrong – media paths above all – so it is the moment to either re-anchor those references or collect what they point at. Doing it here rather than after the save means the very same serialization writes the corrected document out.

Reimplemented from score::GUIApplicationPlugin.

on_loadedDocument()

void Process::ProjectFilesApplicationPlugin::on_loadedDocument ( score::Document &  doc )

overridevirtual

on_loadedDocument Will be called only after a document has been loaded

Reimplemented from score::GUIApplicationPlugin.

---

The documentation for this class was generated from the following file:

• ProjectFilesApplicationPlugin.hpp