k3listview.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2000 Reginald Stadlbauer <reggie@kde.org>
   Copyright (C) 2000 Charles Samuels <charles@kde.org>
   Copyright (C) 2000 Peter Putzer <putzer@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

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

class QColorGroup;

#include <kde3support_export.h>

#include <Qt3Support/Q3ListView>
#include <Qt3Support/Q3PtrList>

class Q3DragObject;
class KConfig;
class KLineEdit;
class KConfigGroup;

class KDE3SUPPORT_EXPORT K3ListView : public Q3ListView
{
  friend class K3ListViewItem;

  Q_OBJECT
  Q_ENUMS( SelectionModeExt )
  Q_PROPERTY( bool fullWidth READ fullWidth WRITE setFullWidth )
  Q_PROPERTY( bool itemsMovable READ itemsMovable WRITE setItemsMovable )
  Q_PROPERTY( bool itemsRenameable READ itemsRenameable WRITE setItemsRenameable )
  Q_PROPERTY( bool dragEnabled READ dragEnabled  WRITE  setDragEnabled )
  Q_PROPERTY( bool autoOpen READ autoOpen WRITE setAutoOpen )
  Q_PROPERTY( bool dropVisualizer READ dropVisualizer WRITE setDropVisualizer )
  Q_PROPERTY( int tooltipColumn READ tooltipColumn WRITE  setTooltipColumn )
  Q_PROPERTY( int dropVisualizerWidth READ dropVisualizerWidth WRITE  setDropVisualizerWidth )
  Q_PROPERTY( QColor alternateBackground READ alternateBackground WRITE  setAlternateBackground )
  Q_PROPERTY( bool shadeSortColumn READ shadeSortColumn WRITE setShadeSortColumn )

  Q_OVERRIDE( SelectionModeExt selectionMode READ selectionModeExt WRITE setSelectionModeExt )

public:
  enum SelectionModeExt {
    Single = Q3ListView::Single,
    Multi = Q3ListView::Multi,
    Extended = Q3ListView::Extended,
    NoSelection = Q3ListView::NoSelection,
    FileManager
  };

  explicit K3ListView ( QWidget *parent = 0 );

  virtual ~K3ListView();

  virtual void setAcceptDrops (bool);

  virtual bool isExecuteArea( const QPoint& point );

  bool isExecuteArea( int x );


  QList<Q3ListViewItem *> selectedItems(bool includeHiddenItems = true ) const;

  void moveItem(Q3ListViewItem *item, Q3ListViewItem *parent, Q3ListViewItem *after);

  Q3ListViewItem *lastItem() const;

  Q3ListViewItem* lastChild () const;

  KLineEdit* renameLineEdit() const;

  bool itemsMovable() const;

  bool itemsRenameable() const;

  bool dragEnabled() const;

  bool autoOpen() const;

  bool isRenameable (int column) const;

  bool dropVisualizer() const;

  int tooltipColumn() const;

  bool dropHighlighter() const;

  int dropVisualizerWidth () const;

  SelectionModeExt selectionModeExt () const;

  int itemIndex( const Q3ListViewItem *item ) const;

  Q3ListViewItem* itemAtIndex(int index);

  KDE_DEPRECATED void setFullWidth();

  void setFullWidth(bool fullWidth);

  bool fullWidth() const;

  virtual int addColumn(const QString& label, int width = -1);
  virtual int addColumn(const QIcon& iconset, const QString& label, int width = -1);
  virtual void removeColumn(int index);

  void setAlternateBackground(const QColor &c);
  const QColor &alternateBackground() const;

  void saveLayout(KConfig *config, const QString &group) const;
  void saveLayout(KConfigGroup & cg) const;
  void restoreLayout(KConfig *config, const QString &group);
  
  void restoreLayout(KConfigGroup & cg);
  
  virtual void setSorting(int column, bool ascending = true);

  int columnSorted(void) const;

  bool ascendingSort(void) const;

  virtual void takeItem(Q3ListViewItem *i);

  void setShadeSortColumn(bool shadeSortColumn);

  bool shadeSortColumn(void) const;
Q_SIGNALS:

  void executed( Q3ListViewItem *item );

  void executed( Q3ListViewItem *item, const QPoint &pos, int c );

  void dropped (QDropEvent * e, Q3ListViewItem *after);

  void dropped (K3ListView* list, QDropEvent* e, Q3ListViewItem* after);

  void dropped (K3ListView* list, QDropEvent* e, Q3ListViewItem* parent, Q3ListViewItem* after);

  void dropped (QDropEvent* e, Q3ListViewItem* parent, Q3ListViewItem* after);

  void moved();

  void aboutToMove();

  void moved (Q3ListViewItem *item, Q3ListViewItem *afterFirst, Q3ListViewItem *afterNow);


  void moved(Q3PtrList<Q3ListViewItem> &items, Q3PtrList<Q3ListViewItem> &afterFirst, Q3PtrList<Q3ListViewItem> &afterNow);

  void itemRenamed(Q3ListViewItem* item, const QString &str, int col);

  void itemRenamed(Q3ListViewItem* item);

  void menuShortCutPressed (K3ListView* list, Q3ListViewItem* item);

  void contextMenu (K3ListView* l, Q3ListViewItem* i, const QPoint& p);

  void itemAdded(Q3ListViewItem *item);
  void itemRemoved(Q3ListViewItem *item);

public Q_SLOTS:
  virtual void rename(Q3ListViewItem *item, int c);

  void setRenameable (int column, bool yesno=true);

  virtual void setItemsMovable(bool b);

  virtual void setItemsRenameable(bool b);

  virtual void setDragEnabled(bool b);

  virtual void setAutoOpen(bool b);

  virtual void setDropVisualizer(bool b);

  void setDropVisualizerWidth (int w);

  virtual void setTooltipColumn(int column);

  virtual void setDropHighlighter(bool b);

  void setSelectionModeExt (SelectionModeExt mode);

  void setTabOrderedRenaming(bool b);

  bool tabOrderedRenaming() const;

protected:
  bool below (const QRect& rect, const QPoint& p);

  bool below (Q3ListViewItem* i, const QPoint& p);

  virtual bool event( QEvent * );

  void emitExecute( Q3ListViewItem *item, const QPoint &pos, int c );

   virtual void focusInEvent(QFocusEvent* fe);

  virtual void focusOutEvent( QFocusEvent *fe );

  virtual void leaveEvent( QEvent *e );

  virtual QString tooltip(Q3ListViewItem* item, int column) const;

  virtual bool showTooltip(Q3ListViewItem *item, const QPoint &pos, int column) const;

  virtual void contentsDragMoveEvent (QDragMoveEvent *event);

  virtual void contentsMousePressEvent( QMouseEvent *e );

  virtual void contentsMouseMoveEvent( QMouseEvent *e );

  virtual void contentsMouseDoubleClickEvent ( QMouseEvent *e );

  virtual void contentsDragLeaveEvent (QDragLeaveEvent *event);

  virtual void contentsMouseReleaseEvent (QMouseEvent*);

  virtual void contentsDropEvent (QDropEvent*);

  virtual void contentsDragEnterEvent (QDragEnterEvent *);

  virtual void contentsContextMenuEvent ( QContextMenuEvent * );

  virtual Q3DragObject *dragObject();

  virtual bool acceptDrag (QDropEvent* event) const;

  virtual QRect drawDropVisualizer (QPainter *p, Q3ListViewItem *parent, Q3ListViewItem *after);

  virtual QRect drawItemHighlighter(QPainter *painter, Q3ListViewItem *item);

  virtual void startDrag();

  virtual void keyPressEvent (QKeyEvent*);

  virtual void viewportPaintEvent(QPaintEvent*);

  void activateAutomaticSelection();
  void deactivateAutomaticSelection();
  bool automaticSelection() const;

  virtual void viewportResizeEvent(QResizeEvent* e);

  void disableAutoSelection();

  void resetAutoSelection();

  // KDE 4: remove
  void doubleClicked( Q3ListViewItem *item, const QPoint &pos, int c );

protected Q_SLOTS:
  void slotSettingsChanged(int);

  void slotMouseButtonClicked( int btn, Q3ListViewItem *item, const QPoint &pos, int c );
  void doneEditing(Q3ListViewItem *item, int row);

  void cleanDropVisualizer();

  void cleanItemHighlighter();

  void emitContextMenu (Q3ListViewItem*, const QPoint&, int);

  void emitContextMenu (K3ListView*, Q3ListViewItem*);

  void slotOnItem( Q3ListViewItem *item );

  void slotOnViewport();

  void slotAutoSelect();

  void slotDragExpand();

  void slotHeaderChanged();

protected:
  virtual void movableDropEvent (Q3ListViewItem* parent, Q3ListViewItem* afterme);

  virtual void findDrop(const QPoint &pos, Q3ListViewItem *&parent, Q3ListViewItem *&after);

  void fileManagerKeyPressEvent (QKeyEvent*);

  int depthToPixels( int depth );

#if 0
private:
  class Tooltip;
#endif

private:
  class K3ListViewPrivate;
  K3ListViewPrivate* const d;
  bool isExecuteArea( int x, Q3ListViewItem* item );
};

class KDE3SUPPORT_EXPORT K3ListViewItem : public Q3ListViewItem
{
  friend class K3ListView;
public:
  K3ListViewItem(Q3ListView *parent);
  K3ListViewItem(Q3ListViewItem *parent);
  K3ListViewItem(Q3ListView *parent, Q3ListViewItem *after);
  K3ListViewItem(Q3ListViewItem *parent, Q3ListViewItem *after);

  K3ListViewItem(Q3ListView *parent,
    const QString& label1, const QString& label2 = QString(),
    const QString& label3 = QString(), const QString& label4 = QString(),
    const QString& label5 = QString(), const QString& label6 = QString(),
    const QString& labem7 = QString(), const QString& label7 = QString());

  K3ListViewItem(Q3ListViewItem *parent,
    const QString& label1, const QString& label2 = QString(),
    const QString& label3 = QString(), const QString& label4 = QString(),
    const QString& label5 = QString(), const QString& label6 = QString(),
    const QString& labem7 = QString(), const QString& label7 = QString());

  K3ListViewItem(Q3ListView *parent, Q3ListViewItem *after,
    const QString& label1, const QString& label2 = QString(),
    const QString& label3 = QString(), const QString& label4 = QString(),
    const QString& label5 = QString(), const QString& label6 = QString(),
    const QString& labem7 = QString(), const QString& label7 = QString());

  K3ListViewItem(Q3ListViewItem *parent, Q3ListViewItem *after,
    const QString& label1, const QString& label2 = QString(),
    const QString& label3 = QString(), const QString& label4 = QString(),
    const QString& label5 = QString(), const QString& label6 = QString(),
    const QString& labem7 = QString(), const QString& label7 = QString());


  virtual ~K3ListViewItem();

  virtual void insertItem(Q3ListViewItem *item);
  virtual void takeItem(Q3ListViewItem *item);
  bool isAlternate();
  KDE_DEPRECATED const QColor &backgroundColor();  // #### should be removed in 4.0; use below instead

  QColor backgroundColor(int column);

  virtual void paintCell(QPainter *p, const QColorGroup &cg,
    int column, int width, int alignment);

private:
  void init();

private:
  uint m_odd : 1;
  uint m_known : 1;
  uint m_unused : 30;
};

#endif

// vim: ts=2 sw=2 et