summaryrefslogtreecommitdiffstats
path: root/kio/kfile/kurlrequester.h
diff options
context:
space:
mode:
Diffstat (limited to 'kio/kfile/kurlrequester.h')
-rw-r--r--kio/kfile/kurlrequester.h301
1 files changed, 0 insertions, 301 deletions
diff --git a/kio/kfile/kurlrequester.h b/kio/kfile/kurlrequester.h
deleted file mode 100644
index f5402788a..000000000
--- a/kio/kfile/kurlrequester.h
+++ /dev/null
@@ -1,301 +0,0 @@
-/* This file is part of the KDE libraries
- Copyright (C) 1999,2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>
-
- 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 KURLREQUESTER_H
-#define KURLREQUESTER_H
-
-#include <tqhbox.h>
-
-#include <keditlistbox.h>
-#include <kfile.h>
-#include <kpushbutton.h>
-#include <kurl.h>
-
-class KComboBox;
-class KFileDialog;
-class KLineEdit;
-class KURLCompletion;
-class KURLDragPushButton;
-
-class TQString;
-class TQTimer;
-
-/**
- * This class is a widget showing a lineedit and a button, which invokes a
- * filedialog. File name completion is available in the lineedit.
- *
- * The defaults for the filedialog are to ask for one existing local file, i.e.
- * KFileDialog::setMode( KFile::File | KFile::ExistingOnly | KFile::LocalOnly )
- * The default filter is "*", i.e. show all files, and the start directory is
- * the current working directory, or the last directory where a file has been
- * selected.
- *
- * You can change this behavior by using setMode() or setFilter().
- *
- * \image html kurlrequester.png "KDE URL Requester"
- *
- * @short A widget to request a filename/url from the user
- * @author Carsten Pfeiffer <pfeiffer@kde.org>
- */
-class KIO_EXPORT KURLRequester : public TQHBox
-{
- Q_OBJECT
- TQ_PROPERTY( TQString url READ url WRITE setURL )
- TQ_PROPERTY( bool showLocalProtocol READ showLocalProtocol WRITE setShowLocalProtocol )
- TQ_PROPERTY( TQString filter READ filter WRITE setFilter )
- TQ_PROPERTY( uint mode READ mode WRITE setMode )
-
-public:
- /**
- * Constructs a KURLRequester widget.
- */
- KURLRequester( TQWidget *parent=0, const char *name=0 );
-
- /**
- * Constructs a KURLRequester widget with the initial URL @p url.
- * // TODO KDE4: Use KURL instead
- */
- KURLRequester( const TQString& url, TQWidget *parent=0, const char *name=0 );
-
- /**
- * Special constructor, which creates a KURLRequester widget with a custom
- * edit-widget. The edit-widget can be either a KComboBox or a KLineEdit
- * (or inherited thereof). Note: for geometry management reasons, the
- * edit-widget is reparented to have the KURLRequester as parent.
- */
- KURLRequester( TQWidget *editWidget, TQWidget *parent, const char *name=0 );
- /**
- * Destructs the KURLRequester.
- */
- ~KURLRequester();
-
- /**
- * @returns the current url in the lineedit. May be malformed, if the user
- * entered something weird. ~user or environment variables are substituted
- * for local files.
- * // TODO KDE4: Use KURL so that the result is properly defined
- */
- TQString url() const;
-
- /**
- * Enables/disables showing file:/ in the lineedit, when a local file has
- * been selected in the filedialog or was set via setURL().
- * Default is false, not showing file:/
- * @see showLocalProtocol
- */
- void setShowLocalProtocol( bool b );
-
- /**
- * Sets the mode of the file dialog.
- * Note: you can only select one file with the filedialog,
- * so KFile::Files doesn't make much sense.
- * @see KFileDialog::setMode()
- */
- void setMode( uint m );
-
- /**
- * Returns the current mode
- * @see KFileDialog::mode()
- * @since 3.3
- */
- uint mode() const;
-
-
- /**
- * Sets the filter for the file dialog.
- * @see KFileDialog::setFilter()
- */
- void setFilter( const TQString& filter );
-
- /**
- * Returns the current filter for the file dialog.
- * @see KFileDialog::filter()
- * @since 3.3
- */
- TQString filter() const;
-
- /**
- * @returns whether local files will be prefixed with file:/ in the
- * lineedit
- * @see setShowLocalProtocol
- */
- bool showLocalProtocol() const { return myShowLocalProt; }
- // ## KDE4: there's no reason to keep this, it should always be false
-
- /**
- * @returns a pointer to the filedialog
- * You can use this to customize the dialog, e.g. to specify a filter.
- * Never returns 0L.
- *
- * Remove in KDE4? KURLRequester should use KDirSelectDialog for
- * (mode & KFile::Directory) && !(mode & KFile::File)
- */
- virtual KFileDialog * fileDialog() const;
-
- /**
- * @returns a pointer to the lineedit, either the default one, or the
- * special one, if you used the special constructor.
- *
- * It is provided so that you can e.g. set an own completion object
- * (e.g. KShellCompletion) into it.
- */
- KLineEdit * lineEdit() const;
-
- /**
- * @returns a pointer to the combobox, in case you have set one using the
- * special constructor. Returns 0L otherwise.
- */
- KComboBox * comboBox() const;
-
- /**
- * @returns a pointer to the pushbutton. It is provided so that you can
- * specify an own pixmap or a text, if you really need to.
- */
- KPushButton * button() const;
-
- /**
- * @returns the KURLCompletion object used in the lineedit/combobox.
- */
- KURLCompletion *completionObject() const { return myCompletion; }
-
- /**
- * @returns an object, suitable for use with KEditListBox. It allows you
- * to put this KURLRequester into a KEditListBox.
- * Basically, do it like this:
- * \code
- * KURLRequester *req = new KURLRequester( someWidget );
- * [...]
- * KEditListBox *editListBox = new KEditListBox( i18n("Some Title"), req->customEditor(), someWidget );
- * \endcode
- * @since 3.1
- */
- KEditListBox::CustomEditor customEditor();
-
-public slots:
- /**
- * Sets the url in the lineedit to @p url. Depending on the state of
- * showLocalProtocol(), file:/ on local files will be shown or not.
- * @since 3.1
- * // TODO KDE4: Use KURL instead
- */
- void setURL( const TQString& url );
-
- /**
- * Sets the url in the lineedit to @p url.
- * @since 3.4
- * // TODO KDE4: rename to setURL
- */
- void setKURL( const KURL& url );
-
- /**
- * Sets the caption of the file dialog.
- * @since 3.1
- */
- virtual void setCaption( const TQString& caption );
-
- /**
- * Clears the lineedit/combobox.
- */
- void clear();
-
-signals:
- // forwards from LineEdit
- /**
- * Emitted when the text in the lineedit changes.
- * The parameter contains the contents of the lineedit.
- * @since 3.1
- */
- void textChanged( const TQString& );
-
- /**
- * Emitted when return or enter was pressed in the lineedit.
- */
- void returnPressed();
-
- /**
- * Emitted when return or enter was pressed in the lineedit.
- * The parameter contains the contents of the lineedit.
- */
- void returnPressed( const TQString& );
-
- /**
- * Emitted before the filedialog is going to open. Connect
- * to this signal to "configure" the filedialog, e.g. set the
- * filefilter, the mode, a preview-widget, etc. It's usually
- * not necessary to set a URL for the filedialog, as it will
- * get set properly from the editfield contents.
- *
- * If you use multiple KURLRequesters, you can connect all of them
- * to the same slot and use the given KURLRequester pointer to know
- * which one is going to open.
- */
- void openFileDialog( KURLRequester * );
-
- /**
- * Emitted when the user changed the URL via the file dialog.
- * The parameter contains the contents of the lineedit.
- * // TODO KDE4: Use KURL instead
- */
- void urlSelected( const TQString& );
-
-protected:
- void init();
-
- KURLCompletion * myCompletion;
-
-
-private:
- KURLDragPushButton * myButton;
- bool myShowLocalProt;
- mutable KFileDialog * myFileDialog;
-
-
-protected slots:
- /**
- * Called when the button is pressed to open the filedialog.
- * Also called when KStdAccel::Open (default is Ctrl-O) is pressed.
- */
- void slotOpenDialog();
-
-private slots:
- void slotUpdateURL();
-
-protected:
- virtual void virtual_hook( int id, void* data );
- bool eventFilter( TQObject *obj, TQEvent *ev );
-private:
- class KURLRequesterPrivate;
- KURLRequesterPrivate *d;
-};
-
-/**
- * URL requester with a combo box, for use in Designer
- */
-class KIO_EXPORT KURLComboRequester : public KURLRequester
-{
- Q_OBJECT
-public:
- /**
- * Constructs a KURLRequester widget with a combobox.
- */
- KURLComboRequester( TQWidget *parent=0, const char *name=0 );
-};
-
-
-#endif // KURLREQUESTER_H