koffice/lib/kotext/KoListStyleStack.h

/* This file is part of the KDE project
   Copyright (c) 2004 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef KOLISTSTYLESTACK_H
#define KOLISTSTYLESTACK_H

#include <tqdom.h>
#include <tqvaluestack.h>

/**
 * This class implements the list styles currently active at a given point.
 * Unlike KoStyleStack, this is NOT an inheritance stack.
 * The list-style stack contains one item per list level at any given point.
 * For instance inside \<ul\>\<li\>\<ul\>\<li\> (in html terms), it will have 2 items.
 *
 * @author David Faure <faure@kde.org>
 */
class KoListStyleStack
{
public:
    KoListStyleStack();
    ~KoListStyleStack();

    /**
     * Removes the style on top of the stack.
     */
    void pop();

    /**
     * Pushes the new list-style onto the stack.
     */
    void push( const TQDomElement& style );

    /// @return true if we're inside a list (i.e. the stack isn't empty)
    bool hasListStyle() const { return !m_stack.isEmpty(); }

    /// @return currenty applicable list style, i.e. the one on top of the stack
    /// Most list-level properties are the attributes of that element.
    TQDomElement currentListStyle() const;

    /**
     * @return the style:list-level-properties for the currenty applicable list style.
     * The list-level properties that are only "style" information,
     * like text:min-label-width, text:space-before, and style:font-name
     * are the attributes of that element.
     */
    TQDomElement currentListStyleProperties() const;

    /**
     * @return the style:text-properties for the currenty applicable list style.
     */
    TQDomElement currentListStyleTextProperties() const;

    /**
     * Set the initial level of the list, i.e. of item at the bottom of the stack.
     * This is used when a level is explicitely specified in the
     * [un]ordered-list tag (OASIS extension)
     */
    void setInitialLevel( int initialLevel );

    /// @return initial level
    int initialLevel() const { return m_initialLevel; }

    /// @return current list level
    int level() const { return m_initialLevel + m_stack.count(); }


private:
    TQValueStack<TQDomElement> m_stack;
    int m_initialLevel;

};

#endif /* KOLISTSTYLESTACK_H */