Fix: unified ObservingLists dialog

guide/ch_tour.tex

@@ -308,18 +308,26 @@ \section{Observing Lists (Bookmarks)}
 
 The list display shows all entries from the current list. A double
 click on an entry selects the object.  To add an object to the list,
-press \menu{Edit list}. This opens another view. Highlight (select)
+press \menu{Edit list}. This changes the view. Highlight (select)
 your object in the sky and press \menu{Add object}. To remove an
 object from a list, select its entry in the list and press
-\menu{Remove object}. You can also export a list with the according
-button.
+\menu{Remove object}. 
 
-Sometimes the object alone is not enough. Interesting views like
+Sometimes storing the object alone is not enough. Interesting views like
 planet conjunctions or eclipses require at least a time entry, if not
 a particular location. Likewise, the displayed landscape may be nice
-to adapt. Additionally, the field of view may be relevant. To store
+to restore. Additionally, the field of view may be relevant. To store
 these data and later retrieve them, use the respective checkboxes.
 
+You can also export the current list with the according
+button, or import such an exported list on another system. Lists are identified with an 
+Universally Unique Identifier (UUID) which we call OLUD (Observing List Unique Identifier). 
+On importing a list, existing lists with the same OLUD may be replaced after a warning. 
+During editing, storing a list with an existing name is prevented. 
+The list import may however import a list with an existing name as long as the OLUD is different. 
+To transfer all your lists to another system, copy, rename and import 
+(or just copy, to replace the existing) the full file \file{observingLists.json} 
+from the \file{data/} subdirectory of your user directory (see section~\ref{sec:Directories}).
 
 
 \section{Custom Markers}

src/CMakeLists.txt

@@ -356,9 +356,6 @@ IF(STELLARIUM_GUI_MODE STREQUAL "Standard")
           gui/AstroCalcChart.cpp
           gui/ObsListDialog.hpp
           gui/ObsListDialog.cpp
-          gui/ObsListCreateEditDialog.hpp
-          gui/ObsListCreateEditDialog.cpp
-          gui/ObservingListCommon.hpp
           gui/StelDialog.hpp
           gui/StelDialog_p.hpp
           gui/StelDialog.cpp
@@ -392,7 +389,6 @@ IF(STELLARIUM_GUI_MODE STREQUAL "Standard")
           gui/astroCalcExtraEphemerisDialog.ui
           gui/astroCalcCustomStepsDialog.ui
           gui/obsListDialog.ui
-          gui/obsListCreateEditDialog.ui
           gui/addRemoveLandscapesDialog.ui
           gui/dsoColorsDialog.ui
           gui/orbitColorsDialog.ui

src/core/StelObject.hpp

@@ -159,7 +159,10 @@ class StelObject : public StelRegionObject
 	//! Return object's type. It should be the name of the class.
 	virtual QString getType() const = 0;
 
-	//! Return object's type. It should be English lowercase name of the type of the object.
+	//! Return object's type. It should be English lowercase name of the astronomical type of the object.
+	//! The purpose of this string is a distinction or further refinement over object class name retrieved with getType():
+	//! Planet objects can be planets, moons, or even the Sun. The Sun should however return "star".
+	//! Nebula objects should return their actual type like "open cluster", "galaxy", "nebula", ...
 	virtual QString getObjectType() const = 0;
 	//! Return object's type. It should be translated lowercase name of the type of the object.
 	virtual QString getObjectTypeI18n() const = 0;

src/core/StelObjectMgr.cpp

@@ -408,10 +408,10 @@ bool StelObjectMgr::findAndSelectI18n(const QString &nameI18n, StelModule::StelM
 		return setSelectedObject(obj, action);
 }
 
-bool StelObjectMgr::findAndSelectI18n(const QString &name, const QString &objtype, StelModule::StelModuleSelectAction action)
+bool StelObjectMgr::findAndSelectI18n(const QString &nameI18n, const QString &objtype, StelModule::StelModuleSelectAction action)
 {
 	// Then look for another object
-	StelObjectP obj = searchByNameI18n(name, objtype);
+	StelObjectP obj = searchByNameI18n(nameI18n, objtype);
 	if (!obj)
 		return false;
 	else

src/core/StelObjectMgr.hpp

@@ -73,23 +73,23 @@ class StelObjectMgr : public StelModule
 	//! @return true if a object with the passed name was found
 	bool findAndSelectI18n(const QString &nameI18n, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection);
 
-	//! Find and select an object from its translated name and object type name.
+	//! Find and select an object from its translated name and object type name (i.e., the Stellarium class name).
 	//! @param action define whether to add to, replace, or remove from the existing selection
 	//! @param nameI18n the case sensitive object translated name
-	//! @param objtype the type of the object
+	//! @param objtype the type of the object (i.e., the Stellarium class name)
 	//! @return true if a object with the passed name was found
-	bool findAndSelectI18n(const QString &name, const QString &objtype, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection);
+	bool findAndSelectI18n(const QString &nameI18n, const QString &objtype, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection);
 
 	//! Find and select an object from its standard program name.
 	//! @param action define whether to add to, replace, or remove from the existing selection
 	//! @param name the case sensitive object translated name
 	//! @return true if a object with the passed name was found
 	bool findAndSelect(const QString &name, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection);
 
-	//! Find and select an object from its standard program name and object type name.
+	//! Find and select an object from its standard program name and object type name (i.e., the Stellarium class name).
 	//! @param action define whether to add to, replace, or remove from the existing selection
 	//! @param name the case sensitive object translated name
-	//! @param objtype the type of the object
+	//! @param objtype the type of the object (i.e., the Stellarium class name)
 	//! @return true if a object with the passed name was found
 	bool findAndSelect(const QString &name, const QString &objtype, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection);
 

src/core/modules/Nebula.cpp

@@ -259,9 +259,9 @@ QString Nebula::getInfoString(const StelCore *core, const InfoStringGroup& flags
 	{
 		QString mt = getMorphologicalTypeString();
 		if (mt.isEmpty())
-			oss << QString("%1: <b>%2</b>").arg(q_("Type"), getTypeString()) << "<br>";
+			oss << QString("%1: <b>%2</b>").arg(q_("Type"), getObjectTypeI18n()) << "<br>";
 		else
-			oss << QString("%1: <b>%2</b> (%3)").arg(q_("Type"), getTypeString(), mt) << "<br>";
+			oss << QString("%1: <b>%2</b> (%3)").arg(q_("Type"), getObjectTypeI18n(), mt) << "<br>";
 		oss << getExtraInfoStrings(ObjectType).join("");
 	}
 
@@ -444,7 +444,7 @@ QVariantMap Nebula::getInfoMap(const StelCore *core) const
 {
 	QVariantMap map = StelObject::getInfoMap(core);
 
-	map["type"]=getTypeString(); // replace "Nebula" type by detail. This is localized. Maybe add argument such as getTypeString(bool translated=true)?
+	map["type"]=getObjectTypeI18n(); // replace "Nebula" type by detail. This is localized.
 	map.insert("morpho", getMorphologicalTypeString());
 	map.insert("surface-brightness", getSurfaceBrightness(core));
 	map.insert("designations", withoutID ? QString() : designations.join(" - "));
@@ -1414,7 +1414,7 @@ QString Nebula::getMorphologicalTypeDescription(void) const
 	return r;
 }
 
-QString Nebula::getTypeString(Nebula::NebulaType nType)
+QString Nebula::getTypeStringI18n(Nebula::NebulaType nType)
 {
 	return q_(typeEnglishStringMap.value(nType, q_("undocumented type")));
 }

src/core/modules/Nebula.hpp

@@ -175,7 +175,7 @@ friend class NebulaMgr;
 	}
 	virtual QString getObjectTypeI18n() const Q_DECL_OVERRIDE
 	{
-		return getTypeString();
+		return q_(typeEnglishStringMap.value(nType, q_("undocumented type")));
 	}
 	virtual QString getID() const Q_DECL_OVERRIDE {return getDSODesignation(); } //this depends on the currently shown catalog flags, should this be changed?
 	virtual Vec3d getJ2000EquatorialPos(const StelCore* core) const Q_DECL_OVERRIDE;
@@ -194,10 +194,10 @@ friend class NebulaMgr;
 	void setLabelColor(const Vec3f& v) {labelColor = v;}
 	// void setCircleColor(const Vec3f& v) {hintColorMap.insert(NebUnknown, v);}
 
-	//! Get the printable nebula Type.
-	//! @return the nebula type code.
-	QString getTypeString() const {return getTypeString(nType);}
-	static QString getTypeString(Nebula::NebulaType nType);
+	//! Get the printable localized nebula Type for @arg nType.
+	//! @return the localized nebula type code.
+	//! @note for actual objects, use getObjectTypeI18n()
+	static QString getTypeStringI18n(Nebula::NebulaType nType);
 
 	NebulaType getDSOType() const {return nType;}
 
@@ -226,10 +226,12 @@ friend class NebulaMgr;
 	void removeAllNames() { englishName=""; englishAliases.clear(); }
 
 	//! Get designation for DSO (with priority: M, C, NGC, IC, B, Sh2, vdB, RCW, LDN, LBN, Cr, Mel, PGC, UGC, Ced, Arp, VV, PK, PN G, SNR G, ACO, HCG, ESO, vdBH, DWB, Tr, St, Ru, vdB-Ha)
-	//! @return a designation
+	//! from the first catalog that is activated.
+	//! @return a designation for DSO
 	QString getDSODesignation() const;
-	//! Get designation for DSO with priority and ignorance of availability of catalogs
-	//! @return a designation
+	//! Get designation for DSO (with priority: M, C, NGC, IC, B, Sh2, vdB, RCW, LDN, LBN, Cr, Mel, PGC, UGC, Ced, Arp, VV, PK, PN G, SNR G, ACO, HCG, ESO, vdBH, DWB, Tr, St, Ru, vdB-Ha)
+	//! without accounting for activation of catalogs. This should be preferred to retrieve the most common designation regardless of settings.
+	//! @return a designation for DSO
 	QString getDSODesignationWIC() const;	
 
 	bool objectInDisplayedCatalog() const;

src/core/modules/Planet.cpp

@@ -566,10 +566,10 @@ QString Planet::getInfoString(const StelCore* core, const InfoStringGroup& flags
 			const QString cometType = (static_cast<KeplerOrbit*>(orbitPtr)->getEccentricity() < 1.0) ?
 						qc_("periodic", "type of comet") :
 						qc_("non-periodic", "type of comet");
-			oss << QString("%1: <b>%2</b> (%3)<br/>").arg(q_("Type"), q_(getPlanetTypeString()), cometType);
+			oss << QString("%1: <b>%2</b> (%3)<br/>").arg(q_("Type"), getObjectTypeI18n(), cometType);
 		}
 		else		
-			oss << QString("%1: <b>%2</b><br/>").arg(q_("Type"), q_(getPlanetTypeString()));		
+			oss << QString("%1: <b>%2</b><br/>").arg(q_("Type"), getObjectTypeI18n());
 	}
 
 	if (getPlanetType()==PlanetType::isObserver)

src/core/modules/Planet.hpp

@@ -243,9 +243,15 @@ class Planet : public StelObject
 	virtual float getVMagnitude(const StelCore* core) const Q_DECL_OVERRIDE;
 	virtual float getSelectPriority(const StelCore* core) const Q_DECL_OVERRIDE;
 	virtual Vec3f getInfoColor(void) const Q_DECL_OVERRIDE;
+	//! @return "Planet". For technical reasons this is also returned by Comets and MinorPlanets and the Sun. A better type is returned by getObjectType()
 	virtual QString getType(void) const Q_DECL_OVERRIDE {return PLANET_TYPE;}
-	virtual QString getObjectType(void) const Q_DECL_OVERRIDE { return getPlanetTypeString(); }
-	virtual QString getObjectTypeI18n(void) const Q_DECL_OVERRIDE { return q_(getPlanetTypeString()); }
+	//! Get more specific Planet type for scripts
+	//! @return an English type description of planet (star, planet, moon, observer, artificial, asteroid, plutino, comet, dwarf planet, cubewano, scattered disc object, Oort cloud object, sednoid, interstellar object)
+	virtual QString getObjectType(void) const Q_DECL_OVERRIDE { return pTypeMap.value(pType); }
+	//! Get more specific Planet type for scripts
+	//! @return a localized type description of planet (star, planet, moon, observer, artificial, asteroid, plutino, comet, dwarf planet, cubewano, scattered disc object, Oort cloud object, sednoid, interstellar object)
+	virtual QString getObjectTypeI18n(void) const Q_DECL_OVERRIDE { return q_(pTypeMap.value(pType)); }
+	//! @return English name of planet
 	virtual QString getID(void) const Q_DECL_OVERRIDE { return englishName; }
 	//! A Planet's own eclipticPos is in VSOP87 ref. frame (practically equal to ecliptic of J2000 for us) coordinates relative to the parent body (sun, planet).
 	//! To get J2000 equatorial coordinates, we require heliocentric ecliptical positions (adding up parent positions) of observer and Planet.
@@ -309,8 +315,9 @@ class Planet : public StelObject
 	//! Get albedo
 	double getAlbedo(void) const { return static_cast<double>(albedo); }
 
+	//! @return texture map name
 	const QString& getTextMapName() const {return texMapName;}
-	const QString getPlanetTypeString() const {return pTypeMap.value(pType);}
+	//! @return a type code enum
 	PlanetType getPlanetType() const {return pType;}
 	Orbit* getOrbit() const {return orbitPtr;}
 

src/core/modules/SolarSystem.cpp

@@ -1684,7 +1684,7 @@ QString SolarSystem::getPlanetType(QString planetName) const
 		p = searchMinorPlanetByEnglishName(planetName);
 	if (p.isNull())
 		return QString("UNDEFINED");
-	return p->getPlanetTypeString();
+	return p->getObjectType();
 }
 
 double SolarSystem::getDistanceToPlanet(QString planetName) const
@@ -2078,15 +2078,15 @@ QStringList SolarSystem::listAllObjectsByType(const QString &objType, bool inEng
 	{
 		for (const auto& p : systemPlanets)
 		{
-			if (p->getPlanetTypeString()==objType)
+			if (p->getObjectType()==objType)
 				result << p->getEnglishName();
 		}
 	}
 	else
 	{
 		for (const auto& p : systemPlanets)
 		{
-			if (p->getPlanetTypeString()==objType)
+			if (p->getObjectType()==objType)
 				result << p->getNameI18n();
 		}
 	}

src/core/modules/StarWrapper.hpp

@@ -107,7 +107,7 @@ template <class Star> class StarWrapper : public StarWrapperBase
 		return 0.001f*a->mag_min + s->getMag()*(0.001f*a->mag_range)/a->mag_steps;
 	}
 	virtual float getBV(void) const  Q_DECL_OVERRIDE {return s->getBV();}
-	virtual QString getEnglishName(void) const Q_DECL_OVERRIDE {return QString();}
+	//virtual QString getEnglishName(void) const Q_DECL_OVERRIDE {return QString();}
 	virtual QString getNameI18n(void) const Q_DECL_OVERRIDE {return s->getNameI18n();}
 protected:
 	const SpecialZoneArray<Star> *const a;