sw/inc/SwNodeNum.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SwNodeNum.hxx,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SW_NODE_NUM_HXX
  32 #define _SW_NODE_NUM_HXX
  33
  34 #include <SwNumberTree.hxx>
  35
  36 class SwTxtNode;
  37 struct SwPosition;
  38 class SwNumRule;
  39 class SwNumFmt;
  40
  41 class SW_DLLPUBLIC SwNodeNum : public SwNumberTreeNode
  42 {
  43 public:
  44     // --> OD 2008-02-19 #refactorlists#
  45     explicit SwNodeNum( SwTxtNode* pTxtNode );
  46     explicit SwNodeNum( SwNumRule* pNumRule );
  47     // <--
  48     virtual ~SwNodeNum();
  49
  50     SwNumRule* GetNumRule() const;
  51     void ChangeNumRule( SwNumRule& rNumRule );
  52     SwTxtNode* GetTxtNode() const;
  53
  54     virtual bool IsNotificationEnabled() const;
  55
  56     virtual bool IsContinuous() const;
  57
  58     virtual bool IsCounted() const;
  59
  60     virtual bool LessThan(const SwNumberTreeNode & rNode) const;
  61
  62     virtual bool IsRestart() const;
  63
  64     virtual SwNumberTree::tSwNumTreeNumber GetStartValue() const;
  65
  66 //    String ToString() const;
  67
  68     SwPosition GetPosition() const;
  69
  70     // --> OD 2006-03-07 #131436#
  71     // The number tree root node is deleted, when the corresponding numbering
  72     // rule is deleted. In this situation the number tree should be empty -
  73     // still registered text nodes aren't allowed. But it is possible, that
  74     // text nodes of the undo nodes array are still registered. These will be
  75     // unregistered.
  76     // Text nodes of the document nodes array aren't allowed to be registered
  77     // in this situation - this will be asserted.
  78     static void HandleNumberTreeRootNodeDelete( SwNodeNum& rNodeNum );
  79     // <--
  80
  81     /** determines the <SwNodeNum> instance, which is preceding the given text node
  82
  83         OD 2007-09-06 #i81002#
  84
  85         @author OD
  86     */
  87     const SwNodeNum* GetPrecedingNodeNumOf( const SwTxtNode& rTxtNode ) const;
  88
  89 protected:
  90     virtual SwNumberTreeNode * Create() const;
  91
  92     // --> OD 2006-04-26 #i64010#
  93     virtual bool HasCountedChildren() const;
  94     virtual bool IsCountedForNumbering() const;
  95     // <--
  96
  97     // --> OD 2008-02-19 #refactorlists#
  98     // method called before this tree node has been added to the list tree
  99     virtual void PreAdd();
 100     // method called at a child after this child has been removed from the list tree
 101     virtual void PostRemove();
 102     // <--
 103 private:
 104     SwTxtNode * mpTxtNode;
 105     SwNumRule * mpNumRule;
 106
 107     // --> OD 2006-03-07 #131436#
 108     static void _UnregisterMeAndChildrenDueToRootDelete( SwNodeNum& rNodeNum );
 109     // <--
 110
 111     SwNodeNum( const SwNodeNum& );              // no copy constructor
 112     SwNodeNum& operator=( const SwNodeNum& );   // no assignment operator
 113
 114     virtual bool IsCountPhantoms() const;
 115
 116     virtual bool IsNotifiable() const;
 117
 118     virtual void NotifyNode();
 119 };
 120
 121 #endif // _SW_NODE_NUM_HXX