tdediroperator.h

/* This file is part of the KDE libraries
    Copyright (C) 1999 Stephan Kulow <coolo@kde.org>
          2000,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 TDEDIROPERATOR_H_
#define TDEDIROPERATOR_H_
 
#include <tqwidget.h>
#include <tqptrstack.h>
 
#include <tdeaction.h>
#include <kcompletion.h>
#include <kdirlister.h>
#include <tdefileview.h>
#include <tdefileitem.h>
#include <tdefile.h>
 
class TQPopupMenu;
class TQTimer;
 
class TDEAction;
class KDirLister;
class TDEToggleAction;
class TDEActionSeparator;
class TDEActionMenu;
class TQWidgetStack;
class KProgress;
namespace TDEIO {
  class CopyJob;
  class DeleteJob;
}
 
class TDEIO_EXPORT KDirOperator : public TQWidget
{
    TQ_OBJECT
 
 public:
    enum ActionTypes { SortActions = 1,
                       ViewActions = 2,
                       NavActions = 4,
                       FileActions = 8,
                       AllActions = 15 };
    KDirOperator(const KURL& urlName = KURL(),
         TQWidget *parent = 0, const char* name = 0);
    virtual ~KDirOperator();
 
    // ### KDE4: make virtual
    void setShowHiddenFiles ( bool s ) { showHiddenAction->setChecked( s ); }
 
    bool showHiddenFiles () const { return showHiddenAction->isChecked(); }
 
    void close();
    virtual bool close( bool alsoDelete ) { return TQWidget::close( alsoDelete ); }
 
    void setNameFilter(const TQString& filter);
 
    const TQString& nameFilter() const { return dir->nameFilter(); }
 
    void setMimeFilter( const TQStringList& mimetypes );
 
    TQStringList mimeFilter() const { return dir->mimeFilters(); }
 
    void clearFilter();
 
    KURL url() const;
 
    // ### KDE4: make virtual
    void setURL(const KURL& url, bool clearforward);
 
    void setCurrentItem( const TQString& filename );
 
    // ### KDE4: make virtual
    void setView(KFileView *view);
 
    KFileView * view() const { return m_fileView; }
 
    TQWidget * viewWidget() const { return m_fileView ? m_fileView->widget() : 0L; }
 
    // ### KDE4: make virtual
    void setView(KFile::FileView view);
 
    void setSorting( TQDir::SortSpec );
 
    TQDir::SortSpec sorting() const { return mySorting; }
 
    bool isRoot() const { return url().path() == TQChar('/'); }
 
    KDirLister *dirLister() const { return dir; }
 
    KProgress * progressBar() const;
 
    // ### KDE4: make virtual
    void setMode( KFile::Mode m );
    KFile::Mode mode() const;
 
    // ### KDE4: make virtual
    void setPreviewWidget(const TQWidget *w);
 
    const KFileItemList * selectedItems() const {
    return ( m_fileView ? m_fileView->selectedItems() : 0L );
    }
 
    inline bool isSelected( const KFileItem *item ) const {
    return ( m_fileView ? m_fileView->isSelected( item ) : false );
    }
 
    int numDirs() const;
 
    int numFiles() const;
 
    TDECompletion * completionObject() const {
    return const_cast<TDECompletion *>( &myCompletion );
    }
 
    TDECompletion *dirCompletionObject() const {
    return const_cast<TDECompletion *>( &myDirCompletion );
    }
 
    TDEActionCollection * actionCollection() const { return myActionCollection; }
 
    // ### KDE4: make virtual
    void setViewConfig( TDEConfig *config, const TQString& group );
 
    TDEConfig *viewConfig();
 
    TQString viewConfigGroup() const;
 
    virtual void readConfig( TDEConfig *, const TQString& group = TQString::null );
 
    virtual void writeConfig( TDEConfig *, const TQString& group = TQString::null );
 
 
    void setOnlyDoubleClickSelectsFiles( bool enable );
 
    bool onlyDoubleClickSelectsFiles() const;
 
    // ### KDE4: make virtual and turn TQString into KURL
    bool mkdir( const TQString& directory, bool enterDirectory = true );
 
    // ### KDE4: make virtual
    TDEIO::DeleteJob * del( const KFileItemList& items,
                          bool ask = true, bool showProgress = true );
 
    // ### KDE4: make virtual
    TDEIO::DeleteJob * del( const KFileItemList& items, TQWidget *parent,
                          bool ask = true, bool showProgress = true );
 
    void clearHistory();
 
    // ### KDE4: make virtual
    void setEnableDirHighlighting( bool enable );
 
    bool dirHighlighting() const;
 
    bool dirOnlyMode() const { return dirOnlyMode( myMode ); }
 
    static bool dirOnlyMode( uint mode ) {
        return ( (mode & KFile::Directory) &&
                 (mode & (KFile::File | KFile::Files)) == 0 );
    }
 
    void setupMenu(int whichActions);
 
    virtual void setAcceptDrops(bool b);
 
     // ### KDE4: make virtual
    void setDropOptions(int options);
 
     // ### KDE4: make virtual
    TDEIO::CopyJob * trash( const KFileItemList& items, TQWidget *parent,
                       bool ask = true, bool showProgress = true );
 
protected:
     virtual KFileView* createView( TQWidget* parent, KFile::FileView view );
    // ### KDE4: make virtual
    void setDirLister( KDirLister *lister );
 
    virtual void resizeEvent( TQResizeEvent * );
 
    void setupActions();
 
    void updateSortActions();
 
    void updateViewActions();
 
    void setupMenu();
 
    void prepareCompletionObjects();
 
    bool checkPreviewSupport();
 
public slots:
    // ### KDE4: make virtual
    void back();
 
    // ### KDE4: make virtual
    void forward();
 
    // ### KDE4: make virtual
    void home();
 
    // ### KDE4: make virtual
    void cdUp();
 
    void updateDir();
 
    // ### KDE4: make virtual
    void rereadDir();
 
    // ### KDE4: make virtual
    void mkdir();
 
    // ### KDE4: make virtual
    void deleteSelected();
 
    void updateSelectionDependentActions();
 
    TQString makeCompletion(const TQString&);
 
    TQString makeDirCompletion(const TQString&);
 
    // ### KDE4: make virtual
    void trashSelected(TDEAction::ActivationReason, TQt::ButtonState);
 
protected slots:
    void resetCursor();
 
    void pathChanged();
 
    void insertNewFiles(const KFileItemList &newone);
 
    void itemDeleted(KFileItem *);
 
    // ### KDE4: make virtual
    void selectDir(const KFileItem *item );
 
    void selectFile(const KFileItem *item);
 
    void highlightFile(const KFileItem* i) { emit fileHighlighted( i ); }
 
    virtual void activatedMenu( const KFileItem *, const TQPoint& pos );
 
    void sortByName()       { byNameAction->setChecked( true ); }
 
    void sortBySize()       { bySizeAction->setChecked( true ); }
 
    void sortByDate()       { byDateAction->setChecked( true ); }
 
    void sortReversed()     { reverseAction->setChecked( !reverseAction->isChecked() ); }
 
    void toggleDirsFirst()  { dirsFirstAction->setChecked( !dirsFirstAction->isChecked() ); }
 
    void toggleIgnoreCase()     { caseInsensitiveAction->setChecked( !caseInsensitiveAction->isChecked() ); }
 
    void slotCompletionMatch(const TQString& match);
 
signals:
    void urlEntered(const KURL& );
    void updateInformation(int files, int dirs);
    void completion(const TQString&);
    void finishedLoading();
 
    void viewChanged( KFileView * newView );
 
    void fileHighlighted( const KFileItem *item );
    void dirActivated( const KFileItem *item );
    void fileSelected( const KFileItem *item );
    void dropped(const KFileItem *item, TQDropEvent*event, const KURL::List&urls);
private:
    TQPtrStack<KURL> backStack;
 
    TQPtrStack<KURL> forwardStack;
 
    KDirLister *dir;
    KURL currUrl;
 
    TDECompletion myCompletion;
    TDECompletion myDirCompletion;
    bool myCompleteListDirty;
    TQDir::SortSpec mySorting;
 
    bool checkPreviewInternal() const;
 
    void checkPath(const TQString& txt, bool takeFiles = false);
 
    void connectView(KFileView *);
 
    bool openURL( const KURL& url, bool keep = false, bool reload = false );
 
    KFileView *m_fileView;
    KFileItemList pendingMimeTypes;
 
    // the enum KFile::FileView as an int
    int m_viewKind;
    int defaultView;
 
    KFile::Mode myMode;
    KProgress *progress;
 
    const TQWidget *myPreview;    // temporary pointer for the preview widget
 
    // actions for the popupmenus
    // ### clean up all those -- we have them all in the actionMenu!
    TDEActionMenu *actionMenu;
 
    TDEAction   *backAction;
    TDEAction   *forwardAction;
    TDEAction   *homeAction;
    TDEAction   *upAction;
    TDEAction   *reloadAction;
    TDEActionSeparator *actionSeparator;
    TDEAction   *mkdirAction;
 
    TDEActionMenu *sortActionMenu;
    TDERadioAction *byNameAction;
    TDERadioAction *byDateAction;
    TDERadioAction *bySizeAction;
    TDEToggleAction *reverseAction;
    TDEToggleAction *dirsFirstAction;
    TDEToggleAction *caseInsensitiveAction;
 
    TDEActionMenu *viewActionMenu;
    TDERadioAction *shortAction;
    TDERadioAction *detailedAction;
    TDEToggleAction *showHiddenAction;
    TDEToggleAction *separateDirsAction;
 
    TDEActionCollection *myActionCollection;
    TDEActionCollection *viewActionCollection;
 
private slots:
    void slotDetailedView();
    void slotSimpleView();
    void slotToggleHidden( bool );
 
    void slotSeparateDirs();
    void slotDefaultPreview();
    void togglePreview( bool );
 
    void slotSortByName();
    void slotSortBySize();
    void slotSortByDate();
    void slotSortReversed();
    void slotToggleDirsFirst();
    void slotToggleIgnoreCase();
 
    void slotStarted();
    void slotProgress( int );
    void slotShowProgress();
    void slotIOFinished();
    void slotCanceled();
    void slotRedirected( const KURL& );
 
    void slotViewActionAdded( TDEAction * );
    void slotViewActionRemoved( TDEAction * );
    void slotViewSortingChanged( TQDir::SortSpec );
 
    void slotClearView();
    void slotRefreshItems( const KFileItemList& items );
 
    void slotProperties();
 
    void insertViewDependentActions();
 
public:
    bool eventFilter(TQObject *obj, TQEvent *ev);
 
private:
    static bool isReadable( const KURL& url );
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KDirOperatorPrivate;
    KDirOperatorPrivate *d;
};
 
#endif