initial version

.github/workflows/build_addon.yml

@@ -4,7 +4,7 @@ on:
   push:
     tags: ["*"]
     # To build on main/master branch, uncomment the following line:
-    # branches: [ main , master ]
+    branches: [ main , master ]
 
   pull_request:
     branches: [ main, master ]

addon/doc/zh_CN/readme.md

@@ -0,0 +1,7 @@
+# 对象监视器
+
+用于监视导航对象属性变化的插件。
+
+## 按键与首饰
+
+``Control+NVDA+W``： 启动或停止对象监视。

addon/globalPlugins/objWatcher/__init__.py

@@ -0,0 +1,81 @@
+# objWatcher add-on for NVDA
+# This file is covered by the GNU General Public License.
+# See the file COPYING.txt for more details.
+# Copyright (C) 2023 Cary-rowen <[email protected]>
+
+import api
+import addonHandler
+import gui
+import globalPluginHandler
+import ui
+import wx
+from scriptHandler import script
+from . import cues
+
+addonHandler.initTranslation()
+
+WATCHER_TIMER_INTERVAL = 100  # milliseconds
+
+class GlobalPlugin(globalPluginHandler.GlobalPlugin):
+    scriptCategory = _("objWatcher")
+
+    def __init__(self):
+        super().__init__()
+        self.watchingObj = None
+        self.lastAttributeText = None
+        self.timer = wx.Timer(gui.mainFrame)
+        gui.mainFrame.Bind(wx.EVT_TIMER, self.onTimerEvent, self.timer)
+
+    @script(
+        description=_(
+            # Translators: Input help message about start or stop watcher command in objWatcher.
+            "Start or stop the navigation object watcher."
+        ),
+        gesture="KB:NVDA+control+w"
+    )
+    def script_startOrStopWatcher(self, gesture):
+        if not self.timer:
+            return   
+        if self.timer.IsRunning():
+            self.timer.Stop()
+            cues.Stop()
+            ui.message(_("Stopped watcher"))
+        else:
+            self.watchingObj = api.getNavigatorObject()     
+            self.timer.Start(WATCHER_TIMER_INTERVAL)
+            if self.watchingObj:
+                cues.Start()
+                ui.message(_("Started watcher {}").format(self._getWatchingAttribute()))
+            else:
+                cues.NoObj()
+                ui.message(_("No navigation object available to watch"))
+
+    def onTimerEvent(self, event):
+        if not self.watchingObj:
+            return
+        attributeText = self._getWatchingAttribute()
+        if self.lastAttributeText == attributeText:
+            return
+        self.lastAttributeText = attributeText
+        ui.message(attributeText)
+
+    def _getWatchingAttribute(self):
+        non_empty_attributes = []
+        seen_values = set()   
+        for attr in ['name', 'value', 'description']:
+            if hasattr(self.watchingObj, attr):
+                value = getattr(self.watchingObj, attr)
+                if value and value not in seen_values:
+                    non_empty_attributes.append(value)
+                    seen_values.add(value)    
+        attribute_text = ', '.join(non_empty_attributes)
+        return attribute_text
+
+    def terminate(self):
+        super().terminate()
+        if self.timer:
+            self.timer.Stop()
+            self.lastAttributeText = None
+            self.timer = None
+            self.watchingObj = None
+

addon/globalPlugins/objWatcher/cues.py

@@ -0,0 +1,15 @@
+import os
+from nvwave import playWaveFile
+
+def Start():
+	play_sound("Start")
+
+def Stop():
+	play_sound("Stop")
+
+def NoObj():
+	play_sound("NoObj")
+
+def play_sound(filename):
+	path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'sounds', filename))
+	return playWaveFile(path + ".wav")

addon/locale/zh_CN/LC_MESSAGES/nvda.po

@@ -0,0 +1,52 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: 'OBJWatcher' '0.1'\n"
+"Report-Msgid-Bugs-To: '[email protected]'\n"
+"POT-Creation-Date: 2023-08-25 15:28+0800\n"
+"PO-Revision-Date: 2023-08-25 15:29+0800\n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"Language: zh_CN\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 3.3.2\n"
+
+#: addon\globalPlugins\objWatcher\__init__.py:20
+msgid "objWatcher"
+msgstr "对象监视器"
+
+#. Translators: Input help message about start or stop watcher command in objWatcher.
+#: addon\globalPlugins\objWatcher\__init__.py:32
+msgid "Start or stop the navigation object watcher."
+msgstr "启动或停止对象监视"
+
+#: addon\globalPlugins\objWatcher\__init__.py:42
+msgid "Stopped watcher"
+msgstr "已停止监视"
+
+#: addon\globalPlugins\objWatcher\__init__.py:48
+msgid "Started watcher {}"
+msgstr "已开始监视 {}"
+
+#: addon\globalPlugins\objWatcher\__init__.py:51
+msgid "No navigation object available to watch"
+msgstr "没有可供监视的对象"
+
+#. Add-on summary, usually the user visible name of the addon.
+#. Translators: Summary for this add-on
+#. to be shown on installation and add-on information found in Add-ons Manager.
+#: buildVars.py:23
+msgid "obj Watcher"
+msgstr "对象监视器"
+
+#. Add-on description
+#. Translators: Long description to be shown for this add-on on add-on information from add-ons manager
+#: buildVars.py:26
+msgid "An add-on for watch changes to attributes of nav objects."
+msgstr "用于监视导航对象属性变化的插件。"

buildVars.py

@@ -16,37 +16,36 @@ def _(arg):
 # Add-on information variables
 addon_info = {
 	# add-on Name/identifier, internal for NVDA
-	"addon_name": "addonTemplate",
+	"addon_name": "objWatcher",
 	# Add-on summary, usually the user visible name of the addon.
 	# Translators: Summary for this add-on
 	# to be shown on installation and add-on information found in Add-ons Manager.
-	"addon_summary": _("Add-on user visible name"),
+	"addon_summary": _("obj Watcher"),
 	# Add-on description
 	# Translators: Long description to be shown for this add-on on add-on information from add-ons manager
-	"addon_description": _("""Description for the add-on.
-It can span multiple lines."""),
+	"addon_description": _("""An add-on for watch changes to attributes of nav objects."""),
 	# version
-	"addon_version": "x.y",
+	"addon_version": "0.1.0",
 	# Author(s)
-	"addon_author": "name <name@domain.com>",
+	"addon_author": "Cary-rowen <manchen_0528@outlook.com>",
 	# URL for the add-on documentation support
-	"addon_url": None,
+	"addon_url": "https://www.nvdacn.com/",
 	# URL for the add-on repository where the source code can be found
-	"addon_sourceURL": None,
+	"addon_sourceURL": "https://github.com/cary-rowen/objWatcher",
 	# Documentation file name
 	"addon_docFileName": "readme.html",
 	# Minimum NVDA version supported (e.g. "2018.3.0", minor version is optional)
-	"addon_minimumNVDAVersion": None,
+	"addon_minimumNVDAVersion": 2023.1,
 	# Last NVDA version supported/tested (e.g. "2018.4.0", ideally more recent than minimum version)
-	"addon_lastTestedNVDAVersion": None,
+	"addon_lastTestedNVDAVersion": 2023.2,
 	# Add-on update channel (default is None, denoting stable releases,
 	# and for development releases, use "dev".)
 	# Do not change unless you know what you are doing!
 	"addon_updateChannel": None,
 	# Add-on license such as GPL 2
-	"addon_license": None,
+	"addon_license": "GPL v2",
 	# URL for the license document the ad-on is licensed under
-	"addon_licenseURL": None,
+	"addon_licenseURL": "https://www.gnu.org/licenses/gpl-2.0.html",
 }
 
 # Define the python files that are the sources of your add-on.
@@ -57,7 +56,7 @@ def _(arg):
 # pythonSources = ["addon/globalPlugins/*.py"]
 # For more information on SCons Glob expressions please take a look at:
 # https://scons.org/doc/production/HTML/scons-user/apd.html
-pythonSources = []
+pythonSources = ["addon/globalPlugins/objWatcher/*.py"]
 
 # Files that contain strings for translation. Usually your python sources
 i18nSources = pythonSources + ["buildVars.py"]

readme.md

@@ -1,135 +1,7 @@
-# NVDA Add-on Scons Template #
+# obj Watcher
 
-This package contains a basic template structure for NVDA add-on development, building, distribution and localization.
-For details about NVDA add-on development, please see the [NVDA Add-on Development Guide](https://github.com/nvdaaddons/DevGuide/wiki/NVDA-Add-on-Development-Guide).
-The NVDA add-on development/discussion list [is here](https://nvda-addons.groups.io/g/nvda-addons)
-Information specific to NV Access add-on store [can be found here](https://github.com/nvaccess/addon-datastore).
+An add-on for watch changes to attributes of nav objects.
 
-Copyright (C) 2012-2023 NVDA Add-on team contributors.
+## Gestures
 
-This package is distributed under the terms of the GNU General Public License, version 2 or later. Please see the file COPYING.txt for further details.
-
-
-
-[alekssamos](https://github.com/alekssamos/) added automatic package of add-ons through Github Actions.
-
-For details about Github Actions  please see the [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions).
-
-Copyright (C) 2022 alekssamos
-
-
-## Features
-
-This template provides the following features you can use during NVDA add-on development and packaging:
-
-* Automatic add-on package creation, with naming and version loaded from a centralized build variables file (buildVars.py) or command-line interface.
-	* See packaging section for details on using command-line switches when packaging add-ons with custom version information.
-	* This process will happen automatically when receiving a pull request, and there is also the possibility of manual launch.
-	* To let the workflow run automatically when pushing to main or master (development) branch, remove the comment for branches line in GitHub Actions (`.github/workflows/build_addon.yml`).
-	* If you have created a tag (E.G.: `git tag v1.0 && git push --tag`), then a release will be automatically created and the add-on file will be uploaded as an asset.
-	* Otherwise, with normal commits or with manual startup, you can download the artifacts from the Actions page of your repository.
-* Manifest file creation using a template (manifest.ini.tpl). Build variables are replaced on this template. See below for add-on manifest specification.
-* Compilation of gettext mo files before distribution, when needed.
-	* To generate a gettext pot file, please run `scons pot`. An `addon-name.pot` file will be created with all gettext messages for your add-on. You need to check the `buildVars.i18nSources` variable to comply with your requirements.
-* Automatic generation of manifest localization files directly from gettext po files. Please make sure buildVars.py is included in i18nFiles.
-* Automatic generation of HTML documents from markdown (.md) files, to manage documentation in different languages.
-* Automatic generation of entries for NV Access add-on store (json format).
-
-In addition, this template includes configuration files for the following tools for use in add-on development and testing (see "additional tools" section for details):
-
-* Flake8 (flake8.ini): a base configuration file for Flake8 linting tool based on NVDA's own Flake8 configuration file.
-* Configuration for VS Code. It requires NVDA's repo at the same level as the add-on folder containing your actual source files, with prepared source code (`scons source`). preparing the source code is a step in the instructions for building NVDA itself, see [The NVDA Repository](https://github.com/nvaccess/nvda) for details.
-        * Place the .vscode in this repo within the addon folder, where your add-on source files (will) reside. The settings file within this folder assumes the NVDA repository is within the parent folder of this folder. If your addon folder is within the addonTemplate folder, then your NVDA repository folder needs to also be within the addonTemplate folder, or the source will not be found.
-        * Open the addon folder in VS Code. This should initialize VS Code with the correct settings and provide you with code completion and other VS Code features. 
-	* Press `control+shift+m` after saving a file to search for problems.
-	* Use arrow and tab keys for the autocompletion feature.
-	* Press `control+shift+p` to open the commands palette and search for recommended extensions to install or check if they are installed.
-
-## Requirements
-
-You need the following software to use this code for your NVDA add-on development and packaging:
-
-* a Python distribution (3.7 or later is recommended). Check the [Python Website](https://www.python.org) for Windows Installers. Please note that at present, preparing the NVDA source code requires the 32-bit version of Python 3.7.
-* Scons - [Website](https://www.scons.org/) - version 4.3.0 or later. You can install it via PIP.
-* GNU Gettext tools, if you want to have localization support for your add-on - Recommended. Any Linux distro or cygwin have those installed. You can find windows builds [here](https://gnuwin32.sourceforge.net/downlinks/gettext.php).
-* Markdown 3.3.0 or later, if you want to convert documentation files to HTML documents. You can install it via PIP.
-
-Note, that you may not need these tools in a local build environment, if you are using [Appveyor](https://appveyor.com/) or [GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions), to build and package your add-ons.
-
-## Usage
-
-### To create a new NVDA add-on using this template:
-
-1. Create an empty folder to hold the files for your add-on.
-2. Copy the folder:
-```
-site_scons
-```
-and the following files, into your new empty folder:
-```
-buildVars.py
-manifest.ini.tpl
-manifest-translated.ini.tpl
-sconstruct
-.gitignore
-.gitattributes
-```
-3. If you intend to use the provided GitHub workflow, also copy the folder:
-```
-.github
-```
-and file:
-```
-.pre-commit-config.yaml
-```
-4. Create an `addon` folder inside your new folder. You will put your code in the usual folders for NVDA extensions, under the `addon` folder. For instance: `globalPlugins`, `synthDrivers`, etc.
-5. In the `buildVars.py` file, change variable `addon_info` with your add-on's information (name, summary, description, version, author, url, source url, license, and license URL). Also, be sure to carefully set the paths contained in the other variables in that file.
-6. Gettext translations must be placed into `addon\locale\<lang>/LC_MESSAGES\nvda.po`.
-
-#### Add-on manifest specification
-
-An add-on manifest generated manually or via `buildVars.py` must include the following information:
-
-* Name (string): a unique identifier for the add-on. It must use camel case (e.g. someModule). This is also used as part of add-on store to identify the add-on uniquely.
-* Summary (string): name as shown on NVDA's Add-ons Manager.
-* Description (string): a short detailed description about the add-on.
-* Version (string), ideally number.number with an optional third number, denoting major.minor.patch.
-* Author (string and an email address): one or more add-on author contact information in the form "name <email@address>".
-* URL (string): a web address where the add-on information can be found (typically community add-ons website address (https://addons.nvda-project.org) is used).
-* docFileName (string): name of the documentation file.
-* minimumNVDAVersion (year.major or year.major.minor): the earliest version of NVDA the add-on is compatible with (e.g. 2019.3). Add-ons are expected to use features introduced in this version of NVDA or declare compatibility with it.
-* lastTestedNVDAVersion (year.major or year.major.minor): the latest or last tested version of NVDA the add-on is said to be compatible with (e.g. 2020.3). Add-on authors are expected to declare this value after testing add-ons with the version of NVDA specified.
-* addon_updateChannel (string or None): the update channel for the add-on release.
-
-In addition, the following information must be filled out (not used in the manifest but used elsewhere such as add-on store):
-
-* sourceURL (string): repository URL for the add-on source code.
-* license (string): the license of the add-on and its source code.
-* licenseURL: the URL for the license file.
-
-### To manage documentation files for your addon:
-
-1. Copy the `readme.md` file for your add-on to the first created folder, where you copied `buildVars.py`. You can also copy `style.css` to improve the presentation of HTML documents.
-2. Documentation files (named `readme.md`) must be placed into `addon\doc\<lang>/`.
-
-### To package the add-on for distribution:
-
-1. Open a command line, change to the folder that has the `sconstruct` file (usually the root of your add-on development folder) and run the `scons` command. The created add-on, if there were no errors, is placed in the current directory.
-2. You can further customize variables in the `buildVars.py` file.
-3. You can also customize version and update channel information from command line by passing the following switches when running scons:
-	* version: add-on version string.
-	* versionNumber: add-on version number of the form major.minor.patch (all integers)
-	* channel: update channel (do not use this switch unless you know what you are doing).
-	* dev: suitable for development builds, names the add-on according to current date (yyyymmdd) and sets update channel to "dev".
-
-### Additional tools
-
-The template includes configuration files for use with additional tools such as linters. These include:
-
-* Flake8 (flake8.ini): a Python code linter (3.7.9 or later, can be installed with PIP).
-
-Read the documentation for the tools you wish to use when building and developing add-ons.
-
-Note that this template only provides a basic add-on structure and build infrastructure. You may need to adapt it for your specific needs such as using additional tools.
-
-If you have any issues please use the NVDA addon list mentioned above.
+``Control+NVDA+W``: Start or stop the navigation object watcher.