diff options
author | Miklos Vajna <vmiklos@collabora.co.uk> | 2018-09-28 12:31:09 +0200 |
---|---|---|
committer | Miklos Vajna <vmiklos@collabora.co.uk> | 2018-09-28 18:41:50 +0200 |
commit | 35aafd712b2c183a25721a3227f527a8fdf4df90 (patch) | |
tree | cc171205191bc67a6a1c2133bc4c6ef76efdcae8 /sw/source | |
parent | 1a35fd6fb42a02c73050a281fb7b00ac4a3d0379 (diff) |
sw layout-level redline hiding: add more doxygen documentation
Thanks Michael Stahl for the conference talk that was the input for
these.
Change-Id: Ia48248f4739218ee7832559353aab06183a934d7
Reviewed-on: https://gerrit.libreoffice.org/61079
Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk>
Tested-by: Jenkins
Diffstat (limited to 'sw/source')
-rw-r--r-- | sw/source/core/inc/DocumentRedlineManager.hxx | 4 | ||||
-rw-r--r-- | sw/source/core/inc/TextFrameIndex.hxx | 6 | ||||
-rw-r--r-- | sw/source/core/inc/rootfrm.hxx | 4 |
3 files changed, 14 insertions, 0 deletions
diff --git a/sw/source/core/inc/DocumentRedlineManager.hxx b/sw/source/core/inc/DocumentRedlineManager.hxx index 518c7e601643..c25abf25d394 100644 --- a/sw/source/core/inc/DocumentRedlineManager.hxx +++ b/sw/source/core/inc/DocumentRedlineManager.hxx @@ -33,6 +33,10 @@ class DocumentRedlineManager : public IDocumentRedlineAccess public: DocumentRedlineManager( SwDoc& i_rSwdoc ); + /** + * Replaced by SwRootFrame::IsHideRedlines() (this is model-level redline + * hiding). + */ virtual RedlineFlags GetRedlineFlags() const override; virtual void SetRedlineFlags_intern(/*[in]*/RedlineFlags eMode) override; diff --git a/sw/source/core/inc/TextFrameIndex.hxx b/sw/source/core/inc/TextFrameIndex.hxx index 8c660ec80d07..d15fc7bf6691 100644 --- a/sw/source/core/inc/TextFrameIndex.hxx +++ b/sw/source/core/inc/TextFrameIndex.hxx @@ -16,6 +16,12 @@ #if 0 typedef o3tl::strong_int<sal_Int32, struct Tag_TextFrameIndex> TextFrameIndex; #else +/** + * Denotes a character index in a text frame at a layout level, after extent + * mapping from a text node at a document model level. + * + * @see SwTextFrame::MapViewToModelPos(). + */ typedef sal_Int32 TextFrameIndex; #endif diff --git a/sw/source/core/inc/rootfrm.hxx b/sw/source/core/inc/rootfrm.hxx index 7824d4ff5eca..aee70da5029f 100644 --- a/sw/source/core/inc/rootfrm.hxx +++ b/sw/source/core/inc/rootfrm.hxx @@ -403,6 +403,10 @@ public: void RemovePage( SwPageFrame **pDel, SwRemoveResult eResult ); + /** + * Replacement for sw::DocumentRedlineManager::GetRedlineFlags() + * (this is layout-level redline hiding). + */ bool IsHideRedlines() const { return mbHideRedlines; } void SetHideRedlines(bool); }; |