gcdomtreewidget.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 GCDOMTREEWIDGET_H
#define GCDOMTREEWIDGET_H

#include <QTreeWidget>
#include <QDomComment>

class GCTreeWidgetItem;
class QDomDocument;
class QDomElement;
class QDomNode;


class GCDomTreeWidget : public QTreeWidget
{
Q_OBJECT
public:
  GCDomTreeWidget( QWidget* parent = 0 );

  ~GCDomTreeWidget();

  GCTreeWidgetItem* gcCurrentItem() const;

  QList< GCTreeWidgetItem* > includedTreeWidgetItems() const;

  const QList< GCTreeWidgetItem* >& allTreeWidgetItems() const;

  int itemPositionRelativeToIdenticalSiblings( const QString& nodeText, int itemIndex ) const;

  QDomNode cloneDocument() const;

  QString toString() const;

  QString rootName() const;

  QString activeCommentValue() const;

  void setActiveCommentValue( const QString& value );

  bool setContent( const QString& text, QString* errorMsg = 0, int* errorLine = 0, int* errorColumn = 0 );

  bool empty() const;

  bool currentItemIsRoot() const;

  bool matchesRootName( const QString& elementName ) const;

  bool documentCompatible() const;

  bool batchProcessSuccess() const;

  void rebuildTreeWidget();

  void appendSnippet( GCTreeWidgetItem* parentItem, QDomElement childElement );

  void replaceItemsWithComment( const QList< int >& indices, const QString& comment );

  void updateItemNames( const QString& oldName, const QString& newName );

  void populateFromDatabase( const QString& baseElementName = QString() );

  void addItem( const QString& element, bool toParent = false );

  void insertItem( const QString& elementName, int index, bool toParent = false );

  void setAllCheckStates( Qt::CheckState state );

  void setShowTreeItemsVerbose( bool verbose );

  void clearAndReset();

public slots:
  void setCurrentItemFromIndex( int index );

signals:
  void gcCurrentItemSelected( GCTreeWidgetItem* item, int column );

  void gcCurrentItemChanged( GCTreeWidgetItem* item, int column );

protected:
  void dropEvent( QDropEvent* event );

  void keyPressEvent( QKeyEvent* event );

private slots:
  void currentGcItemChanged( QTreeWidgetItem* current, QTreeWidgetItem* previous );

  void emitGcCurrentItemSelected( QTreeWidgetItem* item, int column );

  void emitGcCurrentItemChanged( QTreeWidgetItem* item, int column );

  void renameItem();

  void removeItem();

  void stepUp();

  void stepDown();

  void expand();

  void collapse();

private:
  void processElement( GCTreeWidgetItem* parentItem, QDomElement element );

  void processElementFromDatabase( const QString& element );

  bool parentTreeAlreadyContainsElement( const GCTreeWidgetItem* item, const QString& element );

  void populateCommentList( QDomNode node );

  void updateIndices();

  GCTreeWidgetItem* gcItemFromNode( QDomNode element );

  void removeFromList( GCTreeWidgetItem* item );

  GCTreeWidgetItem* m_activeItem;
  QDomDocument* m_domDoc;
  QDomComment m_commentNode;
  bool m_isEmpty;
  bool m_busyIterating;
  bool m_itemBeingManipulated;

  QList< GCTreeWidgetItem* > m_items;
  QList< QDomComment > m_comments;
};

#endif // GCDOMTREEWIDGET_H