refactor Preferences->Settings

Assets/UserGuide/index.rst

@@ -44,7 +44,7 @@ Tracker Context Menu
    :align: center
 
 
-The context menu allows you to directly execute one of your saved commands as well as open the preferences or
+The context menu allows you to directly execute one of your saved commands as well as open the settings or
 management window.
 
 ..
@@ -122,11 +122,11 @@ Use the Terminal application to run the command so that the output can be viewed
 
 
 
-Preferences
+Settings
 -----------
 
 .. image:: ../Screenshots/TrackRunnerPrefs.png
-   :alt: Preferences window
+   :alt: Settings window
    :align: center
 
 

Source/CMakeLists.txt

@@ -7,8 +7,8 @@ set(${PROJECT_NAME}_sources
 	CommandsWindow.cpp
 	RunnerAddOn.cpp
 	RunnerApp.cpp
-	Preferences.cpp
-	PreferencesWindow.cpp
+	Settings.cpp
+	SettingsWindow.cpp
 	SortableListView.cpp
 	TrackRunner.rdef
 	)

Source/CommandSelectWindow.cpp

@@ -4,7 +4,7 @@
 #include "CommandSelectWindow.h"
 #include "CommandListItem.h"
 #include "Constants.h"
-#include "Preferences.h"
+#include "Settings.h"
 #include "RunnerAddOn.h"
 
 #include <Alert.h>
@@ -241,7 +241,7 @@ status_t
 CommandSelectWindow::_LoadCommands()
 {
 	BMessage message;
-	if (Preferences::ReadPreferences(message) != B_OK)
+	if (Settings::ReadSettings(message) != B_OK)
 		return B_ERROR;
 
 	BMessage itemMessage;

Source/CommandsWindow.cpp

@@ -4,7 +4,7 @@
 #include "CommandsWindow.h"
 #include "CommandListItem.h"
 #include "Constants.h"
-#include "Preferences.h"
+#include "Settings.h"
 #include "RunnerAddOn.h"
 #include "SortableListView.h"
 
@@ -354,7 +354,7 @@ status_t
 CommandsWindow::_LoadCommands()
 {
 	BMessage message;
-	if (Preferences::ReadPreferences(message) != B_OK)
+	if (Settings::ReadSettings(message) != B_OK)
 		return B_ERROR;
 
 	BMessage itemMessage;
@@ -378,7 +378,7 @@ status_t
 CommandsWindow::_SaveCommands()
 {
 	BMessage message;
-	if (Preferences::ReadPreferences(message) != B_OK)
+	if (Settings::ReadSettings(message) != B_OK)
 		return B_ERROR;
 
 	// clear out old command entries
@@ -397,7 +397,7 @@ CommandsWindow::_SaveCommands()
 		message.AddMessage(kEntryKey, &itemMessage);
 	}
 
-	return Preferences::WritePreferences(message);
+	return Settings::WriteSettings(message);
 }
 
 

Source/RunnerAddOn.cpp

@@ -3,7 +3,7 @@
 
 #include "RunnerAddOn.h"
 #include "Constants.h"
-#include "Preferences.h"
+#include "Settings.h"
 
 #include <Alert.h>
 #include <InterfaceDefs.h>
@@ -169,7 +169,7 @@ populate_menu(BMessage* message, BMenu* menu, BHandler* handler)
 		menu->RemoveItem(menuItem);
 
 	BMessage prefsMessage;
-	Preferences::ReadPreferences(prefsMessage);
+	Settings::ReadSettings(prefsMessage);
 
 	BMenu* trackMenu = new BMenu(prefsMessage.GetString(kMenuLabelKey, kAppTitle));
 	BLayoutBuilder::Menu<> builder = BLayoutBuilder::Menu<>(trackMenu);

Source/RunnerApp.cpp

@@ -5,7 +5,7 @@
 #include "CommandSelectWindow.h"
 #include "CommandsWindow.h"
 #include "Constants.h"
-#include "PreferencesWindow.h"
+#include "SettingsWindow.h"
 
 #include <Alert.h>
 #include <Application.h>
@@ -35,17 +35,17 @@ RunnerApp::MessageReceived(BMessage* message)
 	switch (message->what) {
 		case kLaunchPrefsWhat:
 		{
-			// search for existing preferences window
+			// search for existing settings window
 			for (int32 index = 0; index < CountWindows(); index++) {
-				PreferencesWindow* window = dynamic_cast<PreferencesWindow*>(WindowAt(index));
+				SettingsWindow* window = dynamic_cast<SettingsWindow*>(WindowAt(index));
 				if (window != NULL) {
 					window->Activate();
 					return;
 				}
 			}
 
 			fInitialWindowShown = true;
-			_ShowPreferencesWindow();
+			_ShowSettingsWindow();
 		}
 			break;
 		case kLaunchManageWhat:
@@ -103,11 +103,11 @@ RunnerApp::AboutRequested()
 
 
 void
-RunnerApp::_ShowPreferencesWindow()
+RunnerApp::_ShowSettingsWindow()
 {
 	BString title(B_TRANSLATE("%trackrunner% settings"));
 	title.ReplaceFirst("%trackrunner%", kAppTitle);
-	PreferencesWindow* window = new PreferencesWindow(title);
+	SettingsWindow* window = new SettingsWindow(title);
 	window->Lock();
 	window->CenterOnScreen();
 	window->Show();

Source/RunnerApp.h

@@ -18,7 +18,7 @@ class RunnerApp : public BApplication {
 
 private:
 		void		_ShowManageWindow();
-		void		_ShowPreferencesWindow();
+		void		_ShowSettingsWindow();
 
 	bool		fInitialWindowShown;
 };

Source/Preferences.cpp → Source/Settings.cpp

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 // SPDX-FileCopyrightText: 2022 Chris Roberts
 
-#include "Preferences.h"
+#include "Settings.h"
 #include "Constants.h"
 
 #include <File.h>
@@ -10,7 +10,7 @@
 
 
 status_t
-Preferences::ReadPreferences(BMessage& message)
+Settings::ReadSettings(BMessage& message)
 {
 	BPath prefsPath;
 	if (find_directory(B_USER_SETTINGS_DIRECTORY, &prefsPath) != B_OK)
@@ -30,7 +30,7 @@ Preferences::ReadPreferences(BMessage& message)
 
 
 status_t
-Preferences::WritePreferences(BMessage& message)
+Settings::WriteSettings(BMessage& message)
 {
 	BPath prefsPath;
 	if (find_directory(B_USER_SETTINGS_DIRECTORY, &prefsPath) != B_OK)

Source/Settings.h

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2022 Chris Roberts
+
+#ifndef _SETTINGS_H_
+#define _SETTINGS_H_
+
+#include <SupportDefs.h>
+
+class BMessage;
+
+class Settings {
+public:
+	static status_t ReadSettings(BMessage& message);
+	static status_t WriteSettings(BMessage& message);
+};
+
+#endif // _SETTINGS_H_

Source/PreferencesWindow.cpp → Source/SettingsWindow.cpp

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: MIT
 // SPDX-FileCopyrightText: 2022 Chris Roberts
 
-#include "PreferencesWindow.h"
+#include "SettingsWindow.h"
 #include "Constants.h"
-#include "Preferences.h"
+#include "Settings.h"
 
 #include <Application.h>
 #include <Button.h>
@@ -15,7 +15,7 @@
 #include <Catalog.h>
 
 #undef B_TRANSLATION_CONTEXT
-#define B_TRANSLATION_CONTEXT "PreferencesWindow"
+#define B_TRANSLATION_CONTEXT "SettingsWindow"
 #else
 #define B_TRANSLATE(x) x
 #endif
@@ -30,13 +30,13 @@ enum {
 };
 
 
-PreferencesWindow::PreferencesWindow(BString& title)
+SettingsWindow::SettingsWindow(BString& title)
 	:
 	BWindow(BRect(100, 100, 400, 300), title, B_TITLED_WINDOW,
 		B_ASYNCHRONOUS_CONTROLS | B_AUTO_UPDATE_SIZE_LIMITS | B_CLOSE_ON_ESCAPE)
 {
 	BMessage message;
-	Preferences::ReadPreferences(message);
+	Settings::ReadSettings(message);
 
 	fMenuLabelControl = new BTextControl(B_TRANSLATE("Menu label:"),
 		message.GetString(kMenuLabelKey, kAppTitle), NULL);
@@ -69,7 +69,7 @@ PreferencesWindow::PreferencesWindow(BString& title)
 
 
 bool
-PreferencesWindow::QuitRequested()
+SettingsWindow::QuitRequested()
 {
 	if (be_app->CountWindows() == 1)
 		be_app->PostMessage(B_QUIT_REQUESTED);
@@ -79,23 +79,23 @@ PreferencesWindow::QuitRequested()
 
 
 void
-PreferencesWindow::MessageReceived(BMessage* message)
+SettingsWindow::MessageReceived(BMessage* message)
 {
 	switch (message->what) {
 		case kDefaultsButtonWhat:
 			fMenuLabelControl->SetText(kAppTitle);
 #ifdef USE_MENUITEM_ICONS
 			fIconMenuCheckBox->SetValue(kIconMenusDefault);
 #endif
-			_WritePreferences();
+			_WriteSettings();
 			break;
 #ifdef USE_MENUITEM_ICONS
 		case kIconCheckBoxWhat:
-			_WritePreferences();
+			_WriteSettings();
 			break;
 #endif
 		case kMenuLabelWhat:
-			_WritePreferences();
+			_WriteSettings();
 			break;
 		default:
 			BWindow::MessageReceived(message);
@@ -104,11 +104,11 @@ PreferencesWindow::MessageReceived(BMessage* message)
 
 
 status_t
-PreferencesWindow::_WritePreferences()
+SettingsWindow::_WriteSettings()
 {
 	BMessage message;
 
-	Preferences::ReadPreferences(message);
+	Settings::ReadSettings(message);
 
 #ifdef USE_MENUITEM_ICONS
 	message.SetBool(kIconMenusKey, fIconMenuCheckBox->Value());
@@ -130,5 +130,5 @@ PreferencesWindow::_WritePreferences()
 	fMenuLabelControl->TextView()->SetFontAndColor(&font, B_FONT_ALL, &textColor);
 	fMenuLabelControl->SetViewColor(viewColor);
 
-	return Preferences::WritePreferences(message);
+	return Settings::WriteSettings(message);
 }

Source/PreferencesWindow.h → Source/SettingsWindow.h

@@ -1,30 +1,30 @@
 // SPDX-License-Identifier: MIT
 // SPDX-FileCopyrightText: 2022 Chris Roberts
 
-#ifndef _PREFERENCESWINDOW_H_
-#define _PREFERENCESWINDOW_H_
+#ifndef _SETTINGSWINDOW_H_
+#define _SETTINGSWINDOW_H_
 
 #include <Window.h>
 
 class BCheckBox;
 class BTextControl;
 
 
-class PreferencesWindow : public BWindow {
+class SettingsWindow : public BWindow {
 
 public:
-					PreferencesWindow(BString& title);
+					SettingsWindow(BString& title);
 
 	virtual void	MessageReceived(BMessage* message);
 	virtual bool	QuitRequested();
 
 private:
-		status_t	_WritePreferences();
+		status_t	_WriteSettings();
 
 #ifdef USE_MENUITEM_ICONS
 	BCheckBox*		fIconMenuCheckBox;
 #endif
 	BTextControl*	fMenuLabelControl;
 };
 
-#endif // _PREFERENCESWINDOW_H_
+#endif // _SETTINGSWINDOW_H_

Source/locales/en.catkeys

@@ -13,7 +13,7 @@ Manage commands…	RunnerAddOn		Manage commands…
 Use Terminal	CommandSelectWindow		Use Terminal
 Settings & Help	RunnerAddOn		Settings & Help
 Settings…	RunnerAddOn		Settings…
-Defaults	PreferencesWindow		Defaults
+Defaults	SettingsWindow		Defaults
 Failed to launch URL	RunnerAddOn		Failed to launch URL
 Command:	CommandsWindow		Command:
 TrackRunner\nWritten by Chris Roberts	RunnerApp		TrackRunner\nWritten by Chris Roberts
@@ -23,9 +23,9 @@ Cancel	CommandSelectWindow		Cancel
 New	CommandsWindow		New
 Do you wish to delete '%s'?	CommandsWindow		Do you wish to delete '%s'?
 Unable to launch TrackRunner application	RunnerAddOn		Unable to launch TrackRunner application
-Menu label:	PreferencesWindow		Menu label:
+Menu label:	SettingsWindow		Menu label:
 Show in Tracker	CommandsWindow		Show in Tracker
-Close	PreferencesWindow		Close
+Close	SettingsWindow		Close
 Cancel	CommandsWindow		Cancel
 Browse…	CommandSelectWindow		Browse…
 Open the user guide	CommandsWindow		Open the user guide