summaryrefslogtreecommitdiff
path: root/sw
diff options
context:
space:
mode:
authorTamás Zolnai <tamas.zolnai@collabora.com>2019-01-07 12:12:46 +0100
committerTamás Zolnai <tamas.zolnai@collabora.com>2019-01-07 19:20:34 +0100
commitb0c758b407deea0d87b51687601af48126d871c9 (patch)
treeb8d4ff704b47f68f5f8af1f91d46725a1f55fd80 /sw
parent3272c1eb5563f3bda2caa24f32b1018372622109 (diff)
Unfloat: Add documentation for new classes
Change-Id: Id7c8d5eb7f865db5db82beffe96dab605d8ae36f Reviewed-on: https://gerrit.libreoffice.org/65941 Reviewed-by: Tamás Zolnai <tamas.zolnai@collabora.com> Tested-by: Tamás Zolnai <tamas.zolnai@collabora.com>
Diffstat (limited to 'sw')
-rw-r--r--sw/source/uibase/inc/FloatingTableButton.hxx10
-rw-r--r--sw/source/uibase/inc/HeaderFooterWin.hxx4
2 files changed, 14 insertions, 0 deletions
diff --git a/sw/source/uibase/inc/FloatingTableButton.hxx b/sw/source/uibase/inc/FloatingTableButton.hxx
index b64ddfe07912..6ca99579a6f9 100644
--- a/sw/source/uibase/inc/FloatingTableButton.hxx
+++ b/sw/source/uibase/inc/FloatingTableButton.hxx
@@ -13,6 +13,16 @@
#include "FrameControl.hxx"
#include <vcl/menubtn.hxx>
+
+/** Class for unfloat table button
+ *
+ * This unfloat button is used to convert a floating table into a simple writer table embedded to the text body.
+ * This unfloat oparation is useful typically for documents imported from MSO file formats containing
+ * multi-page floating tables. In case of a multi-page table the text frame cuts off the table because
+ * the frame can't span across multiple pages. With unfloating we can get a multi-page table without
+ * floating properties.
+ *
+ */
class FloatingTableButton : public SwFrameMenuButtonBase
{
OUString m_sLabel;
diff --git a/sw/source/uibase/inc/HeaderFooterWin.hxx b/sw/source/uibase/inc/HeaderFooterWin.hxx
index 33a49c2d52e3..dc076f87574e 100644
--- a/sw/source/uibase/inc/HeaderFooterWin.hxx
+++ b/sw/source/uibase/inc/HeaderFooterWin.hxx
@@ -15,6 +15,10 @@
#include <vcl/timer.hxx>
#include <drawinglayer/primitive2d/baseprimitive2d.hxx>
+/**
+ * Button painter helper class used to paint a runtime button positioned to a writer frame.
+ * See header/footer button.
+ */
class SwFrameButtonPainter
{
public: