sw/inc/SwNodeNum.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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 "SwNumberTree.hxx"

class SwTextNode;
struct SwPosition;
class SwNumRule;

class SAL_DLLPUBLIC_RTTI SwNodeNum final : public SwNumberTreeNode
{
public:
    explicit SwNodeNum(SwTextNode* pTextNode, bool isHiddenRedlines);
    // note: this is only for creating phantom nodes and root nodes; these
    // never have a text node
    explicit SwNodeNum(SwNumRule* pNumRule);
    virtual ~SwNodeNum() override;

    SwNumRule* GetNumRule() const { return mpNumRule; }
    void ChangeNumRule(SwNumRule& rNumRule);
    SwTextNode* GetTextNode() const { return mpTextNode; }

    virtual bool IsNotificationEnabled(const SwDoc& rDoc) const override;

    virtual bool IsContinuous() const override;

    virtual bool IsCounted() const override;

    virtual bool LessThan(const SwNumberTreeNode& rNode) const override;

    virtual bool IsRestart() const override;

    virtual SwNumberTree::tSwNumTreeNumber GetStartValue() const override;

    SwPosition GetPosition() const;

    // The number tree root node is deleted, when the corresponding numbering
    // rule is deleted. In this situation the number tree should be empty -
    // still registered text nodes aren't allowed. But it is possible, that
    // text nodes of the undo nodes array are still registered. These will be
    // unregistered.
    // Text nodes of the document nodes array aren't allowed to be registered
    // in this situation - this will be asserted.
    static void HandleNumberTreeRootNodeDelete(SwNodeNum& rNodeNum);

    /** determines the <SwNodeNum> instance, which is preceding the given text node

        #i81002#
    */
    const SwNodeNum* GetPrecedingNodeNumOf(const SwTextNode& rTextNode) const;

private:
    virtual SwNumberTreeNode* Create() const override;

    // --> #i64010#
    virtual bool HasCountedChildren() const override;
    virtual bool IsCountedForNumbering() const override;

    // method called before this tree node has been added to the list tree
    virtual void PreAdd() override;
    // method called at a child after this child has been removed from the list tree
    virtual void PostRemove() override;

    SwTextNode* const mpTextNode;
    SwNumRule* mpNumRule;
    bool m_isHiddenRedlines;

    static void UnregisterMeAndChildrenDueToRootDelete(SwNodeNum& rNodeNum);

    SwNodeNum(const SwNodeNum&) = delete;
    SwNodeNum& operator=(const SwNodeNum&) = delete;

    virtual bool IsCountPhantoms() const override;

    virtual bool IsNotifiable(const SwDoc& rDoc) const override;

    virtual void NotifyNode() override;
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */