SwNumberTree.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
 
#pragma once
 
#include <set>
#include <vector>
#include "SwNumberTreeTypes.hxx"
 
class SwDoc;
class SwNumberTreeNode;
 
bool SwNumberTreeNodeLessThan(const SwNumberTreeNode* pA, const SwNumberTreeNode* pB);
 
struct compSwNumberTreeNodeLessThan
{
    bool operator()(const SwNumberTreeNode* pA, const SwNumberTreeNode* pB) const
    {
        return SwNumberTreeNodeLessThan(pA, pB);
    }
};
 
class SAL_DLLPUBLIC_RTTI SwNumberTreeNode
{
protected:
    typedef std::set<SwNumberTreeNode*, compSwNumberTreeNodeLessThan> tSwNumberTreeChildren;
 
public:
    SwNumberTreeNode();
 
    virtual ~SwNumberTreeNode();
 
    void AddChild(SwNumberTreeNode* pChild, const int nDepth, const SwDoc& rDoc);
 
    void RemoveChild(SwNumberTreeNode* pChild, const SwDoc& rDoc);
 
    void RemoveMe(const SwDoc& rDoc);
 
    SwNumberTreeNode* GetParent() const { return mpParent; }
 
    SwNumberTree::tSwNumTreeNumber GetNumber(bool bValidate = true) const;
 
    bool IsContinueingPreviousSubTree() const { return mbContinueingPreviousSubTree; }
 
    SwNumberTree::tNumberVector GetNumberVector() const;
 
    virtual bool IsRestart() const = 0;
 
    virtual SwNumberTree::tSwNumTreeNumber GetStartValue() const = 0;
 
    virtual bool IsCounted() const;
 
    virtual bool IsContinuous() const = 0;
 
    bool IsFirst(const SwNumberTreeNode* pNode) const;
 
    bool IsFirst() const;
 
    bool IsPhantom() const { return mbPhantom; }
 
    void SetLevelInListTree(const int nLevel, const SwDoc& rDoc);
 
    int GetLevelInListTree() const;
 
    virtual bool LessThan(const SwNumberTreeNode& rTreeNode) const;
 
    void InvalidateTree() const;
 
    void NotifyInvalidChildren(const SwDoc& rDoc);
 
    void InvalidateMe();
 
    void ValidateMe();
 
    void NotifyInvalidSiblings(const SwDoc& rDoc);
 
    void NotifyNodesOnListLevel(const int nListLevel);
 
    void InvalidateAndNotifyTree(const SwDoc& rDoc)
    {
        if (GetRoot())
        {
            GetRoot()->InvalidateTree();
            GetRoot()->Notify(rDoc);
        }
    }
 
    SwNumberTreeNode* GetPred(bool bSibling = false) const;
 
    const SwNumberTreeNode* GetPrecedingNodeOf(const SwNumberTreeNode& rNode) const;
 
#ifdef DBG_UTIL
    void IsSane(bool bRecursive) const;
#endif // DBG_UTIL
 
    tSwNumberTreeChildren::size_type GetChildCount() const;
 
protected:
    tSwNumberTreeChildren mChildren;
 
    SwNumberTreeNode* GetRoot() const;
 
    virtual bool IsNotificationEnabled(const SwDoc& rDoc) const = 0;
 
    // #i64010# - made pure virtual
    virtual bool HasCountedChildren() const = 0;
 
    // #i64010#
    virtual bool IsCountedForNumbering() const = 0;
 
    // method called before this tree node has been added to the list tree
    virtual void PreAdd() = 0;
    // method called after this tree node has been removed from the list tree
    virtual void PostRemove() = 0;
 
#ifdef DBG_UTIL
    void IsSane(bool bRecursive, std::vector<const SwNumberTreeNode*> rParents) const;
#endif // DBG_UTIL
 
    SwNumberTreeNode* mpParent;
 
    mutable SwNumberTree::tSwNumTreeNumber mnNumber;
 
    // boolean indicating, that a node of a not counted parent node is continuing
    // the numbering of parent's previous node sub tree.
    // Example:
    //   1. kshdkjfs
    //     1.1. lskjf
    //      sdfjlksaf <-- not counted parent node
    //     1.2. lfjlaskf <-- <mbContinueingPreviousSubTree = true>
    mutable bool mbContinueingPreviousSubTree;
 
    bool mbPhantom;
 
    mutable tSwNumberTreeChildren::const_iterator mItLastValid;
 
    SwNumberTreeNode(const SwNumberTreeNode&);
    SwNumberTreeNode& operator=(const SwNumberTreeNode&);
 
    void GetNumberVector_(SwNumberTree::tNumberVector& rVector, bool bValidate = true) const;
 
    void Invalidate(SwNumberTreeNode const* pChild);
 
    void InvalidateChildren() { SetLastValid(mChildren.end()); }
 
    void SetLastValid(const tSwNumberTreeChildren::const_iterator& aItLastValid,
                      bool bValidating = false) const;
 
    virtual bool IsNotifiable(const SwDoc& rDoc) const = 0;
 
    virtual void NotifyNode() = 0;
 
    void Notify(const SwDoc& rDoc);
 
    void NotifyChildrenOnDepth(const int nDepth);
 
    bool IsValid(const SwNumberTreeNode* pChild) const;
 
    bool IsValid() const;
 
    void Validate(const SwNumberTreeNode* pNode) const;
 
    void ValidateHierarchical(const SwNumberTreeNode* pNode) const;
 
    void ValidateContinuous(const SwNumberTreeNode* pNode) const;
 
    virtual SwNumberTreeNode* Create() const = 0;
 
    SwNumberTreeNode* CreatePhantom();
 
    virtual bool IsCountPhantoms() const = 0;
 
    bool HasOnlyPhantoms() const;
 
    bool HasPhantomCountedParent() const;
 
    SwNumberTreeNode* GetFirstNonPhantomChild();
 
    void ClearObsoletePhantoms();
 
    tSwNumberTreeChildren::const_iterator GetIterator(const SwNumberTreeNode* pChild) const;
 
    void MoveChildren(SwNumberTreeNode* pDest);
 
    void MoveGreaterChildren(SwNumberTreeNode& _rCompareNode, SwNumberTreeNode& _rDestNode);
 
    SwNumberTreeNode* GetLastDescendant() const;
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */