Akonadi::EntityTreeViewStateSaver Class Reference

#include <entitytreeviewstatesaver.h>

Inheritance diagram for Akonadi::EntityTreeViewStateSaver:

Public Member Functions
	EntityTreeViewStateSaver (QTreeView *view)
	~EntityTreeViewStateSaver ()
void	restoreState (const KConfigGroup &configGroup) const
void	saveState (KConfigGroup &configGroup) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

A helper class that saves and restores state of an EntityTreeView.

This class saves and restores the state of a QTreeView showing an EntityTreeModel, or whatever proxies are stacked on top of one. State so far means the current selection and expansion of the items and collections.

The EntityTreeViewStateSaver is needed because populating the EntityTreeModel is asynchronous and finding the right point in time to restore the state is a difficult task that is hidden inside this class.

Example:

class MyWidget : public QWidget
{
  public:
     MyWidget( QWidget* parent );
     ~MyWidget();

     ...

  private:
    KConfig *mGlobalConfig;
    QTreeView *mTreeView;
    Akonadi::EntityTreeViewStateSaver *mStateSaver;
};

MyWidget::MyWidget( QWidget *parent )
  : QWidget( parent )
{
  mGlobalConfig = ...
  mTreeView = new QTreeView( this );
  ...

  mStateSaver = new Akonadi::EntityTreeViewStateSaver( mTreeView );

  KConfigGroup group( mGlobalConfig, "treeViewState" );
  mStateSaver->restoreState( group );
}

MyWidget::~MyWidget()
{
  KConfigGroup group( mGlobalConfig, "treeViewState" );
  mStateSaver->saveState( group );
}

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Since

4.4

Deprecated:

This class is deprecated. Use ETMViewStateSaver instead.

Definition at line 89 of file entitytreeviewstatesaver.h.

Constructor & Destructor Documentation

Akonadi::EntityTreeViewStateSaver::EntityTreeViewStateSaver ( QTreeView *  view )

explicit

Creates a new state saver, for saving or restoring.

Parameters

view	The QTreeView which state should be saved/restored.

Definition at line 158 of file entitytreeviewstatesaver.cpp.

Akonadi::EntityTreeViewStateSaver::~EntityTreeViewStateSaver

(

)

Destroys this state saver.

Definition at line 165 of file entitytreeviewstatesaver.cpp.

Member Function Documentation

void Akonadi::EntityTreeViewStateSaver::restoreState

(

const KConfigGroup &

configGroup

)

const

Restore the state stored in configGroup as soon as the corresponding entities become available in the model (the model is populated asynchronously, which is the main reason why you want to use this class).

Parameters

configGroup

Config file group containing a previously stored EntityTreeView state.

Definition at line 193 of file entitytreeviewstatesaver.cpp.

void Akonadi::EntityTreeViewStateSaver::saveState

(

KConfigGroup &

configGroup

)

const

Stores the current state in the given config group.

Parameters

configGroup

Config file group into which the state is supposed to be stored.

Definition at line 170 of file entitytreeviewstatesaver.cpp.

---

The documentation for this class was generated from the following files:

• entitytreeviewstatesaver.h
• entitytreeviewstatesaver.cpp