treewidget.h

Go to the documentation of this file.

#ifndef KDEPIM_TREEWIDGET_H
#define KDEPIM_TREEWIDGET_H

/******************************************************************************
 *
 * This file is part of libkdepim.
 *
 * Copyright (C) 2008 Szymon Tomasz Stefanek <pragma@kvirc.net>
 *
 * 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.
 *
 *****************************************************************************/

#include "knode_export.h"
#include <QTreeWidget>

class KMenu;
class KConfig;
class KConfigGroup;

class QAction;

namespace KPIM
{

class KNODE_EXPORT TreeWidget : public QTreeWidget
{
  Q_OBJECT
public:
  explicit TreeWidget( QWidget *parent, const char *name = 0 );

public:

  //
  // Layout Save/Restore facility
  //

  bool saveLayout(
      KConfigGroup &group,
      const QString &keyName = QString()
    ) const;

  bool saveLayout(
      KConfig *config,
      const QString &groupName,
      const QString &keyName = QString()
    ) const;

  bool restoreLayout(
      KConfigGroup &group,
      const QString &keyName = QString()
    );

  bool restoreLayout(
      KConfig *config,
      const QString &groupName,
      const QString &keyName = QString()
    );

  //
  // Manual and programmatic column hiding
  //

  void setManualColumnHidingEnabled( bool enable );

  bool manualColumnHidingEnabled() const
    { return mEnableManualColumnHiding; };

  void setColumnHidden( int logicalIndex, bool hide );

  bool isColumnHidden( int logicalIndex ) const;

  void toggleColumn( int logicalIndex );

  virtual bool fillHeaderContextMenu( KMenu *menu, const QPoint &clickPoint );

  //
  // Facilities for adding and manipulating columns
  //

  int addColumn(
      const QString &label,
      int headerAlignment = Qt::AlignLeft | Qt::AlignVCenter
    );

  bool setColumnText( int columnIndex, const QString &label );

  QTreeWidgetItem *lastItem() const;

  QTreeWidgetItem *firstItem() const;

Q_SIGNALS:
  void columnVisibilityChanged( int logicalIndex );

protected:
  virtual void changeEvent( QEvent *e );

private Q_SLOTS:
  void slotHeaderContextMenuRequested( const QPoint &clickPoint );

  void slotToggleColumnActionTriggered( bool );

private:
  bool mEnableManualColumnHiding; 

};

} // namespace KPIM

#endif