diff options
| author | Miklos Vajna <vmiklos@collabora.co.uk> | 2017-09-04 12:09:42 +0200 |
|---|---|---|
| committer | Miklos Vajna <vmiklos@collabora.co.uk> | 2017-09-04 12:11:30 +0200 |
| commit | bbcd952c062288d9ee1efe9c786c2146abf457ea (patch) | |
| tree | e1df171dd1cde86093930923e758bcbe2c0ab978 /sw/README | |
| parent | 621c1201f7346eba62d75cf119ec33e7e5f327f0 (diff) | |
sw: document the "leaf" layout concept
For some reason this is missing from the usual wiki pages.
Change-Id: I2c3dcce983053452dc9fd1e886f8169678d7e6a4
Diffstat (limited to 'sw/README')
| -rw-r--r-- | sw/README | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/sw/README b/sw/README index 60de27ba4ccd..54feb78fa7d1 100644 --- a/sw/README +++ b/sw/README @@ -197,3 +197,15 @@ There are multiple model classes involved for fields: Note that there is no UNO service to represent a list. +=== Layout === + +The layout is a tree of SwFrame subclasses, the following relationships are +possible between frames: + +- You can visit the tree by following the upper, lower, next and previous pointers. +- The functionality of flowing of a frame across multiple parents (e.g. pages) + is implemented in SwFlowFrame, which is not an SwFrame subclass. The logical + chain of such frames can be visited using the follow and precede pointers. + ("Leaf" is a term that refers to such a relationship.) +- In case a frame is split into multiple parts, then the first one is called + master, while the others are called follows. |