summaryrefslogtreecommitdiff
path: root/sfx2/README.md
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-23 14:20:32 +0430
committerChristian Lohmaier <lohmaier+LibreOffice@googlemail.com>2021-03-24 11:46:14 +0100
commitc16158772d64cab8a4ed1f165cab57d307998e78 (patch)
tree424f72af3b4a877ecb9493cd64de70e4925a9bee /sfx2/README.md
parentea184837a54fc85599d78baf59c83b6cf8bd0adb (diff)
Using .md extension/Markdown syntax for modules README
Renaming all README files for all top level modules to README.md, applying no content change at this stage to be able to track history of the files. These files should be edited to use correct Markdown syntax later. Change-Id: I542fa3f3d32072156f16eaad2211a397cc212665 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/112977 Tested-by: Jenkins Reviewed-by: Christian Lohmaier <lohmaier+LibreOffice@googlemail.com>
Diffstat (limited to 'sfx2/README.md')
-rw-r--r--sfx2/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/sfx2/README.md b/sfx2/README.md
new file mode 100644
index 000000000000..9726870a6019
--- /dev/null
+++ b/sfx2/README.md
@@ -0,0 +1,28 @@
+SFX is the "old" framework, used for historical reasons.
+
+An attempt of documentation of this module is located in [git:sfx2/doc].
+
+It contains base classes for document model, view and controller, used
+by "old" applications like sw, sc, sd (while "new" applications
+are based on the "new" UNO based framework in "framework").
+
+The SFX framework is based on dispatching slots identified by integers
+(SlotIDs) to SfxShells, and there is a dedicated IDL compiler (svidl)
+involved that generates C++ slot headers from SDI files in modules' sdi/
+subdirectory.
+
+Documentation about SFX dispatch, SDI etc.:
+https://wiki.openoffice.org/wiki/Framework/Article/Implementation_of_the_Dispatch_API_In_SFX2
+
+Document load/save code is maintained in [git:sfx2/source/doc/docfile.cxx]
+SfxMedium class, which handles all the twisty load and save corner cases.
+
+[git:sfx2/source/appl/sfxhelp.cxx] Start procedure for the online
+help viewer top level window; handling of help URL creation and
+dispatch.
+
+There are also some UNO services here that could really be implemented
+anywhere, e.g. the DocumentProperties or DocumentMetadataAccess.
+
+Notable files:
+sfx2/source/dialog/backingwindow.cxx Startcenter buttons and the corresponding event handler.