sw/inc/ftninfo.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_INC_FTNINFO_HXX
  20 #define INCLUDED_SW_INC_FTNINFO_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include "swdllapi.h"
  24 #include <calbck.hxx>
  25 #include <editeng/numitem.hxx>
  26 #include <fmtcol.hxx>
  27
  28 class SwTextFormatColl;
  29 class SwPageDesc;
  30 class SwCharFormat;
  31 class SwDoc;
  32
  33 class SW_DLLPUBLIC SwEndNoteInfo : public SwClient
  34 {
  35     SwDepend    aPageDescDep;
  36     SwDepend    aCharFormatDep, aAnchorCharFormatDep;
  37     OUString sPrefix;
  38     OUString sSuffix;
  39 protected:
  40     bool        m_bEndNote;
  41    virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem* pNew ) SAL_OVERRIDE;
  42
  43 public:
  44     SvxNumberType aFormat;
  45     sal_uInt16    nFootnoteOffset;
  46
  47     void        ChgPageDesc( SwPageDesc *pDesc );
  48     SwPageDesc* GetPageDesc( SwDoc &rDoc ) const;
  49     bool        KnowsPageDesc() const;
  50     bool        DependsOn( const SwPageDesc* ) const;
  51
  52     void SetFootnoteTextColl(SwTextFormatColl& rColl);
  53     SwTextFormatColl* GetFootnoteTextColl() const { return const_cast<SwTextFormatColl*>(static_cast<const SwTextFormatColl*>(GetRegisteredIn())); } // can be 0.
  54
  55     SwCharFormat* GetCharFormat(SwDoc &rDoc) const;
  56     void SetCharFormat( SwCharFormat* );
  57     SwClient   *GetCharFormatDep() const { return (SwClient*)&aCharFormatDep; }
  58
  59     SwCharFormat* GetAnchorCharFormat(SwDoc &rDoc) const;
  60     void SetAnchorCharFormat( SwCharFormat* );
  61     SwClient   *GetAnchorCharFormatDep() const { return (SwClient*)&aAnchorCharFormatDep; }
  62
  63     SwEndNoteInfo & operator=(const SwEndNoteInfo&);
  64     bool operator==( const SwEndNoteInfo &rInf ) const;
  65
  66     SwEndNoteInfo( SwTextFormatColl *pTextColl = 0);
  67     SwEndNoteInfo(const SwEndNoteInfo&);
  68
  69     const OUString& GetPrefix() const  { return sPrefix; }
  70     const OUString& GetSuffix() const  { return sSuffix; }
  71
  72     void SetPrefix(const OUString& rSet) { sPrefix = rSet; }
  73     void SetSuffix(const OUString& rSet) { sSuffix = rSet; }
  74     void ReleaseCollection() { if ( GetRegisteredInNonConst() ) GetRegisteredInNonConst()->Remove( this ); }
  75 };
  76
  77 enum SwFootnotePos
  78 {
  79     // Momentarily only PAGE and CHAPTER. CHAPTER == document-endnotes.
  80     FTNPOS_PAGE = 1,
  81     FTNPOS_CHAPTER = 8
  82 };
  83
  84 enum SwFootnoteNum
  85 {
  86     FTNNUM_PAGE, FTNNUM_CHAPTER, FTNNUM_DOC
  87 };
  88
  89 class SW_DLLPUBLIC SwFootnoteInfo: public SwEndNoteInfo
  90 {
  91     using SwEndNoteInfo::operator ==;
  92
  93 public:
  94     OUString  aQuoVadis;
  95     OUString  aErgoSum;
  96     SwFootnotePos  ePos;
  97     SwFootnoteNum  eNum;
  98
  99     SwFootnoteInfo& operator=(const SwFootnoteInfo&);
 100
 101     bool operator==( const SwFootnoteInfo &rInf ) const;
 102
 103     SwFootnoteInfo(SwTextFormatColl* pTextColl = 0);
 104     SwFootnoteInfo(const SwFootnoteInfo&);
 105 };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */