kviewstatesaver.h

Go to the documentation of this file.

/*
    Copyright (C) 2010 Klarälvdalens Datakonsult AB,
        a KDAB Group company, info@kdab.net,
        author Stephen Kelly <stephen@kdab.com>

    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 KVIEWSTATESAVER_H
#define KVIEWSTATESAVER_H

#include <QtCore/QObject>
#include <QtCore/QPair>

#include "kdeui_export.h"

class QAbstractItemView;
class QItemSelectionModel;
class QAbstractItemModel;
class QAbstractScrollArea;
class QModelIndex;
class QStringList;

class KConfigGroup;

class KViewStateSaverPrivate;

class KDEUI_EXPORT KViewStateSaver : public QObject
{
  Q_OBJECT
public:
  explicit KViewStateSaver(QObject *parent = 0);

  ~KViewStateSaver();

  QAbstractItemView* view() const;

  void setView(QAbstractItemView *view);

  QItemSelectionModel* selectionModel() const;

  void setSelectionModel( QItemSelectionModel *selectionModel );

  void saveState(KConfigGroup &configGroup);

  void restoreState(const KConfigGroup &configGroup);

  QStringList selectionKeys() const;

  QStringList expansionKeys() const;

  QString currentIndexKey() const;

  QPair<int, int> scrollState() const;

  void restoreSelection( const QStringList &indexStrings );

  void restoreCurrentItem( const QString &indexString );

  void restoreExpanded( const QStringList &indexStrings );

  void restoreScrollState( int verticalScoll, int horizontalScroll );

protected:
  virtual QModelIndex indexFromConfigString(const QAbstractItemModel *model, const QString &key) const = 0;

  virtual QString indexToConfigString(const QModelIndex &index) const = 0;

private:
  //@cond PRIVATE
  Q_DECLARE_PRIVATE(KViewStateSaver)
  KViewStateSaverPrivate * const d_ptr;
  Q_PRIVATE_SLOT( d_func(), void rowsInserted( const QModelIndex&, int, int ) )
  Q_PRIVATE_SLOT( d_func(), void restoreScrollBarState() )
  //@endcond
};

#endif