diff options
| author | Miklos Vajna <vmiklos@collabora.com> | 2020-06-05 11:03:01 +0200 |
|---|---|---|
| committer | Miklos Vajna <vmiklos@collabora.com> | 2020-06-05 12:59:07 +0200 |
| commit | 55a28d5d8edfb3f0f42bab497718bdfe22113d48 (patch) | |
| tree | 64430abc1019bbeaf58e9a51a3c35195757f783f /include | |
| parent | cf234676134ff225ea60d708d215a418975e67b7 (diff) | |
sfx2: add doxygen doc for SfxViewShell
And link SfxObjectShell <-> SfxViewShell with each other to help
understanding what they do.
Change-Id: I7db2d609deaa89061449b72e4c4d8736447685c7
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/95579
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins
Diffstat (limited to 'include')
| -rw-r--r-- | include/sfx2/objsh.hxx | 1 | ||||
| -rw-r--r-- | include/sfx2/viewsh.hxx | 4 |
2 files changed, 5 insertions, 0 deletions
diff --git a/include/sfx2/objsh.hxx b/include/sfx2/objsh.hxx index be90b2bfa18f..98a00a44b3cb 100644 --- a/include/sfx2/objsh.hxx +++ b/include/sfx2/objsh.hxx @@ -167,6 +167,7 @@ enum class SfxObjectCreateMode The class SfxObjectShell is the base class for SFx-objects, ie documents and parts of documents that can be integrated as separate objects into foreign objects. + There can be multiple edit windows (SfxViewShell) for one SfxObjectShell. */ struct TransferableObjectDescriptor; diff --git a/include/sfx2/viewsh.hxx b/include/sfx2/viewsh.hxx index d4d7d2039c2c..ce2297ed3f9c 100644 --- a/include/sfx2/viewsh.hxx +++ b/include/sfx2/viewsh.hxx @@ -146,6 +146,10 @@ template<class T> bool checkSfxViewShell(const SfxViewShell* pShell) return dynamic_cast<const T*>(pShell) != nullptr; } +/** + * One SfxViewShell more or less represents one edit window for a document, there can be multiple + * ones for a single opened document (SfxObjectShell). + */ class SFX2_DLLPUBLIC SfxViewShell: public SfxShell, public SfxListener, public OutlinerViewShell, public vcl::ILibreOfficeKitNotifier { friend class SfxViewFrame; |