[Libreoffice-commits] .: vcl/README

[Michael Meeks]

 vcl/README |   21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

New commits:
commit 802d82b6e2acedd3581acbf23407d7f5f742c671
Author: Michael Meeks <michael.meeks at suse.com>
Date:   Tue Jan 17 18:03:12 2012 +0000

    vcl: expand the documentation in README

diff --git a/vcl/README b/vcl/README
index 9e9507c..97ff76a 100644
--- a/vcl/README
+++ b/vcl/README
@@ -19,10 +19,29 @@ win/
 	+ windows backend
 unx/
 	+ unix specific platform backend code and its' sub-platforms
+	plugadapt/
+		+ pluggable framework to select correct unx backend
 	gtk/
+		+ gtk2 support
 	gtk3/
+		+ gtk3.2+ support
 	kde/
-	generic/  - raw X
+		+ kde3 support
+	kde4/
+		+ kde4 support
+	generic/
+		+ raw X support
 
 
+How the platform abstraction works
 
+	+ InitVCL calls 'CreateSalInstance'
+		+ ths is implemented by the compiled-in platform backend
+		+ it stores various bits of global state in the
+		  'SalData' (inc/saldatabasic.hxx) structure but:
+	+ the SalInstance vtable is the primary outward facing gateway
+	  API for platform backends
+		+ It is a factory for:
+		  SalFrames, SalVirtualDevices, SalPrinters,
+		  Timers, the SolarMutexe, Drag&Drop and other
+		  objects, as well as the primary event loop wrapper.