summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.com>2021-03-05 16:59:40 +0100
committerMiklos Vajna <vmiklos@collabora.com>2021-03-05 21:04:42 +0100
commit8be34ca25e966f32d99dca8df9177cebea180225 (patch)
treec1e96fc6606369017ff5e187d13e805889abbb15
parent184bd73ef0ed802489a90b4dc6d214db784e68bb (diff)
sw: document the difference between SwDrawVirtObj and SwVirtFlyDrawObj
It confused me that SwVirtFlyDrawObj is used even with single-page documents, while SwDrawVirtObj is only used with multi-page documents. Change-Id: I22110d1dd7bf87631c1690f2aa212ded688300c3 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/112022 Reviewed-by: Miklos Vajna <vmiklos@collabora.com> Tested-by: Jenkins
-rw-r--r--sw/inc/dcontact.hxx6
-rw-r--r--sw/source/core/inc/dflyobj.hxx2
2 files changed, 6 insertions, 2 deletions
diff --git a/sw/inc/dcontact.hxx b/sw/inc/dcontact.hxx
index 539819ec1e14..3346b3a00443 100644
--- a/sw/inc/dcontact.hxx
+++ b/sw/inc/dcontact.hxx
@@ -170,7 +170,7 @@ public:
};
/** ContactObject for connection between frames (or their formats respectively)
- in SwClient and the drawobjects of Drawing (DsrObjUserCall). */
+ in SwClient and the drawobjects of Drawing (SdrObjUserCall). */
class SW_DLLPUBLIC SwFlyDrawContact final : public SwContact
{
@@ -206,7 +206,9 @@ public:
};
/** new class for re-direct methods calls at a 'virtual'
- drawing object to its referenced object. */
+ drawing object to its referenced object.
+ For example, if an SdrObject is anchored in a header, then later pages will have a SwDrawVirtObj
+ in later headers. */
class SwDrawVirtObj final : public SdrVirtObj
{
private:
diff --git a/sw/source/core/inc/dflyobj.hxx b/sw/source/core/inc/dflyobj.hxx
index 11df846f0dc1..682a77e84aef 100644
--- a/sw/source/core/inc/dflyobj.hxx
+++ b/sw/source/core/inc/dflyobj.hxx
@@ -55,6 +55,8 @@ public:
// virtual objects for Flys
// Flys will always be shown with virtual objects. By doing that, they can be
// shown multiple times if needed (header/footer).
+// For example, if an SwFlyFrameFormat is anchored in a header, then all pages will have a separate
+// SwVirtFlyDrawObj in their headers.
class SwVirtFlyDrawObj final : public SdrVirtObj
{
private: