sw/inc/SwNodeNum.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
  20 #ifndef INCLUDED_SW_INC_SWNODENUM_HXX
  21 #define INCLUDED_SW_INC_SWNODENUM_HXX
  22
  23 #include "SwNumberTree.hxx"
  24
  25 class SwTextNode;
  26 struct SwPosition;
  27 class SwNumRule;
  28
  29 class SAL_DLLPUBLIC_RTTI SwNodeNum : public SwNumberTreeNode
  30 {
  31 public:
  32
  33     explicit SwNodeNum( SwTextNode* pTextNode, bool isHiddenRedlines );
  34     // note: this is only for creating phantom nodes and root nodes; these
  35     // never have a text node
  36     explicit SwNodeNum( SwNumRule* pNumRule );
  37     virtual ~SwNodeNum() override;
  38
  39     SwNumRule* GetNumRule() const { return mpNumRule;}
  40     void ChangeNumRule( SwNumRule& rNumRule );
  41     SwTextNode* GetTextNode() const { return mpTextNode;}
  42
  43     virtual bool IsNotificationEnabled() const override;
  44
  45     virtual bool IsContinuous() const override;
  46
  47     virtual bool IsCounted() const override;
  48
  49     virtual bool LessThan(const SwNumberTreeNode & rNode) const override;
  50
  51     virtual bool IsRestart() const override;
  52
  53     virtual SwNumberTree::tSwNumTreeNumber GetStartValue() const override;
  54
  55     SwPosition GetPosition() const;
  56
  57     // The number tree root node is deleted, when the corresponding numbering
  58     // rule is deleted. In this situation the number tree should be empty -
  59     // still registered text nodes aren't allowed. But it is possible, that
  60     // text nodes of the undo nodes array are still registered. These will be
  61     // unregistered.
  62     // Text nodes of the document nodes array aren't allowed to be registered
  63     // in this situation - this will be asserted.
  64     static void HandleNumberTreeRootNodeDelete( SwNodeNum& rNodeNum );
  65
  66     /** determines the <SwNodeNum> instance, which is preceding the given text node
  67
  68         #i81002#
  69     */
  70     const SwNodeNum* GetPrecedingNodeNumOf( const SwTextNode& rTextNode ) const;
  71
  72 protected:
  73     virtual SwNumberTreeNode * Create() const override;
  74
  75     // --> #i64010#
  76     virtual bool HasCountedChildren() const override;
  77     virtual bool IsCountedForNumbering() const override;
  78
  79     // method called before this tree node has been added to the list tree
  80     virtual void PreAdd() override;
  81     // method called at a child after this child has been removed from the list tree
  82     virtual void PostRemove() override;
  83 private:
  84     SwTextNode *const mpTextNode;
  85     SwNumRule * mpNumRule;
  86     bool m_isHiddenRedlines;
  87
  88     static void UnregisterMeAndChildrenDueToRootDelete( SwNodeNum& rNodeNum );
  89
  90     SwNodeNum( const SwNodeNum& ) = delete;
  91     SwNodeNum& operator=( const SwNodeNum& ) = delete;
  92
  93     virtual bool IsCountPhantoms() const override;
  94
  95     virtual bool IsNotifiable() const override;
  96
  97     virtual void NotifyNode() override;
  98 };
  99
 100 #endif // INCLUDED_SW_INC_SWNODENUM_HXX
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */