office-gobmx/sw/inc/ftninfo.hxx
Miklos Vajna 90f19126fa tdf#160984 sw continuous endnotes: introduce an endnote section
Word lays out endnotes at the end of the document inline after body
text, Writer puts them on one or more separate endnote pages.

There was already an attempt in the past to resolve this difference, see
commit 4814e8caa5 (tdf#124601 sw: add
ContinuousEndnotes layout compat option, 2019-09-30). The approach back
then was to map such endnotes to footnotes, so the extra, unwanted page
doesn't appear. This turned out to be not working too well, the compat
option is only enabled for DOC, and even there commit
dc11f5b151 (tdf#143445 DOC import: limit
the usage of the CONTINUOUS_ENDNOTES compat flag, 2023-05-23) limited
the usage of the compat flag to 1 or 2 endnotes only.

Coming back to this, try a new approach: create a section that more or
less exists only at a layout level and put endnotes into that section.
This allows reusing all the complex logic on how to lay out endnotes
inline, on one or more pages. The plan is that this new approach is more
robust, can replace the old continuous endnotes layout code and then can
be enabled for DOCX as well.

This commit just introduces the backing section format and SwSection for
that special "endnotes section" (it's special because SwSection is
usually owned by an SwSectionNode, but here there is no doc model node
for the SwSection), SwFootnoteBossFrame::AppendFootnote() doesn't try to
use the new SwEndNoteInfo::GetSwSection() yet.

Change-Id: Ib32f04ceb6f46c682a5d36bdcea206d2c4017227
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/167305
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins
2024-05-08 12:49:04 +02:00

115 lines
3.4 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SW_INC_FTNINFO_HXX
#define INCLUDED_SW_INC_FTNINFO_HXX
#include <rtl/ustring.hxx>
#include "swdllapi.h"
#include "calbck.hxx"
#include <editeng/numitem.hxx>
class SwTextFormatColl;
class SwPageDesc;
class SwCharFormat;
class SwDoc;
class SwSection;
class SW_DLLPUBLIC SwEndNoteInfo : public SwClient
{
mutable sw::WriterMultiListener m_aDepends;
mutable SwTextFormatColl* m_pTextFormatColl;
mutable SwPageDesc* m_pPageDesc;
mutable std::unique_ptr<SwSection> m_pSwSection;
mutable SwCharFormat* m_pCharFormat;
mutable SwCharFormat* m_pAnchorFormat;
OUString m_sPrefix;
OUString m_sSuffix;
protected:
bool m_bEndNote;
virtual void SwClientNotify( const SwModify&, const SfxHint&) override;
public:
SvxNumberType m_aFormat;
sal_uInt16 m_nFootnoteOffset;
void ChgPageDesc(SwPageDesc* pDesc);
SwPageDesc* GetPageDesc(SwDoc& rDoc) const;
bool KnowsPageDesc() const;
bool DependsOn(const SwPageDesc*) const;
SwSection* GetSwSection(SwDoc& rDoc) const;
void ResetSwSection();
void SetFootnoteTextColl(SwTextFormatColl& rColl);
SwTextFormatColl* GetFootnoteTextColl() const { return m_pTextFormatColl; } // can be 0.
SwCharFormat* GetCharFormat(SwDoc &rDoc) const;
void SetCharFormat( SwCharFormat* );
SwCharFormat* GetAnchorCharFormat(SwDoc &rDoc) const;
void SetAnchorCharFormat(SwCharFormat*);
SwCharFormat* GetCurrentCharFormat(const bool bAnchor) const;
SwEndNoteInfo & operator=(const SwEndNoteInfo&);
bool operator==( const SwEndNoteInfo &rInf ) const;
SwEndNoteInfo();
SwEndNoteInfo(const SwEndNoteInfo&);
const OUString& GetPrefix() const { return m_sPrefix; }
const OUString& GetSuffix() const { return m_sSuffix; }
void SetPrefix(const OUString& rSet) { m_sPrefix = rSet; }
void SetSuffix(const OUString& rSet) { m_sSuffix = rSet; }
void UpdateFormatOrAttr();
};
enum SwFootnotePos
{
// Momentarily only PAGE and CHAPTER. CHAPTER == document-endnotes.
FTNPOS_PAGE = 1,
FTNPOS_CHAPTER = 8
};
enum SwFootnoteNum : unsigned
{
FTNNUM_PAGE, FTNNUM_CHAPTER, FTNNUM_DOC
};
class SW_DLLPUBLIC SwFootnoteInfo final : public SwEndNoteInfo
{
using SwEndNoteInfo::operator ==;
public:
OUString m_aQuoVadis;
OUString m_aErgoSum;
SwFootnotePos m_ePos;
SwFootnoteNum m_eNum;
SwFootnoteInfo& operator=(const SwFootnoteInfo&);
bool operator==( const SwFootnoteInfo &rInf ) const;
SwFootnoteInfo();
SwFootnoteInfo(const SwFootnoteInfo&);
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */