KDirOperator Class Reference
#include <kdiroperator.h>
Inheritance diagram for KDirOperator:

Detailed Description
This widget works as a network transparent filebrowser.A widget for displaying files and browsing directories.You specify a URL to display and this url will be loaded via KDirLister. The user can browse through directories, highlight and select files, delete or rename files.
It supports different views, e.g. a detailed view (see KFileDetailView), a simple icon view (see KFileIconView), a combination of two views, separating directories and files ( KCombiView).
Additionally, a preview view is available (see KFilePreview), which can show either a simple or detailed view and additionally a preview widget (see setPreviewWidget()). KImageFilePreview is one implementation of a preview widget, that displays previews for all supported filetypes utilizing KIO::PreviewJob.
Currently, those classes don't support Drag&Drop out of the box -- there you have to use your own view-classes. You can use some DnD-aware views from Bj�n Sahlstr� <bjorn@kbear.org> until they will be integrated into this library. See http://devel-home.kde.org/~pfeiffer/DnD-classes.tar.gz
This widget is the one used in the KFileDialog.
Basic usage is like this:
KDirOperator *op = new KDirOperator( KURL( "file:/home/gis" ), this ); // some signals you might be interested in connect(op, SIGNAL(urlEntered(const KURL&)), SLOT(urlEntered(const KURL&))); connect(op, SIGNAL(fileHighlighted(const KFileItem *)), SLOT(fileHighlighted(const KFileItem *))); connect(op, SIGNAL(fileSelected(const KFileItem *)), SLOT(fileSelected(const KFileItem *))); connect(op, SIGNAL(finishedLoading()), SLOT(slotLoadingFinished())); op->readConfig( KGlobal::config(), "Your KDiroperator ConfigGroup" ); op->setView(KFile::Default);
This will create a childwidget of 'this' showing the directory contents of /home/gis in the default-view. The view is determined by the readConfig() call, which will read the KDirOperator settings, the user left your program with (and which you saved with op->writeConfig()).
- Author:
- Stephan Kulow <coolo@kde.org>, Carsten Pfeiffer <pfeiffer@kde.org>
Definition at line 97 of file kdiroperator.h.
Public Types | |
enum | ActionTypes { SortActions = 1, ViewActions = 2, NavActions = 4, FileActions = 8, AllActions = 15 } |
Public Slots | |
void | back () |
void | forward () |
void | home () |
void | cdUp () |
void | updateDir () |
void | rereadDir () |
void | mkdir () |
void | deleteSelected () |
void | updateSelectionDependentActions () |
QString | makeCompletion (const QString &) |
QString | makeDirCompletion (const QString &) |
void | trashSelected (KAction::ActivationReason, Qt::ButtonState) |
Signals | |
void | urlEntered (const KURL &) |
void | updateInformation (int files, int dirs) |
void | completion (const QString &) |
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, QDropEvent *event, const KURL::List &urls) |
Public Member Functions | |
KDirOperator (const KURL &urlName=KURL(), QWidget *parent=0, const char *name=0) | |
virtual | ~KDirOperator () |
void | setShowHiddenFiles (bool s) |
bool | showHiddenFiles () const |
void | close () |
virtual bool | close (bool alsoDelete) |
void | setNameFilter (const QString &filter) |
const QString & | nameFilter () const |
void | setMimeFilter (const QStringList &mimetypes) |
QStringList | mimeFilter () const |
void | clearFilter () |
KURL | url () const |
void | setURL (const KURL &url, bool clearforward) |
void | setCurrentItem (const QString &filename) |
void | setView (KFileView *view) |
KFileView * | view () const |
QWidget * | viewWidget () const |
void | setView (KFile::FileView view) |
void | setSorting (QDir::SortSpec) |
QDir::SortSpec | sorting () const |
bool | isRoot () const |
KDirLister * | dirLister () const |
KProgress * | progressBar () const |
void | setMode (KFile::Mode m) |
KFile::Mode | mode () const |
void | setPreviewWidget (const QWidget *w) |
const KFileItemList * | selectedItems () const |
bool | isSelected (const KFileItem *item) const |
int | numDirs () const |
int | numFiles () const |
KCompletion * | completionObject () const |
KCompletion * | dirCompletionObject () const |
KActionCollection * | actionCollection () const |
void | setViewConfig (KConfig *config, const QString &group) |
KConfig * | viewConfig () |
QString | viewConfigGroup () const |
virtual void | readConfig (KConfig *, const QString &group=QString::null) |
virtual void | writeConfig (KConfig *, const QString &group=QString::null) |
void | setOnlyDoubleClickSelectsFiles (bool enable) |
bool | onlyDoubleClickSelectsFiles () const |
bool | mkdir (const QString &directory, bool enterDirectory=true) |
KIO::DeleteJob * | del (const KFileItemList &items, bool ask=true, bool showProgress=true) |
KIO::DeleteJob * | del (const KFileItemList &items, QWidget *parent, bool ask=true, bool showProgress=true) |
void | clearHistory () |
void | setEnableDirHighlighting (bool enable) |
bool | dirHighlighting () const |
bool | dirOnlyMode () const |
void | setupMenu (int whichActions) |
virtual void | setAcceptDrops (bool b) |
void | setDropOptions (int options) |
KIO::CopyJob * | trash (const KFileItemList &items, QWidget *parent, bool ask=true, bool showProgress=true) |
Static Public Member Functions | |
static bool | dirOnlyMode (uint mode) |
Protected Slots | |
void | resetCursor () |
void | pathChanged () |
void | insertNewFiles (const KFileItemList &newone) |
void | itemDeleted (KFileItem *) |
void | selectDir (const KFileItem *item) |
void | selectFile (const KFileItem *item) |
void | highlightFile (const KFileItem *i) |
virtual void | activatedMenu (const KFileItem *, const QPoint &pos) |
void | sortByName () |
void | sortBySize () |
void | sortByDate () |
void | sortReversed () |
void | toggleDirsFirst () |
void | toggleIgnoreCase () |
void | slotCompletionMatch (const QString &match) |
Protected Member Functions | |
virtual KFileView * | createView (QWidget *parent, KFile::FileView view) |
void | setDirLister (KDirLister *lister) |
virtual void | resizeEvent (QResizeEvent *) |
void | setupActions () |
void | updateSortActions () |
void | updateViewActions () |
void | setupMenu () |
void | prepareCompletionObjects () |
bool | checkPreviewSupport () |
virtual void | virtual_hook (int id, void *data) |
Member Enumeration Documentation
|
The various action types. These values can be or'd together
Definition at line 106 of file kdiroperator.h. |
Constructor & Destructor Documentation
|
Constructs the KDirOperator with no initial view. As the views are configurable, call readConfig() to load the user's configuration and then setView to explicitly set a view. This constructor doesn't start loading the url, setView will do it. Definition at line 97 of file kdiroperator.cpp. |
|
Destroys the KDirOperator.
Definition at line 150 of file kdiroperator.cpp. |
Member Function Documentation
|
an accessor to a collection of all available Actions. The actions are static, they will be there all the time (no need to connect to the signals KActionCollection::inserted() or removed(). There are the following actions:
You can e.g. use actionCollection()->action( "up" )->plug( someToolBar );
Definition at line 390 of file kdiroperator.h. |
|
Called upon right-click to activate the popupmenu.
Definition at line 247 of file kdiroperator.cpp. |
|
Goes one step back in the history and opens that url.
Definition at line 746 of file kdiroperator.cpp. |
|
Goes one directory up from the current url.
Definition at line 777 of file kdiroperator.cpp. |
|
Checks if there support from KIO::PreviewJob for the currently shown files, taking mimeFilter() and nameFilter() into account Enables/disables the preview-action accordingly.
Definition at line 810 of file kdiroperator.cpp. |
|
Clears both the namefilter and mimetype filter, so that all files and directories will be shown. Call updateDir() to apply it.
Definition at line 791 of file kdiroperator.cpp. |
|
Clears the forward and backward history.
Definition at line 1628 of file kdiroperator.cpp. |
|
Reimplemented to avoid "hidden virtual" warnings.
Reimplemented from QWidget. Definition at line 141 of file kdiroperator.h. |
|
Stops loading immediately. You don't need to call this, usually. Reimplemented from QWidget. Definition at line 573 of file kdiroperator.cpp. |
|
Definition at line 329 of file kdiroperator.h. |
|
A view factory for creating predefined fileviews. Called internally by setView , but you can also call it directly. Reimplement this if you depend on self defined fileviews.
Definition at line 884 of file kdiroperator.cpp. |
|
Starts and returns a KIO::DeleteJob to delete the given
Definition at line 442 of file kdiroperator.cpp. |
|
Starts and returns a KIO::DeleteJob to delete the given
Definition at line 436 of file kdiroperator.cpp. |
|
Deletes the currently selected files/directories.
Definition at line 495 of file kdiroperator.cpp. |
|
Definition at line 341 of file kdiroperator.h. |
|
Definition at line 1663 of file kdiroperator.cpp. |
|
Definition at line 260 of file kdiroperator.h. |
|
Definition at line 538 of file kdiroperator.h. |
|
Emitted when files are dropped. Dropping files is disabled by default. You need to enable it with setAcceptDrops()
|
|
Emitted when a file is highlighted or generally the selection changes in multiselection mode.
In the latter case, |
|
Goes one step forward in the history and opens that url.
Definition at line 760 of file kdiroperator.cpp. |
|
Emits fileHighlighted( i ).
Definition at line 754 of file kdiroperator.h. |
|
Enters the home directory.
Definition at line 784 of file kdiroperator.cpp. |
|
Adds a new list of KFileItems to the view (coming from KDirLister).
Definition at line 1143 of file kdiroperator.cpp. |
|
Definition at line 255 of file kdiroperator.h. |
|
Definition at line 305 of file kdiroperator.h. |
|
Removes the given KFileItem item from the view (usually called from KDirLister).
Definition at line 1174 of file kdiroperator.cpp. |
|
Tries to complete the given string (only completes files).
Definition at line 1208 of file kdiroperator.cpp. |
|
Tries to complete the given string (only completes directores).
Definition at line 1219 of file kdiroperator.cpp. |
|
Definition at line 180 of file kdiroperator.h. |
|
Opens a dialog to create a new directory.
Definition at line 385 of file kdiroperator.cpp. |
|
Creates the given directory/url. If it is a relative path, it will be completed with the current directory. If enterDirectory is true, the directory will be entered after a successful operation. If unsuccessful, a messagebox will be presented to the user.
Definition at line 400 of file kdiroperator.cpp. |
|
Definition at line 1081 of file kdiroperator.cpp. |
|
Definition at line 156 of file kdiroperator.h. |
|
Definition at line 280 of file kdiroperator.cpp. |
|
Definition at line 285 of file kdiroperator.cpp. |
|
Definition at line 1574 of file kdiroperator.cpp. |
|
Called after setURL() to load the directory, update the history, etc.
Definition at line 708 of file kdiroperator.cpp. |
|
Synchronizes the completion objects with the entries of the currently listed url. Automatically called from makeCompletion() and makeDirCompletion() Definition at line 1230 of file kdiroperator.cpp. |
|
Definition at line 1623 of file kdiroperator.cpp. |
|
Reads the default settings for a view, i.e. the default KFile::FileView. Also reads the sorting and whether hidden files should be shown. Note: the default view will not be set - you have to call setView( KFile::Default )
Definition at line 1442 of file kdiroperator.cpp. |
|
Re-reads the current url.
Definition at line 691 of file kdiroperator.cpp. |
|
Restores the normal cursor after showing the busy-cursor. Also hides the progressbar. Definition at line 176 of file kdiroperator.cpp. |
|
Enters the directory specified by the given
Definition at line 1169 of file kdiroperator.cpp. |
|
Definition at line 298 of file kdiroperator.h. |
|
Emits fileSelected( item ).
Definition at line 1184 of file kdiroperator.cpp. |
|
Reimplemented - allow dropping of files if
Reimplemented from QWidget. Definition at line 932 of file kdiroperator.cpp. |
|
Clears the current selection and attempts to set filename is just the name, no path or url. Definition at line 1191 of file kdiroperator.cpp. |
|
Sets a custom KDirLister to list directories.
Definition at line 1113 of file kdiroperator.cpp. |
|
Sets the options for dropping files.
Definition at line 939 of file kdiroperator.cpp. |
|
When going up in the directory hierarchy, KDirOperator can highlight the directory that was just left. I.e. when you go from /home/gis/src to /home/gis, the item "src" will be made the current item. Default is off, because this behavior introduces bug #136630. Don't enable until this bug is fixed. Definition at line 1658 of file kdiroperator.cpp. |
|
Sets a list of mimetypes as filter. Only files of those mimetypes will be shown. Example: QStringList filter; filter << "text/html" << "image/png" << "inode/directory"; dirOperator->setMimefilter( filter ); Node: Without the mimetype inode/directory, only files would be shown. Call updateDir() to apply it.
Definition at line 804 of file kdiroperator.cpp. |
|
Sets the listing/selection mode for the views, an OR'ed combination of.
Definition at line 1086 of file kdiroperator.cpp. |
|
Sets a filter like "*.cpp *.h *.o". Only files matching that filter will be shown. Call updateDir() to apply it.
Definition at line 798 of file kdiroperator.cpp. |
|
This is a KFileDialog specific hack: we want to select directories with single click, but not files. But as a generic class, we have to be able to select files on single click as well. This gives us the opportunity to do both. The default is false, set it to true if you don't want files selected with single click. Definition at line 1567 of file kdiroperator.cpp. |
|
Sets a preview-widget to be shown next to the file-view.
The ownership of Definition at line 264 of file kdiroperator.cpp. |
|
Enables/disables showing hidden files.
Definition at line 129 of file kdiroperator.h. |
|
Sets the way to sort files and directories.
Definition at line 168 of file kdiroperator.cpp. |
|
Sets up all the actions. Called from the constructor, you usually better not call this. Definition at line 1254 of file kdiroperator.cpp. |
|
Sets up the context-menu with all the necessary actions. Called from the constructor, you usually don't need to call this.
Definition at line 1355 of file kdiroperator.cpp. |
|
Sets up the action menu.
Definition at line 1360 of file kdiroperator.cpp. |
|
Sets a new url to list.
Definition at line 636 of file kdiroperator.cpp. |
|
Sets one of the predefined fileviews.
Definition at line 946 of file kdiroperator.cpp. |
|
Sets a new KFileView to be used for showing and browsing files. Note: this will read the current url() to fill the view.
Definition at line 1099 of file kdiroperator.cpp. |
|
Sets the config object and the to be used group in KDirOperator. This will be used to store the view's configuration via KFileView::writeConfig() (and for KFileView::readConfig()). If you don't set this, the views cannot save and restore their configuration. Usually you call this right after KDirOperator creation so that the view instantiation can make use of it already. Note that KDirOperator does NOT take ownership of that object (typically it's KGlobal::config() anyway.
Definition at line 1721 of file kdiroperator.cpp. |
|
Definition at line 134 of file kdiroperator.h. |
|
Tries to make the given
Definition at line 1248 of file kdiroperator.cpp. |
|
Changes sorting to sort by date.
Definition at line 774 of file kdiroperator.h. |
|
Changes sorting to sort by name.
Definition at line 764 of file kdiroperator.h. |
|
Changes sorting to sort by size.
Definition at line 769 of file kdiroperator.h. |
|
Definition at line 250 of file kdiroperator.h. |
|
Changes sorting to reverse sorting.
Definition at line 779 of file kdiroperator.h. |
|
Toggles showing directories first / having them sorted like files.
Definition at line 784 of file kdiroperator.h. |
|
Toggles case sensitive / case insensitive sorting.
Definition at line 789 of file kdiroperator.h. |
|
Starts and returns a KIO::CopyJob to trash the given
Definition at line 505 of file kdiroperator.cpp. |
|
Trashes the currently selected files/directories.
Definition at line 558 of file kdiroperator.cpp. |
|
to update the view after changing the settings
Definition at line 684 of file kdiroperator.cpp. |
|
Enables/disables actions that are selection dependent. Call this e.g. when you are about to show a popup menu using some of KDirOperators actions. Definition at line 255 of file kdiroperator.cpp. |
|
Updates the sorting-related actions to comply with the current sorting.
Definition at line 1414 of file kdiroperator.cpp. |
|
Updates the view-related actions to comply with the current KFile::FileView.
Definition at line 1431 of file kdiroperator.cpp. |
|
Definition at line 772 of file kdiroperator.cpp. |
|
Definition at line 227 of file kdiroperator.h. |
|
Emitted whenever the current fileview is changed, either by an explicit call to setView() or by the user selecting a different view thru the GUI.
|
|
Returns the KConfig object used for saving and restoring view's configuration.
Definition at line 1727 of file kdiroperator.cpp. |
|
Returns the group name used for saving and restoring view's configuration.
Definition at line 1732 of file kdiroperator.cpp. |
|
Returns the widget of the current view. 0L if there is no view/widget. (KFileView itself is not a widget.) Definition at line 233 of file kdiroperator.h. |
|
Saves the current settings like sorting, simple or detailed view.
Definition at line 1498 of file kdiroperator.cpp. |
The documentation for this class was generated from the following files: