gctreewidgetitem.h

/* Copyright (c) 2012 - 2013 by William Hallatt.
 *
 * This file forms part of "XML Mill".
 *
 * The official website for this project is <http://www.goblincoding.com> and,
 * although not compulsory, it would be appreciated if all works of whatever
 * nature using this source code (in whole or in part) include a reference to
 * this site.
 *
 * Should you wish to contact me for whatever reason, please do so via:
 *
 *                 <http://www.goblincoding.com/contact>
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program (GNUGPL.txt).  If not, see
 *
 *                    <http://www.gnu.org/licenses/>
 */

#ifndef GCTREEWIDGETITEM_H
#define GCTREEWIDGETITEM_H

#include <QTreeWidgetItem>
#include <QStringList>
#include <QString>
#include <QDomElement>


class GCTreeWidgetItem : public QTreeWidgetItem
{
public:
  explicit GCTreeWidgetItem( QDomElement element );

  explicit GCTreeWidgetItem( QDomElement element, int index );

  GCTreeWidgetItem* gcParent() const;

  GCTreeWidgetItem* gcChild( int index ) const;

  QDomElement element() const;

  void setExcludeElement( bool exclude );

  bool elementExcluded() const;

  void excludeAttribute( const QString& attribute );

  void includeAttribute( const QString& attribute, const QString& value );

  bool attributeIncluded( const QString& attribute ) const;

  void setIncrementAttribute( const QString& attribute, bool increment );

  bool incrementAttribute( const QString& attribute ) const;

  void fixAttributeValues();

  QString fixedValue( const QString& attribute ) const;

  void revertToFixedValues();

  QString toString() const;

  void setIndex( int index );

  int index() const;

  void rename( const QString& newName );

  QString name() const;

  void setVerbose( bool verbose );

  void insertGcChild( int index, GCTreeWidgetItem* item );

private:
  void init( QDomElement element, int index );

  void setDisplayText();

  QDomElement m_element;
  bool m_elementExcluded;
  bool m_verbose;
  int m_index;

  QStringList m_includedAttributes;
  QStringList m_incrementedAttributes;
  QHash< QString/*attr*/, QString /*val*/ > m_fixedValues;
};

#endif // GCTREEWIDGETITEM_H