office-gobmx/svx
Hossein ea5641baee Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/

Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2021-04-07 17:47:16 +02:00
..
doc
inc update pches 2021-04-06 17:57:09 +02:00
qa tdf#141268: svx_unit: Add unittest 2021-04-06 16:23:50 +02:00
sdi
source avoid pointless O(N^2) dynamic_cast 2021-04-07 16:59:19 +02:00
uiconfig/ui fontwork: add sidebar panel 2021-04-01 17:43:04 +02:00
util
AllLangMoTarget_svx.mk
CppunitTest_svx_dialogs_test.mk
CppunitTest_svx_gallery_test.mk
CppunitTest_svx_unit.mk
Executable_gengal.mk
IwyuFilter_svx.yaml
JunitTest_svx_unoapi.mk
Library_svx.mk fontwork: add sidebar panel 2021-04-01 17:43:04 +02:00
Library_svxcore.mk
Library_textconversiondlgs.mk
Makefile
Module_svx.mk
Package_gengal.mk
README.md Updated README.md files to represent current code / use Markdown format 2021-04-07 17:47:16 +02:00
UIConfig_svx.mk fontwork: add sidebar panel 2021-04-01 17:43:04 +02:00
UITest_svx_table.mk

Graphics Related Helper Code

Contains graphics related helper code. Lots of the draw and impress code is in this shared library.

  • xoutdev

    this is where a lot of wht work would happen to move to the canvas. (what does that mean?)

  • svdraw

    transparent gradient stuff. [seriously? surely much more, too]

SdrObject

The shapes you can see in LibreOffice (like rectangle, etc.) are SdrObjects. They are declared as a hierarchy:

SdrObject <- SdrAttrObj <- E3dObject <- E3dCompoundObject <- E3dCubeObj
    ^ ^ ^             ^            ^              | | ^ ^
    | | |             |            |              | | | +--- E3dExtrudeObj
    | | |             |            |              | | +----- E3dLatheObj
    | | |             |            |              | +------- E3dPolygonObj
    | | |             |            |              +--------- E3dSphereObj
    | | |             |            +--- E3dScene...
    | | |             |
    | | |             +--- SdrTextObj <- SdrObjCustomShape...
    | | |                   ^ ^ ^ ^ ^
    | | |                   | | | | +--- SdrEdgeObj...
    | | |                   | | | +----- SdrMeasureObj...
    | | |                   | | +------- SdrPathObj...
    | | |                   | +--------- SdrRectObj...
    | | |                   +----------- SdrTableObj...
    | | +--- SdrObjGroup...
    | + ---- SdrPageObj...
    +------- SdrVirtObj...

The above is incomplete of course.

SdrModel / SdrView

Copied from svdview.hxx:

First of all the app creates a SdrModel. Then it opens a Win and creates a SdrView. ShowSdrPage() announces a page at SdrView. It's possible to show SdrView in any Wins at once.

SdrView can show as many Wins as it wants at once. Pages are announced or checked out with the help of ShowSdrPage()/HideSdrPage(). For every announced page there is a SdrPageView instance in container aPages. If more than one page is showed, you have to pay attention that the offset parameter of ShowSdrPage() is conformed to the size of the page (to prevent overlapping of two pages).

SdrView itself is inherited from many objects in a chain of inheritance (all that starts with SdrPaintView - that is itself inherited from few classes too):

SdrPaintView <- SdrSnapView <- SdrMarkView <- SdrEditView <- SdrPolyEditView
                                                                 ^
+----------------------------------------------------------------+
|
SdrGlueEditView <- SdrObjEditView <- SdrExchangeView <- SdrDragView
                                                                 ^
+----------------------------------------------------------------+
|
SdrCreateView <- SdrView

From SdrView on, it is not flat, but a real hierarchy again.

Drawing Layer / SdrObject(s)

See drawinglayer/README.md for general information about drawinglayer.

Below is the class diagram that comes from http://www.openoffice.org/marketing/ooocon2006/presentations/wednesday_g11.odp, slide number 6.

.------- Model --------------.      .------- View -----------------------------------------.
| SdrObject - ViewContact    | 1..* | ViewObjectContact                                    |
|              getChild()    |------|    getPrimitiveList()  -----> Object(s) ---> SdrView |
|              getVOC()      |      |    getRecPrimitiveList()      Contact                |
|              getViewInd... |      |________|_____________________________________________|
| ...ependentPrimitiveList() |               |
|____________________________|            generates
                                             |           ______
                                             V          /      |
                                   .----------------------.    |
                                   | basePrimitive        |    |
                                   |   getRange()         |<---'
                                   |   getDecomposition() |
                                   |______________________|

For SdrObjects, there are own DrawingLayer primitives in svx/source/sdr/primitive2d

The ViewContact / ViewObject / ViewObjectContact are in svx/source/sdr/contact Decomposes the SdrObjects, and does all sort of operations on them.

If the number of visualizable objects (e.g. SdrObjects) is X, and the number of SdrViews is Y, then:

  • there are X ViewContact instances (1:1 relation with a visualizable object)
  • there are Y ObjectContact instances (1:1 relation with an SdrView)
  • there are X*Y ViewObjecContact instances (1:N relation to both visualizable objects and SdrViews)