Initial GUI API

Author: mnesarco

.vscode/bookmarks.json

@@ -4,89 +4,79 @@
 			"path": "fpo.py",
 			"bookmarks": [
 				{
-					"line": 19,
-					"column": 0,
-					"label": "Tags"
-				},
-				{
-					"line": 27,
+					"line": 292,
 					"column": 0,
 					"label": "Conventions"
 				},
 				{
-					"line": 40,
+					"line": 305,
 					"column": 0,
 					"label": "Imports"
 				},
 				{
-					"line": 117,
+					"line": 365,
 					"column": 0,
 					"label": "Symbol constants"
 				},
 				{
-					"line": 160,
+					"line": 408,
 					"column": 0,
 					"label": "Supported property types"
 				},
 				{
-					"line": 204,
+					"line": 449,
 					"column": 0,
 					"label": "Utility functions"
 				},
 				{
-					"line": 362,
+					"line": 607,
 					"column": 0,
 					"label": "Property"
 				},
 				{
-					"line": 476,
+					"line": 721,
 					"column": 0,
 					"label": "Display Mode"
 				},
 				{
-					"line": 663,
+					"line": 915,
 					"column": 0,
 					"label": "Type Meta"
 				},
 				{
-					"line": 820,
+					"line": 1072,
 					"column": 0,
 					"label": "Preference"
 				},
 				{
-					"line": 934,
+					"line": 1192,
 					"column": 0,
 					"label": "proxy decorator"
 				},
 				{
-					"line": 986,
+					"line": 1244,
 					"column": 0,
 					"label": "view_proxy decorator"
 				},
 				{
-					"line": 1066,
+					"line": 1324,
 					"column": 0,
 					"label": "DataProxy Templates"
 				},
 				{
-					"line": 1388,
+					"line": 1645,
 					"column": 0,
 					"label": "ViewProxy templates"
 				},
 				{
-					"line": 1626,
+					"line": 1883,
 					"column": 0,
 					"label": "Migrations"
 				},
 				{
-					"line": 1755,
+					"line": 2012,
 					"column": 0,
 					"label": "Module init"
-				},
-				{
-					"line": 1829,
-					"column": 0,
-					"label": "Global user functions"
 				}
 			]
 		}

.vscode/settings.json

@@ -1,8 +1,10 @@
 {
     "editor.rulers": [
-        80
+        80, 100, 120
     ],
     "cSpell.words": [
+        "cleartext",
+        "fcui",
         "freecad",
         "frenet",
         "getstate",
@@ -11,11 +13,17 @@
         "Muñoz",
         "pdbody",
         "pivy",
+        "pixmap",
+        "Pixmap",
+        "Preselection",
         "proxyfied",
+        "qobject",
         "scriptable",
         "setstate",
         "tmpl",
         "TransformManip",
+        "typora",
+        "unpolish",
         "unsetup",
         "vobject",
         "wireframe"
@@ -122,5 +130,16 @@
             "bold": false,
             "italic": false
         }
-    ]
+    ],
+    "[python]": {
+        "diffEditor.ignoreTrimWhitespace": false,
+        "gitlens.codeLens.symbolScopes": [
+            "!Module"
+        ],
+        "editor.formatOnType": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.wordBasedSuggestions": "off"
+    },
+    "ruff.lineLength": 100,
+    "ruff.nativeServer": true
 }

README.md

@@ -1,31 +1,56 @@
-# FreeCAD Scripted Objects Modern API
+# FreeCAD Scripting Modern APIs
 
 ## Audience
 
-This is for developers of FreeCAD extensions commonly known
-as Feature Python Objects or more generally Scripted Objects.
+This is for developers of FreeCAD extensions like Workbenches and Macros in pure
+python.
 
 This is a python API, it is expected that the readers are python developers with
-a little more than basic python coding skills. The API does not use any obscure 
-language feature but it uses classes, functions, decorators, type hints, etc...
+basic python coding skills. The API does not use any obscure language feature but
+it uses classes, functions, decorators, type hints, etc...
 
 It is also expected that the readers are FreeCAD users, and have a good understanding
 of the basic usage of it.
 
-## Deliverables
+## Scripted Object API (Feature Python Object)
+
+This API is an overlay API that helps in definition of Feature Python Objects in
+a more declarative an pythonic way.
 
 * `fpo.py `
   This is the API implementation
 * `examples/`
-  contains basic usage examples of the api
+  contains basic usage examples of the fpo api
 * `docs/`
   contains source and generated documentation
 
-## Documentation
+### Documentation
 
 * [docs/documentation.md](docs/documentation.md)
 * [docs/documentation.pdf](docs/documentation.pdf)
 
+
+## Declarative Qt/Gui API
+
+This API provides a simple way to create GUIs for the extensions without the
+complexity of raw Qt code or .ui files. Code layout reflect GUI structure making
+it readable and easy to maintain. The API covers the most common Widgets, Qt is
+a massive library so covering everything is virtually impossible for this project
+and largely unnecessary.
+
+* `fcui.py`
+  This is the GUI API implementation
+* `examples/ui/`
+  contains basic usage examples of the `fcui` api
+* `docs/`
+  contains source and generated documentation
+
+
+### Documentation
+* [docs/ui-documentation.md](docs/ui-documentation.md)
+* [docs/ui-documentation.pdf](docs/ui-documentation.pdf)
+
+
 ## Status
 
-This is a working draft as of April 05, 2024
+This is a working draft as of Nov 10, 2024