sw/inc/fmtfsize.hxx | 9 +++++++++
1 file changed, 9 insertions(+)
New commits:
commit cbd16c4dc4cfb9155fd7f3899866e4f8156140a0
Author: Miklos Vajna <vmik...@collabora.com>
AuthorDate: Mon Nov 20 20:08:17 2023 +0100
Commit: Miklos Vajna <vmik...@collabora.com>
CommitDate: Tue Nov 21 08:25:13 2023 +0100
sw: document SwFormatFrameSize
Where this can appear, size type, percent relations.
Change-Id: I7afddd033e8a8842c99dcb3d9604a2cb75ad6d92
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/159743
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmik...@collabora.com>
diff --git a/sw/inc/fmtfsize.hxx b/sw/inc/fmtfsize.hxx
index 9f8676c87dda..66aea1e78e50 100644
--- a/sw/inc/fmtfsize.hxx
+++ b/sw/inc/fmtfsize.hxx
@@ -40,6 +40,15 @@ enum class SwFrameSize
(can be exceeded but not be less). */
};
+/**
+ * Describes the size of a Writer frame, for example a table, table row, table
cell, TextFrame,
+ * page, etc.
+ *
+ * The height and width can be either relative or absolute, see SwFrameSize.
+ *
+ * If the size is relative, then the "relation" decides what 100% means, e.g.
it may be relative to
+ * the page size of the parent frame size.
+ */
class SW_DLLPUBLIC SwFormatFrameSize final : public SvxSizeItem
{
SwFrameSize m_eFrameHeightType;
