tdefiledialog.h

/* This file is part of the KDE libraries
    Copyright (C) 1997, 1998 Richard Moore <rich@kde.org>
                  1998 Stephan Kulow <coolo@kde.org>
                  1998 Daniel Grana <grana@ie.iwi.unibe.ch>
                  2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>
                  2001 Frerich Raabe <raabe@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 __TDEFILEDIALOG_H__
#define __TDEFILEDIALOG_H__
 
#include <tqstring.h>
 
#include <kdialogbase.h>
#include <tdefile.h>
#include <kurl.h>
#include <kmimetype.h>
#include <tdeio/jobclasses.h>
 
class TQCheckBox;
class TQHBoxLayout;
class TQGridLayout;
class TQLabel;
class TQPopupMenu;
class TQVBoxLayout;
 
class TDEActionCollection;
class KDirOperator;
class KURLBar;
class KURLComboBox;
class KFileFilterCombo;
class KFileView;
class KFileItem;
class KPushButton;
class TDEToolBar;
class KPreviewWidgetBase;
 
struct KFileDialogPrivate;

class TDEIO_EXPORT KFileDialog : public KDialogBase
{
    TQ_OBJECT
 
public:

    enum OperationMode { Other = 0, Opening, Saving };

    KFileDialog(const TQString& startDir, const TQString& filter,
        TQWidget *parent, const char *name,
        bool modal);

    KFileDialog(const TQString& startDir, const TQString& filter,
        TQWidget *parent, const char *name,
        bool modal, TQWidget* widget);
 

    ~KFileDialog();

    KURL selectedURL() const;

    KURL::List selectedURLs() const;

    KURL baseURL() const;

    TQString selectedFile() const;

    TQStringList selectedFiles() const;

    void setURL(const KURL &url, bool clearforward = true);

    void setSelection(const TQString& name);

    void setOperationMode( KFileDialog::OperationMode );

    OperationMode operationMode() const;

    void setKeepLocation( bool keep );

    bool keepsLocation() const;

    void setFilter(const TQString& filter);

    TQString currentFilter() const;

    void setFilterMimeType(const TQString &label, const KMimeType::List &types, const KMimeType::Ptr &defaultType) TDE_DEPRECATED;

    KMimeType::Ptr currentFilterMimeType();

    void setMimeFilter( const TQStringList& types,
                        const TQString& defaultType = TQString::null );

    TQString currentMimeFilter() const;

    void clearFilter();

    void setPreviewWidget(const TQWidget *w) TDE_DEPRECATED;

   void setPreviewWidget(const KPreviewWidgetBase *w);

    static TQString getOpenFileName(const TQString& startDir= TQString::null,
                   const TQString& filter= TQString::null,
                   TQWidget *parent= 0,
                   const TQString& caption = TQString::null);
 

   static TQString getOpenFileNameWId(const TQString& startDir,
                                     const TQString& filter,
                                     WId parent_id, const TQString& caption);

    static TQStringList getOpenFileNames(const TQString& startDir= TQString::null,
                    const TQString& filter= TQString::null,
                    TQWidget *parent = 0,
                    const TQString& caption= TQString::null);
 
 

    static KURL getOpenURL(const TQString& startDir = TQString::null,
               const TQString& filter= TQString::null,
               TQWidget *parent= 0,
               const TQString& caption = TQString::null);
 
 

    static KURL::List getOpenURLs(const TQString& startDir= TQString::null,
                  const TQString& filter= TQString::null,
                  TQWidget *parent = 0,
                  const TQString& caption= TQString::null);
 
 

    static TQString getSaveFileName(const TQString& startDir= TQString::null,
                   const TQString& filter= TQString::null,
                   TQWidget *parent= 0,
                   const TQString& caption = TQString::null);
           
                            
    static TQString getSaveFileNameWId(const TQString& dir, const TQString& filter,
                                     WId parent_id,
                                     const TQString& caption);

    static KURL getSaveURL(const TQString& startDir= TQString::null,
               const TQString& filter= TQString::null,
               TQWidget *parent= 0,
               const TQString& caption = TQString::null);
 

    static TQString getExistingDirectory(const TQString & startDir = TQString::null,
                    TQWidget * parent = 0,
                    const TQString& caption= TQString::null);

    static KURL getExistingURL(const TQString & startDir = TQString::null,
                                  TQWidget * parent = 0,
                                  const TQString& caption= TQString::null);
    static KURL getImageOpenURL( const TQString& startDir = TQString::null,
                 TQWidget *parent = 0,
                 const TQString& caption = TQString::null );
    virtual void show();

    void setMode( KFile::Mode m );

    void setMode( unsigned int m );

    KFile::Mode mode() const;

    void setLocationLabel(const TQString& text);

    TDEToolBar *toolBar() const { return toolbar; }

    KPushButton *okButton() const;

    KPushButton *cancelButton() const;

    KURLBar *speedBar();

    TDEActionCollection *actionCollection() const;

    int pathComboIndex();

    static KURL getStartURL( const TQString& startDir, TQString& recentDirClass );

    static void setStartDir( const KURL& directory );
 
signals:
    void fileSelected(const TQString&);

    void fileHighlighted(const TQString&);

    void selectionChanged();

    void filterChanged( const TQString& filter );
 
protected:
    TDEToolBar *toolbar;
 
    static KURL *lastDirectory;
 
    KURLComboBox *locationEdit;
 
    KFileFilterCombo *filterWidget;

    virtual void keyPressEvent( TQKeyEvent *e );

    void init(const TQString& startDir, const TQString& filter, TQWidget* widget);

    virtual void initGUI();

    void multiSelectionChanged();

    virtual void readConfig( TDEConfig *, const TQString& group = TQString::null );

    virtual void writeConfig( TDEConfig *, const TQString& group = TQString::null );

    virtual void readRecentFiles( TDEConfig * );

    virtual void saveRecentFiles( TDEConfig * );

    KURL::List tokenize(const TQString& line) const;

    KURL getCompleteURL(const TQString&);

    TQString currentFilterExtension();

    void updateAutoSelectExtension();
 
 
protected slots:
    void urlEntered( const KURL& );
    void enterURL( const KURL& url );
    void enterURL( const TQString& url );
    void locationActivated( const TQString& url );

    // ### remove in KDE4
    void toolbarCallback(int);
    // ### remove in KDE4
    void pathComboChanged( const TQString& );
    // ### remove in KDE4
    void dirCompletion( const TQString& );
 
    void slotFilterChanged();
    void fileHighlighted(const KFileItem *i);
    void fileSelected(const KFileItem *i);
    void slotStatResult(TDEIO::Job* job);
    void slotLoadingFinished();
 
    void fileCompletion( const TQString& );
    void toggleSpeedbar( bool );

    void toggleBookmarks(bool show);

    virtual void updateStatusLine(int dirs, int files);
 
    virtual void slotOk();
    virtual void accept();
    virtual void slotCancel();
 
    void slotAutoSelectExtClicked();
    void addToRecentDocuments();
    void initSpeedbar();
 
private slots:
    void slotLocationChanged( const TQString& text );
 
private:
    KFileDialog(const KFileDialog&);
    KFileDialog operator=(const KFileDialog&);
 
    void setLocationText( const TQString& text );
    void updateLocationWhatsThis();
 
    void appendExtension(KURL &url);
    void updateLocationEditExtension(const TQString &);
    void updateFilter();
 
    static void initStatic();
 
    void setNonExtSelection();
 
protected:
    KDirOperator *ops;
    bool autoDirectoryFollowing;
 
    KURL::List& parseSelectedURLs() const;
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    KFileDialogPrivate *d;
};
 
#endif