summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.com>2022-05-16 20:04:53 +0200
committerMiklos Vajna <vmiklos@collabora.com>2022-05-17 08:16:46 +0200
commit566afb5fdf01ca0d7054af6a6355b91c10379b79 (patch)
tree876943a43a651d0af518185530562c892ce79133
parent8a29fb309878ccf4ad880b02d544ddf4e207116c (diff)
sw: document SwEditShell::InsertTable()
How it interacts with SwCursorShell::MoveTable() is far from trivial. Change-Id: I04c9123c0b39192df43fe32984d66852102ebd1d Reviewed-on: https://gerrit.libreoffice.org/c/core/+/134410 Tested-by: Jenkins Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
-rw-r--r--sw/inc/editsh.hxx5
1 files changed, 5 insertions, 0 deletions
diff --git a/sw/inc/editsh.hxx b/sw/inc/editsh.hxx
index 9439d8a777e0..db21aaaa658c 100644
--- a/sw/inc/editsh.hxx
+++ b/sw/inc/editsh.hxx
@@ -710,6 +710,11 @@ public:
/// For Inserting SoftHyphen. Position is offset within the syllabificated word.
static void InsertSoftHyph( const sal_Int32 nHyphPos );
+ /**
+ * Inserts an nRows x nCols table to the document at the current position. Unlike the UI, this
+ * function does not move the user's cursor to the first cell of the just inserted table, use
+ * `MoveTable(GotoPrevTable, fnTableStart)` to do that.
+ */
const SwTable& InsertTable( const SwInsertTableOptions& rInsTableOpts, ///< All
sal_uInt16 nRows, sal_uInt16 nCols,
const SwTableAutoFormat* pTAFormat = nullptr );