tdefileview.h

/* This file is part of the KDE libraries
    Copyright (C) 1997 Stephan Kulow <coolo@kde.org>
    Copyright (C) 2001 Carsten Pfeiffer <pfeiffer@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 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 TDEFILEVIEW_H
#define TDEFILEVIEW_H
 
class TQPoint;
class TDEActionCollection;
 
#include <tqwidget.h>
 
#include "tdefileitem.h"
#include "tdefile.h"

class TDEIO_EXPORT KFileViewSignaler : public TQObject
{
    TQ_OBJECT
 
public:
    void activate( const KFileItem *item ) {
        if ( item->isDir() )
            emit dirActivated( item );
        else
            emit fileSelected( item );
    }

    void highlightFile(const KFileItem *i) { emit fileHighlighted(i); }
 
    void activateMenu( const KFileItem *i, const TQPoint& pos ) {
        emit activatedMenu( i, pos );
    }
 
    void changeSorting( TQDir::SortSpec sorting ) {
        emit sortingChanged( sorting );
    }
    
    void dropURLs(const KFileItem *i, TQDropEvent*e, const KURL::List&urls) {
        emit dropped(i, e, urls);
    }
 
signals:
    void dirActivated(const KFileItem*);
 
    void sortingChanged( TQDir::SortSpec );

    void fileHighlighted(const KFileItem*);
    void fileSelected(const KFileItem*);
    void activatedMenu( const KFileItem *i, const TQPoint& );
    void dropped(const KFileItem *, TQDropEvent*, const KURL::List&);
};

class TDEIO_EXPORT KFileView {
 
public:
    KFileView();

    virtual ~KFileView();

    void addItemList(const KFileItemList &list);

    virtual TQWidget *widget() = 0;

    TQWidget *widget() const { return const_cast<KFileView*>(this)->widget(); }

    void setCurrentItem( const TQString &filename );

    virtual void setCurrentItem( const KFileItem *item ) = 0;

    virtual KFileItem *currentFileItem() const = 0;

    virtual void clear();

    virtual void updateView(bool f = true);
 
    virtual void updateView(const KFileItem*);

    virtual void removeItem(const KFileItem *item);

    virtual void listingCompleted();

    TQDir::SortSpec sorting() const { return m_sorting; }

    virtual void setSorting(TQDir::SortSpec sort);

    bool isReversed() const { return (m_sorting & TQDir::Reversed); }
 
    void sortReversed();

    uint count() const { return filesNumber + dirsNumber; }

    uint numFiles() const { return filesNumber; }

    uint numDirs() const { return dirsNumber; }
 
    virtual void setSelectionMode( KFile::SelectionMode sm );
    virtual KFile::SelectionMode selectionMode() const;
 
    enum ViewMode {
    Files       = 1,
    Directories = 2,
    All = Files | Directories
    };
    virtual void setViewMode( ViewMode vm );
    virtual ViewMode viewMode() const { return view_mode; }

    TQString viewName() const { return m_viewName; }

    void setViewName( const TQString& name ) { m_viewName = name; }
 
    virtual void setParentView(KFileView *parent);

    virtual void insertItem( KFileItem *i);

    virtual void clearView() = 0;

    virtual void ensureItemVisible( const KFileItem *i ) = 0;

    virtual void clearSelection() = 0;

    virtual void selectAll();

    virtual void invertSelection();

    virtual void setSelected(const KFileItem *, bool enable) = 0;

    virtual bool isSelected( const KFileItem * ) const = 0;

    const KFileItemList * selectedItems() const;

    const KFileItemList * items() const;
 
    virtual KFileItem * firstFileItem() const = 0;
    virtual KFileItem * nextItem( const KFileItem * ) const = 0;
    virtual KFileItem * prevItem( const KFileItem * ) const = 0;

    void setOnlyDoubleClickSelectsFiles( bool enable ) {
    myOnlyDoubleClickSelectsFiles = enable;
    }

    bool onlyDoubleClickSelectsFiles() const {
    return myOnlyDoubleClickSelectsFiles;
    }

    bool updateNumbers(const KFileItem *i);

    virtual TDEActionCollection * actionCollection() const;
 
    KFileViewSignaler * signaler() const { return sig; }
 
    virtual void readConfig( TDEConfig *, const TQString& group = TQString::null );
    virtual void writeConfig( TDEConfig *, const TQString& group = TQString::null);

    enum DropOptions {
    AutoOpenDirs  = 1
    };

    // KDE 4: Make virtual
    void setDropOptions(int options);
    
    int dropOptions();
    
    static TQString sortingKey( const TQString& value, bool isDir, int sortSpec);

    static TQString sortingKey( TDEIO::filesize_t value, bool isDir,int sortSpec);

    static int autoOpenDelay();
 
protected:
    KFileViewSignaler *sig;
 
private:
    static TQDir::SortSpec defaultSortSpec;
    TQDir::SortSpec m_sorting;
    TQString m_viewName;

    uint filesNumber;
    uint dirsNumber;
 
    ViewMode view_mode;
    KFile::SelectionMode selection_mode;
 
    // never use! It's only guaranteed to contain valid items in the items()
    // method!
    mutable KFileItemList m_itemList;
 
    mutable KFileItemList *m_selectedList;
    bool myOnlyDoubleClickSelectsFiles;
 
protected:
    virtual void virtual_hook( int id, void* data );
    /* @internal for virtual_hook */
    enum { VIRTUAL_SET_DROP_OPTIONS = 1 };
    void setDropOptions_impl(int options);
private:
    class KFileViewPrivate;
    KFileViewPrivate *d;
};
 
#endif // TDEFILEINFOLISTWIDGET_H