feat: Add registry settings forTabs and Panel settings

- Added registry settings for the Tabs and Panel Page. - All settings implemented with async registry logic - Comment unused settings - Update documents
2026-02-17 14:07:46 +08:00 · 2024-10-01 12:32:16 +02:00
parent 600ba73f5f
commit 489602ffb3
9 changed files with 1008 additions and 32 deletions
--- a/mRemoteNGDocumentation/registry/appearance_settings.rst
+++ b/mRemoteNGDocumentation/registry/appearance_settings.rst
@@ -0,0 +1,95 @@
+*******************
+Appearance Settings
+*******************
+.. versionadded:: v1.77.3
+
+.. warning::
+    Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the 
+    **Modifying the Registry**, **Restricted Registry Settings** and **Disclaimer** 
+    on :doc:`Registry Settings Infromation <registry_settings_information>`.
+    
+
+Options
+=======
+Configure the options page to modify functionalities as described.
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\Appearance\Options``
+
+
+Show Description Tooltips In Connection Tree
+--------------------------------------------
+Specifies whether to show tooltips with descriptions in the connection tree view.
+
+- **Value Name:** ``ShowDescriptionTooltipsInConTree``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Show: ``true``
+  - Hide: ``false``
+
+
+Show Complete Connection File Path In Title
+-------------------------------------------
+Specifies whether to show complete connection path in the window title.
+
+- **Value Name:** ``ShowCompleteConFilePathInTitle``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Show: ``true``
+  - Hide: ``false``
+
+
+Always Show System Tray Icon
+----------------------------
+Specifies whether to always show the system tray icon.
+
+
+- **Value Name:** ``AlwaysShowSystemTrayIcon``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Show: ``true``
+  - Hide: ``false``
+
+
+Minimize To Tray
+----------------
+Specifies whether the application should minimize to the system tray.
+
+- **Value Name:** ``MinimizeToTray``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Close To Tray
+-------------
+Specifies whether the application should close to the system tray.
+
+- **Value Name:** ``CloseToTray``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Registry Template
+=================
+
+.. code::
+  
+    Windows Registry Editor Version 5.00
+
+    [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\Appearance]
+
+    [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\Appearance\Options]
+    "AlwaysShowSystemTrayIcon"="false"
+    "CloseToTray"="false"
+    "MinimizeToTray"="true"
+    "ShowCompleteConFilePathInTitle"="true"
+    "ShowDescriptionTooltipsInConTree"="true"
--- a/mRemoteNGDocumentation/registry/notification_settings.rst
+++ b/mRemoteNGDocumentation/registry/notification_settings.rst
@@ -0,0 +1,345 @@
+*********************
+Notification Settings
+*********************
+.. versionadded:: v1.77.3
+
+.. warning::
+    Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the 
+    **Modifying the Registry**, **Restricted Registry Settings** and **Disclaimer** 
+    on :doc:`Registry Settings Infromation <registry_settings_information>`.
+    
+
+Common
+======
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\Notifications``
+
+Allow Logging
+-------------
+Specifies whether logging to a file is allowed or not.
+
+- **Value Name:** ``AllowLogging``
+- **Value Type:** ``REG_SZ``
+- **Default value:** ``true``
+- **Values:**
+
+  - Disallow: ``false``
+
+
+Allow Notifications
+-------------------
+Specifies whether notifications are allowed or not.
+
+- **Value Name:** ``AllowNotifications``
+- **Value Type:** ``REG_SZ``
+- **Default value:** ``true``
+- **Values:**
+
+  - Disallow: ``false``
+
+
+Allow Popups
+------------
+Specifies whether pop-up notifications are allowed or not.
+
+- **Value Name:** ``AllowPopups``
+- **Value Type:** ``REG_SZ``
+- **Default value:** ``true``
+- **Values:**
+
+  - Disallow: ``false``
+
+
+Options: Notification Panel
+===========================
+Configure the options page to modify functionalities as described. These settings are scoped under the "Notification Panel".
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\Notifications\Options``
+
+.. note::
+   In some configurations, an initial application restart may be required after the initial launch.
+
+
+Write Debug Messages
+--------------------
+Specifies whether debug messages are written to the notification panel. 
+Show this message types checkbox: Debug
+
+- **Value Name:** ``NfpWriteDebugMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Info Messages
+-------------------
+Specifies whether information messages are written to the notification panel.
+Show this message types checkbox: Information
+
+- **Value Name:** ``NfpWriteInfoMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Warning Messages
+----------------------
+Specifies whether warning messages are written to the notification panel.
+Show this message types checkbox: Warning
+
+- **Value Name:** ``NfpWriteWarningMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Error Messages
+--------------------
+Specifies whether error messages are written to the notification panel.
+Show this message types checkbox: Error
+
+- **Value Name:** ``NfpWriteErrorMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Switch To Notification Panel On Information
+-------------------------------------------
+Specifies whether to switch to notification panel when information messages are received.
+Switch to notifications panel checkbox: Information
+
+- **Value Name:** ``SwitchToMCOnInformation``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Switch To Notification Panel On Warning
+---------------------------------------
+Specifies whether to switch to notification panel when warning messages are received.
+Switch to notifications panel checkbox: Warning
+
+- **Value Name:** ``SwitchToMCOnWarning``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Switch To Notification Panel On Error
+-------------------------------------
+Specifies whether to switch to notification panel when error messages are received.
+Switch to notifications panel checkbox: Error
+
+- **Value Name:** ``SwitchToMCOnError``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Options: Logging Panel
+======================
+Configure the options page to modify functionalities as described. These settings are scoped under the "Logging Panel".
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\Notifications\Options``
+
+.. note::
+   In some configurations, an initial application restart may be required after the initial launch.
+
+
+Log To Application Directory
+----------------------------
+Specifies whether logs should be written to the application directory.
+
+- **Value Name:** ``LogToApplicationDirectory``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+.. warning::
+  Users must have permissions to the application dir!
+  
+.. note::
+  If set to true, LogFilePath cannot be configured.
+
+
+Log File Path
+-------------
+Specifies the file path for logging.
+
+- **Value Name:** ``LogFilePath``
+- **Value Type:** ``REG_SZ``
+
+.. warning::
+  Users must have permissions to write to the file!
+
+.. note::
+  If LogToApplicationDirectory is set to true, this setting has no effect; LogToApplicationDirectory must be set to false. If only LogFilePath is present, LogToApplicationDirectory will be automatically set to false.
+
+
+Write Debug Messages
+--------------------
+Specifies whether debug messages should be written to the text log.
+
+- **Value Name:** ``LfWriteDebugMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+  
+Write Info Messages
+-------------------
+Specifies whether information messages should be written to the text log.
+
+- **Value Name:** ``LfWriteInfoMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Warning Messages
+----------------------
+Specifies whether warning messages should be written to the text log.
+
+- **Value Name:** ``LfWriteWarningMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Error Messages
+--------------------
+Specifies whether error messages should be written to the text log.
+
+- **Value Name:** ``LfWriteErrorMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Options: Popup Panel
+====================
+Configure the options page to modify functionalities as described. These settings are scoped under the "Popup Panel".
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\Notifications\Options``
+
+.. warning::
+  Settings could affect the user experience.
+
+.. note::
+   In some configurations, an initial application restart may be required after the initial launch.
+
+  
+Write Debug Messages
+--------------------
+Specifies whether debug messages should be displayed as popups.
+
+- **Value Name:** ``PuWriteDebugMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+.. warning::
+  Activating could lead to the program becoming unusable. Suitable only for debugging purposes.
+
+  
+Write Info Messages
+-------------------
+Specifies whether information messages should be displayed as popups.
+
+- **Value Name:** ``PuWriteInfoMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Warning Messages
+----------------------
+Specifies whether warning messages should be displayed as popups.
+
+- **Value Name:** ``PuWriteWarningMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Write Error Messages
+--------------------
+Specifies whether error messages should be displayed as popups.
+
+- **Value Name:** ``PuWriteErrorMsgs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Registry Template
+=================
+
+.. code::
+
+    Windows Registry Editor Version 5.00
+
+    [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\Notifications]
+    "AllowLogging"="false"
+    "AllowNotifications"="false"
+    "AllowPopups"="false"
+
+    [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\Notifications\Options]
+    "NfpWriteDebugMsgs"="true"
+    "NfpWriteInfoMsgs"="true"
+    "NfpWriteWarningMsgs"="true"
+    "NfpWriteErrorMsgs"="true"
+    "SwitchToMCOnInformation"="false"
+    "SwitchToMCOnWarning"="false"
+    "SwitchToMCOnError"="false"
+    "LfWriteDebugMsgs"="true"
+    "LfWriteErrorMsgs"="true"
+    "LfWriteInfoMsgs"="true"
+    "LfWriteWarningMsgs"="true"
+    "LogFilePath"="c:\...."
+    "LogToApplicationDirectory"="false"
+    "PuWriteDebugMsgs"="false"
+    "PuWriteErrorMsgs"="false"
+    "PuWriteInfoMsgs"="false"
+    "PuWriteWarningMsgs"="false"
+
+
+
+
--- a/mRemoteNGDocumentation/registry/startupExit_settings.rst
+++ b/mRemoteNGDocumentation/registry/startupExit_settings.rst
@@ -0,0 +1,76 @@
+*************************
+Startup and Exit Settings
+*************************
+.. versionadded:: v1.77.3
+
+.. warning::
+    Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the 
+    **Modifying the Registry**, **Restricted Registry Settings** and **Disclaimer** 
+    on :doc:`Registry Settings Infromation <registry_settings_information>`.
+    
+
+Options
+=======
+Configure the options page to modify functionalities as described.
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\StartupExit\Options``
+
+
+Startup Behavior
+----------------
+Specifies the startup behavior of the application:
+
+- None: The application starts without any specific behavior, using the last closed resolution or position.
+- Minimized: The application starts minimized.
+- FullScreen: The application starts in fullscreen mode.
+
+- **Value Name:** ``StartupBehavior``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - ``None``
+  - ``Minimized``
+  - ``FullScreen``
+
+
+Open Connections From Last Session
+----------------------------------
+Specifies whether sessions should be automatically reconnected on application startup.
+
+- **Value Name:** ``OpenConnectionsFromLastSession``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Enforce Single Application Instance
+-----------------------------------
+Ensures that only a single instance of the application is allowed to run.
+
+- **Value Name:** ``EnforceSingleApplicationInstance``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+   
+
+
+Registry Template
+=================
+
+.. code::
+
+    Windows Registry Editor Version 5.00
+
+    [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\StartupExit]
+
+    [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\StartupExit\Options]
+    "EnforceSingleApplicationInstance"="true"
+    "OpenConnectionsFromLastSession"="true"
+    "StartupBehavior"="FullScreen"
+
+
--- a/mRemoteNGDocumentation/registry/tabsPanels_settings.rst
+++ b/mRemoteNGDocumentation/registry/tabsPanels_settings.rst
@@ -0,0 +1,136 @@
+***********************
+Tabs and Panel Settings
+***********************
+.. versionadded:: v1.77.3
+
+.. warning::
+    Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the 
+    **Modifying the Registry**, **Restricted Registry Settings** and **Disclaimer** 
+    on :doc:`Registry Settings Infromation <registry_settings_information>`.
+    
+
+Options
+=======
+Configure the options page to modify functionalities as described.
+
+- **Registry Hive:** ``HKEY_LOCAL_MACHINE``
+- **Registry Path:** ``SOFTWARE\mRemoteNG\TabsAndPanels\Options``
+
+Always Show Panel Tabs
+----------------------
+Specifies whether panel tabs are always shown or not. This is useful when the panel attribute in a connection is set to group open connections.
+
+- **Value Name:** ``AlwaysShowPanelTabs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Show Logon Info On Tabs
+-----------------------
+Specifies whether logon information (username) is shown on tabs.
+
+- **Value Name:** ``ShowLogonInfoOnTabs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Show Protocol On Tabs
+---------------------
+Specifies whether protocol information is displayed on tabs (e.g., RDP:).
+
+- **Value Name:** ``ShowProtocolOnTabs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Marking Quick Connect Tabs
+--------------------------
+Specifies whether quick connect tabs are marked by the prefix "Quick:".
+
+- **Value Name:** ``IdentifyQuickConnectTabs``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Double Click To Close Tab
+-------------------------
+Specifies whether double-clicking on a tab closes it.
+
+- **Value Name:** ``DoubleClickOnTabClosesIt``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Always Show Panel Selection Dialog
+----------------------------------
+Specifies whether the panel selection dialog is always shown. 
+When set to true, initiating a connection will prompt a dialog to appear, allowing the user to choose the panel to which the connection will be added or create a new one.
+
+
+- **Value Name:** ``AlwaysShowPanelSelectionDlg``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Create Empty Panel On Start Up
+------------------------------
+Specifies whether an empty panel is created on startup.
+
+- **Value Name:** ``CreateEmptyPanelOnStartUp``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+  - Enable: ``true``
+  - Disable: ``false``
+
+
+Start Up Panel Name
+-------------------
+Specifies the name of the startup panel.
+
+- **Value Name:** ``StartUpPanelName``
+- **Value Type:** ``REG_SZ``
+- **Values:**
+
+
+.. note::
+  It doesn't take effect if 'CreateEmptyPanelOnStartUp' is unchecked.
+
+
+Registry Template
+=================
+
+.. code::
+
+  Windows Registry Editor Version 5.00
+
+  [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\TabsAndPanels]
+
+  [HKEY_LOCAL_MACHINE\SOFTWARE\mRemoteNG\TabsAndPanels\Options]
+  "AlwaysShowPanelTabs"="true"
+  "ShowLogonInfoOnTabs"="true"
+  "ShowProtocolOnTabs"="true"
+  "IdentifyQuickConnectTabs"="true"
+  "DoubleClickOnTabClosesIt"="true"
+  "AlwaysShowPanelSelectionDlg"="true"
+  "CreateEmptyPanelOnStartUp"="true"
+  "StartUpPanelName"=""
+