Updated readme file and incremented version number in preparation for new release. Improved close operation if un-saved modifications exist.

Author: larspalo

CMakeLists.txt

@@ -19,7 +19,7 @@ cmake_minimum_required(VERSION 3.10)
 # Set the project name and info
 project(
   GOODF
-  VERSION 0.7.1
+  VERSION 0.7.2
   DESCRIPTION "GOODF - Software for creating and editing GrandOrgue ODFs"
   LANGUAGES CXX C
 )

README.md

@@ -13,10 +13,10 @@ Creation of an usable odf for GrandOrgue with GOODF fully works, though it's pos
 
 Note that the way to "save" the work done on an organ is by writing out the ODF (from file menu in the software or Ctrl+S), Save as is accomplished just by changing the organ definition file name. Since version 0.4 it's possible to also read/edit already existing .organ files. **However**, **be very mindful when using this feature!** It's possible that some bugs still exist that could potentially corrupt an ODF file. **Always work on copies or on files you don't mind having destroyed!** Also note that GOODF always will convert older type of .organ files to conform to the new panel format - *which means that older .organ files will be modified*! To ensure correct reading of (numerical) values from the .organ files, any leading or trailing whitespace as well as comments on the same line as a key/value pair will be stripped, even in the read source file! **Again, work on copies** as it's better to be safe than sorry. **You have been warned!** All that said, if you encounter problems that are repeatable, please report them as issues at https://github.com/larspalo/GOODF/issues so that the software might be improved.
 
-A basic rendering of the GUI panels is now possible, but it likely still needs more work before it's fully reliable and usable. Presently only the transparency of .png files are likely to work, the masks of .bmp files needs more work to implement. Possibility to adjust positioning of smaller images and GUI elements directly on the graphical rendering is implemented since 0.7. Changing order of switches is implemented with drag and drop in the tree, note that in GrandOrgue it's only possible for a switch to reference another switch with a lower number than itself. If you drag switches to other positions references can be invalidated and removed (only the reference is removed, not any switch). Re-ordering of many other elements is possible with drag and drop since version 0.7.1.
+Rendering of the GUI panels is now possible, but it likely needs more work before it's fully reliable. Possibility to adjust positioning of smaller images and GUI elements directly on the graphical rendering is implemented since 0.7 either with mouse or with arrow keys. Changing order of switches is implemented with drag and drop in the tree, note that in GrandOrgue it's only possible for a switch to reference another switch with a lower number than itself. If you drag switches to other positions references can be invalidated and removed (only the reference is removed, not any switch). Re-ordering of many other elements in the [Organ] tree with drag and drop can also be done.
 
 ## Future plans
-Testing the ability to both write and read .organ files will need to continue so that they both works really well without any bugs. The graphical rendering of panels most likely needs more work so that it should display the panels exactly like GrandOrgue will. Improving/implementing new ways to assign properties/references to multiple elements instead of doing it one at a time is on the wish list.
+Testing the ability to both write and read .organ files will need to continue so that they both works really well without any bugs. The graphical rendering of panels most likely still needs more work so that it should display the panels exactly like GrandOrgue will. Improving/implementing new ways to assign properties/references to multiple elements instead of doing it one at a time is on the wish list, this includes more flexible auto loading of pipes and copying options.
 
 ## Building from sources
 Normal development tools for c++ is needed as well as cmake, imagemagic and wxWidgets.

src/GOODFFrame.cpp

@@ -55,6 +55,7 @@ BEGIN_EVENT_TABLE(GOODFFrame, wxFrame)
 	EVT_BUTTON(ID_ADD_GENERAL_BTN, GOODFFrame::OnAddNewGeneral)
 	EVT_BUTTON(ID_ADD_REVERSIBLE_PISTON_BTN, GOODFFrame::OnAddNewReversiblePiston)
 	EVT_BUTTON(ID_ADD_PANEL_BTN, GOODFFrame::OnAddNewPanel)
+	EVT_CLOSE(GOODFFrame::OnClose)
 END_EVENT_TABLE()
 
 GOODFFrame::GOODFFrame(const wxString& title) : wxFrame(NULL, wxID_ANY, title) {
@@ -353,13 +354,54 @@ void GOODFFrame::OnHelp(wxCommandEvent& WXUNUSED(event)) {
 }
 
 void GOODFFrame::OnQuit(wxCommandEvent& WXUNUSED(event)) {
+	/*
+	if (m_organ->isModified()) {
+		// Ask if user wants to save/write the organ file
+		wxMessageDialog dlg(this, wxT("ODF file is modified. Do you want to save/write it?"), wxT("ODF file is modified"), wxYES_NO|wxCENTRE|wxICON_EXCLAMATION);
+		if (dlg.ShowModal() == wxID_YES) {
+			// Try triggering save/write by posting an event
+			wxCommandEvent evt(wxEVT_MENU, ID_WRITE_ODF);
+			wxPostEvent(this, evt);
+
+			if (m_organ->isModified()) {
+				// This means that the save failed, ask if the user wants to abort the quitting to fix the issue
+				wxMessageDialog confirmDlg(this, wxT("ODF file couldn't be saved/written! Do you want to return to fix it before quitting?"), wxT("ODF file couldn't be saved"), wxYES_NO|wxCENTRE|wxICON_ERROR);
+				if (confirmDlg.ShowModal() == wxID_YES) {
+					return;
+				}
+			}
+		}
+	} */
 	// Destroy the frame
 	Close();
 }
 
+void GOODFFrame::OnClose(wxCloseEvent& event) {
+	if (event.CanVeto() && m_organ->isModified()) {
+		// Ask if user wants to save/write the organ file
+		wxMessageDialog dlg(this, wxT("ODF file is modified. Do you want to save/write it?"), wxT("ODF file is modified"), wxYES_NO|wxCENTRE|wxICON_EXCLAMATION);
+		if (dlg.ShowModal() == wxID_YES) {
+			// Try triggering save/write by posting an event
+			wxCommandEvent evt(wxEVT_MENU, ID_WRITE_ODF);
+			wxPostEvent(this, evt);
+
+			if (m_organ->isModified()) {
+				// This means that the save failed, ask if the user wants to abort the quitting to fix the issue
+				wxMessageDialog confirmDlg(this, wxT("ODF file couldn't be saved/written! Do you want to return to fix it before quitting?"), wxT("ODF file couldn't be saved"), wxYES_NO|wxCENTRE|wxICON_ERROR);
+				if (confirmDlg.ShowModal() == wxID_YES) {
+					event.Veto();
+					return;
+				}
+			}
+		}
+	}
+	// Destroy the frame
+	Destroy();
+}
+
 void GOODFFrame::OnWriteODF(wxCommandEvent& WXUNUSED(event)) {
 	if (m_organPanel->getOdfPath().IsEmpty() || m_organPanel->getOdfName().IsEmpty()) {
-		wxMessageDialog incomplete(this, wxT("Path and name for ODF must be set!"), wxT("Cannot write ODF"), wxOK|wxCENTRE);
+		wxMessageDialog incomplete(this, wxT("Both path (location) and name for ODF must be set!"), wxT("Cannot write ODF"), wxOK|wxCENTRE);
 		incomplete.ShowModal();
 		return;
 	}

src/GOODFFrame.h

@@ -53,6 +53,7 @@ class GOODFFrame : public wxFrame {
 	~GOODFFrame();
 
 	void OnQuit(wxCommandEvent& event);
+	void OnClose(wxCloseEvent& event);
 	void OnAbout(wxCommandEvent& event);
 	void OnHelp(wxCommandEvent& event);
 	void OnWriteODF(wxCommandEvent& event);