tdelistview.h

/* 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 TDELISTVIEW_H
#define TDELISTVIEW_H
 
#include <tqheader.h>
#include <tqlistview.h>
#include <tdeshortcut.h>
#include <tqptrlist.h>
#include <tdelibs_export.h>
 
class TQDragObject;
class TDEConfig;
class KLineEdit;
 
// Used to set the 'move to next/previous item' after renaming is completed
class TDEListViewRenameSettings
{
  public:
    bool m_useRenameSignals;   // if true, emits renameNext/renamePrev signals
    TDEShortcut m_SCNext;      // the shortcut key for moving to the next cell
    TDEShortcut m_SCPrev;      // the shortcut key for moving to the previous cell
 
    TDEListViewRenameSettings()
       : m_useRenameSignals(false), m_SCNext(), m_SCPrev() {}
 
    TDEListViewRenameSettings(bool useRenameSignals, TDEShortcut scNext, TDEShortcut scPrev)
       : m_useRenameSignals(useRenameSignals), m_SCNext(scNext), m_SCPrev(scPrev) {}
    
    TDEListViewRenameSettings(const TDEListViewRenameSettings &that)
       : m_useRenameSignals(that.m_useRenameSignals), m_SCNext(that.m_SCNext), m_SCPrev(that.m_SCPrev) {}
 
    TDEListViewRenameSettings& operator=(const TDEListViewRenameSettings &that)
    {
      if (this==&that) return *this;
      m_useRenameSignals = that.m_useRenameSignals;
      m_SCNext = that.m_SCNext;
      m_SCPrev = that.m_SCPrev;
      return *this;
    }
};
 

class TDEUI_EXPORT TDEListView : public TQListView
{
  friend class TDEListViewItem;
 
  TQ_OBJECT
  
  TQ_ENUMS( SelectionModeExt )
  TQ_PROPERTY( bool fullWidth READ fullWidth WRITE setFullWidth )
  TQ_PROPERTY( bool itemsMovable READ itemsMovable WRITE setItemsMovable )
  TQ_PROPERTY( bool itemsRenameable READ itemsRenameable WRITE setItemsRenameable )
  TQ_PROPERTY( bool dragEnabled READ dragEnabled  WRITE  setDragEnabled )
  TQ_PROPERTY( bool autoOpen READ autoOpen WRITE setAutoOpen )
  TQ_PROPERTY( bool dropVisualizer READ dropVisualizer WRITE setDropVisualizer )
  TQ_PROPERTY( int tooltipColumn READ tooltipColumn WRITE  setTooltipColumn )
  TQ_PROPERTY( int dropVisualizerWidth READ dropVisualizerWidth WRITE  setDropVisualizerWidth )
  TQ_PROPERTY( TQColor alternateBackground READ alternateBackground WRITE  setAlternateBackground )
  TQ_PROPERTY( bool shadeSortColumn READ shadeSortColumn WRITE setShadeSortColumn )
 
  TQ_OVERRIDE( SelectionModeExt selectionMode READ selectionModeExt WRITE setSelectionModeExt )
 
public:
  enum SelectionModeExt {
    Single = TQListView::Single,
    Multi = TQListView::Multi,
    Extended = TQListView::Extended,
    NoSelection = TQListView::NoSelection,
    FileManager
  };

  TDEListView (TQWidget *parent = 0, const char *name = 0);

  virtual ~TDEListView();

  virtual void setAcceptDrops (bool);

  virtual bool isExecuteArea( const TQPoint& point );

  bool isExecuteArea( int x );

  TQPtrList<TQListViewItem> selectedItems() const;

  TQPtrList<TQListViewItem> selectedItems(bool includeHiddenItems) const; // ### BIC: KDE 4: use an implicitly shared class! (QValutList?) and merge with above, default to true

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

  TQListViewItem *lastItem() const;

  TQListViewItem* 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 createChildren() const TDE_DEPRECATED;

  bool dropHighlighter() const;

  int dropVisualizerWidth () const;

  SelectionModeExt selectionModeExt () const;

  int itemIndex( const TQListViewItem *item ) const;

  TQListViewItem* itemAtIndex(int index);

  void setFullWidth() TDE_DEPRECATED;

  void setFullWidth(bool fullWidth);

  bool fullWidth() const;

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

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

  void saveLayout(TDEConfig *config, const TQString &group) const;
  void restoreLayout(TDEConfig *config, const TQString &group);
  virtual void setSorting(int column, bool ascending = true);

  int columnSorted(void) const;

  bool ascendingSort(void) const;

  virtual void takeItem(TQListViewItem *i);

  void setShadeSortColumn(bool shadeSortColumn);

  bool shadeSortColumn(void) const;

  void setUseSmallExecuteArea(bool enable);

  bool useSmallExecuteArea() const;

  void setRenameSettings(const TDEListViewRenameSettings &renSett);
 
 
signals:

  void executed( TQListViewItem *item );

  void executed( TQListViewItem *item, const TQPoint &pos, int c );

  void dropped (TQDropEvent * e, TQListViewItem *after);

  void dropped (TDEListView* list, TQDropEvent* e, TQListViewItem* after);

  void dropped (TDEListView* list, TQDropEvent* e, TQListViewItem* parent, TQListViewItem* after);

  void dropped (TQDropEvent* e, TQListViewItem* parent, TQListViewItem* after);

  void moved();

  void aboutToMove();

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

  void moved(TQPtrList<TQListViewItem> &items, TQPtrList<TQListViewItem> &afterFirst, TQPtrList<TQListViewItem> &afterNow);

  void itemRenamed(TQListViewItem* item, const TQString &str, int col);

  void itemRenamed(TQListViewItem* item);

  void menuShortCutPressed (TDEListView* list, TQListViewItem* item);

  void contextMenu(TDEListView* l, TQListViewItem* i, const TQPoint& p);
 
  void itemAdded(TQListViewItem *item);
  void itemRemoved(TQListViewItem *item);

  void renameNext(TQListViewItem* item, int col);

  void renamePrev(TQListViewItem* item, int col);
 
public slots:
  virtual void rename(TQListViewItem *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);

  virtual void setCreateChildren(bool b) TDE_DEPRECATED;

  void setSelectionModeExt (SelectionModeExt mode);

  void setTabOrderedRenaming(bool b);

  bool tabOrderedRenaming() const;

  virtual void selectAll( bool select );
 
protected:
  inline bool below (const TQRect& rect, const TQPoint& p)
  {
    return (p.y() > (rect.top() + (rect.bottom() - rect.top())/2));
  }

  inline bool below (TQListViewItem* i, const TQPoint& p)
  {
    return below (itemRect(i), contentsToViewport(p));
  }

  virtual bool event( TQEvent * );

  void emitExecute( TQListViewItem *item, const TQPoint &pos, int c );

   virtual void focusInEvent(TQFocusEvent* fe);

  virtual void focusOutEvent( TQFocusEvent *fe );

  virtual void leaveEvent( TQEvent *e );

  virtual TQString tooltip(TQListViewItem* item, int column) const;

  virtual bool showTooltip(TQListViewItem *item, const TQPoint &pos, int column) const;

  virtual void contentsDragMoveEvent (TQDragMoveEvent *event);

  virtual void contentsMousePressEvent( TQMouseEvent *e );

  virtual void contentsMouseMoveEvent( TQMouseEvent *e );

  virtual void contentsMouseDoubleClickEvent ( TQMouseEvent *e );

  virtual void contentsDragLeaveEvent (TQDragLeaveEvent *event);

  virtual void contentsMouseReleaseEvent (TQMouseEvent*);

  virtual void contentsDropEvent (TQDropEvent*);

  virtual void contentsDragEnterEvent (TQDragEnterEvent *);

  virtual TQDragObject *dragObject();

  virtual bool acceptDrag (TQDropEvent* event) const;

  virtual TQRect drawDropVisualizer (TQPainter *p, TQListViewItem *parent, TQListViewItem *after);

  virtual TQRect drawItemHighlighter(TQPainter *painter, TQListViewItem *item);

  virtual void startDrag();

  virtual void keyPressEvent (TQKeyEvent*);

  virtual void viewportPaintEvent(TQPaintEvent*);

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

  virtual void viewportResizeEvent(TQResizeEvent* e);

  void disableAutoSelection();

  void resetAutoSelection();

  void resetKeyboardSelectionOperation();

  void setActiveMultiSelectItem(TQListViewItem *item);

  // KDE 4: remove
  void doubleClicked( TQListViewItem *item, const TQPoint &pos, int c );
 
protected slots:
  void slotSettingsChanged(int);
  void slotMouseButtonClicked( int btn, TQListViewItem *item, const TQPoint &pos, int c );
  void doneEditing(TQListViewItem *item, int row);
  void renameNextProxy(TQListViewItem *item, int col);
  void renamePrevProxy(TQListViewItem *item, int col);
  
  void cleanDropVisualizer();

  void cleanItemHighlighter();

  void emitContextMenu (TQListViewItem*, const TQPoint&, int);

  void emitContextMenu (TDEListView*, TQListViewItem*);

  void slotOnItem( TQListViewItem *item );

  void slotOnViewport();

  void slotAutoSelect();
 
  void slotDragExpand();

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

  virtual void findDrop(const TQPoint &pos, TQListViewItem *&parent, TQListViewItem *&after);

  void fileManagerKeyPressEvent (TQKeyEvent*);

  int depthToPixels( int depth );
 
private:
  class Tooltip;
protected:
  virtual void virtual_hook( int id, void* data );
private:
  class TDEListViewPrivate;
  TDEListViewPrivate* const d;
  bool isExecuteArea( int x, TQListViewItem* item );
};

class TDEUI_EXPORT TDEListViewItem : public TQListViewItem
{
  friend class TDEListView;
public:
  TDEListViewItem(TQListView *parent);
  TDEListViewItem(TQListViewItem *parent);
  TDEListViewItem(TQListView *parent, TQListViewItem *after);
  TDEListViewItem(TQListViewItem *parent, TQListViewItem *after);
 
  TDEListViewItem(TQListView *parent,
    TQString, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null);
 
  TDEListViewItem(TQListViewItem *parent,
    TQString, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null);
 
  TDEListViewItem(TQListView *parent, TQListViewItem *after,
    TQString, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null);
 
  TDEListViewItem(TQListViewItem *parent, TQListViewItem *after,
    TQString, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null,
    TQString = TQString::null, TQString = TQString::null);
 
  virtual ~TDEListViewItem();
 
  virtual void insertItem(TQListViewItem *item);
  virtual void takeItem(TQListViewItem *item);
  bool isAlternate();
  const TQColor &backgroundColor() TDE_DEPRECATED;  // #### should be removed in 4.0; use below instead

  TQColor backgroundColor(int column);
 
  virtual void paintCell(TQPainter *p, const TQColorGroup &cg,
    int column, int width, int alignment);
 
private:
  void init();
 
private:
  uint m_odd : 1;
  uint m_known : 1;
  uint m_unused : 30;
};
 
#endif