office-gobmx/svx
Justin Luth ec6d1156b7 document svx.sdi with link to SDI slot config details
UI stuff is a total black box,
so most of the config is just copy/pasted from a similar function,
with nothing to indicate what any of it means or does.

Miklos pointed me to this documentation,
so I've dumped it here so that there are a few breadcrumbs
pointing to the specs for what this stuff means.

Change-Id: Iccbc0ff5b400328af8ae683fdcf42203e4029d48
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/145624
Tested-by: Jenkins
Reviewed-by: Justin Luth <jluth@mail.com>
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
2023-01-18 14:13:52 +00:00
..
doc
inc introduce docmodel comp., model::ThemeColor, use it in SvxColorItem 2023-01-12 23:15:58 +00:00
qa Removed executable bits on source file 2023-01-14 22:46:45 +00:00
sdi document svx.sdi with link to SDI slot config details 2023-01-18 14:13:52 +00:00
source XUnoTunnel->dynamic_cast in FmXFilterCell 2023-01-18 11:58:38 +00:00
uiconfig/ui ThemeDialog added which allows to change the theme used by the doc. 2023-01-14 12:26:15 +00:00
util
AllLangMoTarget_svx.mk
CppunitTest_svx_core.mk
CppunitTest_svx_dialogs_test.mk
CppunitTest_svx_gallery_test.mk
CppunitTest_svx_removewhichrange.mk introduce docmodel comp., model::ThemeColor, use it in SvxColorItem 2023-01-12 23:15:58 +00:00
CppunitTest_svx_styles.mk introduce docmodel comp., model::ThemeColor, use it in SvxColorItem 2023-01-12 23:15:58 +00:00
CppunitTest_svx_unit.mk introduce docmodel comp., model::ThemeColor, use it in SvxColorItem 2023-01-12 23:15:58 +00:00
Executable_gengal.mk
IwyuFilter_svx.yaml
JunitTest_svx_unoapi.mk
Library_svx.mk ThemeDialog added which allows to change the theme used by the doc. 2023-01-14 12:26:15 +00:00
Library_svxcore.mk introduce docmodel comp., model::ThemeColor, use it in SvxColorItem 2023-01-12 23:15:58 +00:00
Library_textconversiondlgs.mk
Makefile
Module_svx.mk
Package_gengal.mk
README.md
UIConfig_svx.mk ThemeDialog added which allows to change the theme used by the doc. 2023-01-14 12:26:15 +00: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 https://web.archive.org/web/20160827020830if_/http://www.openoffice.org:80/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 ViewObjectContact instances (1:N relation to both visualizable objects and SdrViews)