summaryrefslogtreecommitdiff
path: root/sw/inc/pam.hxx
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.com>2022-07-25 20:16:43 +0200
committerMiklos Vajna <vmiklos@collabora.com>2022-07-26 08:18:14 +0200
commit0c96a9ef657b12bcba6ae821b8703b433711b74b (patch)
tree27c766b14d69e2003d507e917372dcaa5e459271 /sw/inc/pam.hxx
parent9acc54e65476e405bd8d9e4bca135be968448d3c (diff)
sw: extend SwPaM documentation
Explain which one stays and which one moves while adjusting a selection. Change-Id: I05ed0a376c1e75808f39a2683345ba389a83af3d Reviewed-on: https://gerrit.libreoffice.org/c/core/+/137443 Tested-by: Jenkins Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Diffstat (limited to 'sw/inc/pam.hxx')
-rw-r--r--sw/inc/pam.hxx7
1 files changed, 6 insertions, 1 deletions
diff --git a/sw/inc/pam.hxx b/sw/inc/pam.hxx
index 68282d98ca4e..8f72eb0452e3 100644
--- a/sw/inc/pam.hxx
+++ b/sw/inc/pam.hxx
@@ -137,7 +137,12 @@ bool GoInContentCells( SwPaM&, SwMoveFnCollection const &);
bool GoInContentSkipHidden( SwPaM&, SwMoveFnCollection const &);
bool GoInContentCellsSkipHidden( SwPaM&, SwMoveFnCollection const &);
-/// PaM is Point and Mark: a selection of the document model.
+/**
+ * PaM is Point and Mark: a selection of the document model.
+ *
+ * The reason for the distinction is that the point moves around during adjusting the selection with
+ * shift-arrow keys, while the mark remains where it is.
+ */
class SAL_WARN_UNUSED SW_DLLPUBLIC SwPaM : public sw::Ring<SwPaM>
{
SwPosition m_Bound1;