# kio Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# KDirOperator Class Reference

This widget works as a network transparent filebrowser. A widget for displaying files and browsing directories. More...

`#include <kdiroperator.h>`

Inheritance diagram for KDirOperator:

[legend]
Collaboration diagram for KDirOperator:

[legend]
List of all members.

## 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)

## 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.

## Member Enumeration Documentation

enum KDirOperator::ActionTypes

The various action types.

These values can be or'd together

Since:
  3.1

Definition at line 106 of file kdiroperator.h.

## Constructor & Destructor Documentation

KDirOperator::KDirOperator | ( | const KURL & | urlName = `KURL()`,
|  | QWidget * | parent = `0`,
|  | const char * | name = `0`
| ) |

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.

References KURL::addPath(), QString::append(), QDir::currentDirPath(), QWidget::height(), QString::isEmpty(), KURL::protocol(), QPtrStack::setAutoDelete(), setDirLister(), QWidget::setFocusPolicy(), KURL::setPath(), KURL::setProtocol(), setupActions(), setupMenu(), and slotCompletionMatch().

KDirOperator::~KDirOperator | ( |  | ) | `[virtual]`

| Destroys the KDirOperator. Definition at line 150 of file kdiroperator.cpp. References resetCursor(), and KFileView::writeConfig().

## Member Function Documentation

void KDirOperator::setShowHiddenFiles | ( | bool | s | ) | `[inline]`

| Enables/disables showing hidden files. Definition at line 129 of file kdiroperator.h.

bool KDirOperator::showHiddenFiles | ( |  | ) | const`[inline]`

Returns:
  true when hidden files are shown or false otherwise.

Definition at line 134 of file kdiroperator.h.

void KDirOperator::close | ( |  | ) |

| Stops loading immediately. You don't need to call this, usually. Reimplemented from QWidget. Definition at line 573 of file kdiroperator.cpp. References KCompletion::clear(), QPtrList::clear(), resetCursor(), and KDirLister::stop().

virtual bool KDirOperator::close | ( | bool | alsoDelete | ) | `[inline, virtual]`

| Reimplemented to avoid "hidden virtual" warnings. Reimplemented from QWidget. Definition at line 141 of file kdiroperator.h. References QWidget::close().

void KDirOperator::setNameFilter | ( | const QString & | filter | ) |

Sets a filter like "*.cpp *.h *.o".

Only files matching that filter will be shown. Call updateDir() to apply it.

See also:
  KDirLister::setNameFilter

  nameFilter

Definition at line 788 of file kdiroperator.cpp.

References checkPreviewSupport(), and KDirLister::setNameFilter().

Referenced by KFileDialog::setFilter().

const QString& KDirOperator::nameFilter | ( |  | ) | const`[inline]`

Returns:
  the current namefilter.

See also:
  setNameFilter

Definition at line 156 of file kdiroperator.h.

void KDirOperator::setMimeFilter | ( | const QStringList & | mimetypes | ) |

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.

See also:
  KDirLister::setMimeFilter

  mimeFilter

Definition at line 794 of file kdiroperator.cpp.

References checkPreviewSupport(), and KDirLister::setMimeFilter().

Referenced by KFileDialog::setMimeFilter().

QStringList KDirOperator::mimeFilter | ( |  | ) | const`[inline]`

Returns:
  the current mime filter.

Definition at line 180 of file kdiroperator.h.

void KDirOperator::clearFilter | ( |  | ) |

Clears both the namefilter and mimetype filter, so that all files and directories will be shown.

Call updateDir() to apply it.

See also:
  setMimeFilter

  setNameFilter

Definition at line 781 of file kdiroperator.cpp.

References checkPreviewSupport(), KDirLister::clearMimeFilter(), and KDirLister::setNameFilter().

Referenced by KFileDialog::clearFilter(), KFileDialog::setFilter(), and KFileDialog::setMimeFilter().

KURL KDirOperator::url | ( |  | ) | const

Returns:
  the current url

Definition at line 762 of file kdiroperator.cpp.

Referenced by KFileDialog::baseURL(), del(), KFileDialog::getCompleteURL(), mkdir(), KFileDialog::readConfig(), KFileDialog::setSelection(), setView(), KFileDialog::tokenize(), and trash().

void KDirOperator::setURL | ( | const KURL & | url,
|  | bool | clearforward
| ) |

Sets a new url to list.

Parameters:

  | clearforward | specifies whether the "forward" history should be cleared.
  | url | the URL to set

Definition at line 636 of file kdiroperator.cpp.

References KURL::cd(), QPtrStack::clear(), KURL::equals(), KMessageBox::error(), QPtrStack::isEmpty(), isRoot(), KDirLister::openURL(), KURL::path(), pathChanged(), QPtrStack::push(), resetCursor(), KAction::setEnabled(), KURL::setPath(), KURL::url(), and viewWidget().

Referenced by back(), cdUp(), forward(), home(), mkdir(), selectDir(), and KFileDialog::setURL().

void KDirOperator::setCurrentItem | ( | const QString & | filename | ) |

| Clears the current selection and attempts to set `filename` the current file. filename is just the name, no path or url. Definition at line 1181 of file kdiroperator.cpp. References KFileView::clearSelection(), KFileView::ensureItemVisible(), KDirLister::findByName(), QString::isNull(), KFileView::setCurrentItem(), and KFileView::setSelected(). Referenced by slotCompletionMatch().

void KDirOperator::setView | ( | KFileView * | view | ) |

Sets a new KFileView to be used for showing and browsing files.

Note: this will read the current url() to fill the view.

See also:
  KFileView

  KFileIconView

  KFileDetailView

  KFileCombiView

  view

Definition at line 1089 of file kdiroperator.cpp.

References QWidget::setFocusProxy(), KFileView::setOnlyDoubleClickSelectsFiles(), KFileView::setSorting(), view(), viewChanged(), and KFileView::widget().

Referenced by setMode(), setPreviewWidget(), and setView().

KFileView* KDirOperator::view | ( |  | ) | const`[inline]`

Returns:
  the currently used view.

See also:
  setView

Definition at line 227 of file kdiroperator.h.

Referenced by setView().

QWidget* KDirOperator::viewWidget | ( |  | ) | const`[inline]`

| 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. Referenced by mkdir(), pathChanged(), and setURL().

void KDirOperator::setView | ( | KFile::FileView | view | ) |

Sets one of the predefined fileviews.

See also:
  KFile::FileView

Definition at line 936 of file kdiroperator.cpp.

References KActionCollection::action(), createView(), KAction::isEnabled(), KFile::isPreviewInfo(), mode(), KToggleAction::setChecked(), KAction::setEnabled(), setView(), and url().

void KDirOperator::setSorting | ( | QDir::SortSpec |  | ) |

| Sets the way to sort files and directories. Definition at line 168 of file kdiroperator.cpp. References KFileView::setSorting(), and updateSortActions(). Referenced by readConfig().

QDir::SortSpec KDirOperator::sorting | ( |  | ) | const`[inline]`

Returns:
  the current way of sorting files and directories

Definition at line 250 of file kdiroperator.h.

bool KDirOperator::isRoot | ( |  | ) | const`[inline]`

Returns:
  true if we are displaying the root directory of the current url

Definition at line 255 of file kdiroperator.h.

Referenced by setURL().

KDirLister* KDirOperator::dirLister | ( |  | ) | const`[inline]`

Returns:
  the object listing the directory

Definition at line 260 of file kdiroperator.h.

KProgress * KDirOperator::progressBar | ( |  | ) | const

Returns:
  the progress widget, that is shown during directory listing. You can for example reparent() it to put it into a statusbar.

Definition at line 1612 of file kdiroperator.cpp.

void KDirOperator::setMode | ( | KFile::Mode | m | ) |

Sets the listing/selection mode for the views, an OR'ed combination of

- File
- Directory
- Files
- ExistingOnly
- LocalOnly.

You cannot mix File and Files of course, as the former means single-selection mode, the latter multi-selection.

Definition at line 1076 of file kdiroperator.cpp.

References dirOnlyMode(), KDirLister::setDirOnlyMode(), and setView().

Referenced by KFileDialog::setMode().

KFile::Mode KDirOperator::mode | ( |  | ) | const

Returns:
  the listing/selection mode.

Definition at line 1071 of file kdiroperator.cpp.

Referenced by KFileDialog::mode(), KFileDialog::selectedFiles(), KFileDialog::selectedURLs(), and setView().

void KDirOperator::setPreviewWidget | ( | const QWidget * | w | ) |

| Sets a preview-widget to be shown next to the file-view. The ownership of `w` is transferred to KDirOperator, so don't delete it yourself! Definition at line 264 of file kdiroperator.cpp. References KActionCollection::action(), KToggleAction::setChecked(), KAction::setEnabled(), and setView(). Referenced by KFileDialog::setPreviewWidget().

const KFileItemList* KDirOperator::selectedItems | ( |  | ) | const`[inline]`

Returns:
  a list of all currently selected items. If there is no view, then 0L is returned.

Definition at line 298 of file kdiroperator.h.

Referenced by KFileDialog::multiSelectionChanged().

bool KDirOperator::isSelected | ( | const KFileItem * | item | ) | const`[inline]`

Returns:
  true if `item` is currently selected, or false otherwise.

Definition at line 305 of file kdiroperator.h.

int KDirOperator::numDirs | ( |  | ) | const

Returns:
  the number of directories in the currently listed url. Returns 0 if there is no view.

Definition at line 280 of file kdiroperator.cpp.

References KFileView::numDirs().

int KDirOperator::numFiles | ( |  | ) | const

Returns:
  the number of files in the currently listed url. Returns 0 if there is no view.

Definition at line 285 of file kdiroperator.cpp.

References KFileView::numFiles().

KCompletion* KDirOperator::completionObject | ( |  | ) | const`[inline]`

Returns:
  a KCompletion object, containing all filenames and directories of the current directory/URL. You can use it to insert it into a KLineEdit or KComboBox Note: it will only contain files, after prepareCompletionObjects() has been called. It will be implicitly called from makeCompletion() or makeDirCompletion()

Definition at line 329 of file kdiroperator.h.

KCompletion* KDirOperator::dirCompletionObject | ( |  | ) | const`[inline]`

Returns:
  a KCompletion object, containing only all directories of the current directory/URL. You can use it to insert it into a KLineEdit or KComboBox Note: it will only contain directories, after prepareCompletionObjects() has been called. It will be implicitly called from makeCompletion() or makeDirCompletion()

Definition at line 341 of file kdiroperator.h.

KActionCollection* KDirOperator::actionCollection | ( |  | ) | const`[inline]`

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:

- popupMenu : an ActionMenu presenting a popupmenu with all actions
- up : changes to the parent directory
- back : goes back to the previous directory
- forward : goes forward in the history
- home : changes to the user's home directory
- reload : reloads the current directory
- separator : a separator
- mkdir : opens a dialog box to create a directory
- delete : deletes the selected files/directories
- sorting menu : an ActionMenu containing all sort-options
- by name : sorts by name
- by date : sorts by date
- by size : sorts by size
- reversed : reverses the sort order
- dirs first : sorts directories before files
- case insensitive : sorts case insensitively
- view menu : an ActionMenu containing all actions concerning the view
- short view : shows a simple fileview
- detailed view : shows a detailed fileview (dates, permissions ,...)
- show hidden : shows hidden files
- separate dirs : shows directories in a separate pane
- preview : shows a preview next to the fileview
- single : hides the separate view for directories or the preview
- properties : shows a KPropertiesDialog for the selected files

The short and detailed view are in an exclusive group. The sort-by actions are in an exclusive group as well. Also the "separate dirs", "preview" and "single" actions are in an exclusive group.

You can e.g. use

     actionCollection()->action( "up" )->plug( someToolBar );

to add a button into a toolbar, which makes the dirOperator change to its parent directory.

Returns:
  all available Actions

Definition at line 390 of file kdiroperator.h.

Referenced by KFileDialog::actionCollection(), KFileDialog::init(), and KFileDialog::toggleSpeedbar().

void KDirOperator::setViewConfig | ( | KConfig * | config,
|  | const QString & | group
| ) |

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.

See also:
  viewConfig

  viewConfigGroup

Since:
  3.1

Definition at line 1710 of file kdiroperator.cpp.

Referenced by KFileDialog::init().

KConfig * KDirOperator::viewConfig | ( |  | ) |

Returns the KConfig object used for saving and restoring view's configuration.

Returns:
  the KConfig object used for saving and restoring view's configuration.

Since:
  3.1

Definition at line 1716 of file kdiroperator.cpp.

QString KDirOperator::viewConfigGroup | ( |  | ) | const

Returns the group name used for saving and restoring view's configuration.

Returns:
  the group name used for saving and restoring view's configuration.

Since:
  3.1

Definition at line 1721 of file kdiroperator.cpp.

void KDirOperator::readConfig | ( | KConfig * | ,
|  | const QString & | group = `QString::null`
| ) | `[virtual]`

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 )

to apply it.

See also:
  setView

  setViewConfig

  writeConfig

Definition at line 1431 of file kdiroperator.cpp.

References QString::fromLatin1(), KAction::group, KToggleAction::setChecked(), KAction::setGroup(), KDirLister::setShowingDotFiles(), and setSorting().

Referenced by KFileDialog::readConfig().

void KDirOperator::writeConfig | ( | KConfig * | ,
|  | const QString & | group = `QString::null`
| ) | `[virtual]`

Saves the current settings like sorting, simple or detailed view.

See also:
  readConfig

  setViewConfig

Definition at line 1487 of file kdiroperator.cpp.

References KActionCollection::action(), QString::fromLatin1(), KAction::group, KToggleAction::isChecked(), and KAction::isEnabled().

Referenced by KFileDialog::writeConfig().

void KDirOperator::setOnlyDoubleClickSelectsFiles | ( | bool | enable | ) |

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 1556 of file kdiroperator.cpp.

References KFileView::setOnlyDoubleClickSelectsFiles().

Referenced by KFileDialog::init().

bool KDirOperator::onlyDoubleClickSelectsFiles | ( |  | ) | const

Returns:
  whether files (not directories) should only be select()ed by double-clicks.

See also:
  setOnlyDoubleClickSelectsFiles

Definition at line 1563 of file kdiroperator.cpp.

References KFileView::onlyDoubleClickSelectsFiles().

bool KDirOperator::mkdir | ( | const QString & | directory,
|  | bool | enterDirectory = `true`
| ) |

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.

Returns:
  true if the directory could be created.

Definition at line 400 of file kdiroperator.cpp.

References KURL::addPath(), KIO::NetAccess< T, K >::exists(), KIO::NetAccess< T, K >::mkdir(), KURL::pathOrURL(), setURL(), KMessageBox::sorry(), QStringList::split(), QWidget::topLevelWidget(), url(), and viewWidget().

KIO::DeleteJob * KDirOperator::del | ( | const KFileItemList & | items,
|  | bool | ask = `true`,
|  | bool | showProgress = `true`
| ) |

Starts and returns a KIO::DeleteJob to delete the given `items`.

Parameters:

  | items | the list of items to be deleted
  | ask | specifies whether a confirmation dialog should be shown
  | showProgress | passed to the DeleteJob to show a progress dialog

Definition at line 436 of file kdiroperator.cpp.

Referenced by deleteSelected().

KIO::DeleteJob * KDirOperator::del | ( | const KFileItemList & | items,
|  | QWidget * | parent,
|  | bool | ask = `true`,
|  | bool | showProgress = `true`
| ) |

Starts and returns a KIO::DeleteJob to delete the given `items`.

Parameters:

  | items | the list of items to be deleted
  | parent | the parent widget used for the confirmation dialog
  | ask | specifies whether a confirmation dialog should be shown
  | showProgress | passed to the DeleteJob to show a progress dialog

Since:
  3.1

Definition at line 442 of file kdiroperator.cpp.

References QValueList::append(), QPtrListIterator::current(), KIO::del(), KStdGuiItem::del(), KMessageBox::information(), KURL::isLocalFile(), KURL::path(), KURL::prettyURL(), KIO::Job::setAutoErrorHandlingEnabled(), KIO::Job::setWindow(), QWidget::topLevelWidget(), KURL::url(), url(), KMessageBox::warningContinueCancel(), and KMessageBox::warningContinueCancelList().

void KDirOperator::clearHistory | ( |  | ) |

| Clears the forward and backward history. Definition at line 1617 of file kdiroperator.cpp. References QPtrStack::clear(), and KAction::setEnabled(). Referenced by KFileDialog::getOpenFileName(), KFileDialog::getOpenFileNames(), KFileDialog::getOpenFileNameWId(), KFileDialog::getOpenURL(), KFileDialog::getOpenURLs(), and KFileDialog::setPreviewWidget().

void KDirOperator::setEnableDirHighlighting | ( | bool | enable | ) |

| 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. Definition at line 1647 of file kdiroperator.cpp.

bool KDirOperator::dirHighlighting | ( |  | ) | const

Returns:
  whether the last directory will be made the current item when going up in the directory hierarchy.

Default is false.

Definition at line 1652 of file kdiroperator.cpp.

bool KDirOperator::dirOnlyMode | ( |  | ) | const`[inline]`

Returns:
  true if we are in directory-only mode, that is, no files are shown.

Definition at line 537 of file kdiroperator.h.

Referenced by KFileDialog::setMode(), and setMode().

void KDirOperator::setupMenu | ( | int | whichActions | ) |

Sets up the action menu.

Parameters:

  | whichActions | is an value of OR'd ActionTypes that controls which actions to show in the action menu

Definition at line 1349 of file kdiroperator.cpp.

References KActionCollection::action(), QPopupMenu::clear(), KGlobal::config(), KActionMenu::insert(), KURL::isLocalFile(), KApplication::keyboardMouseState(), KActionMenu::popupMenu(), and KConfigBase::readBoolEntry().

Referenced by KFileDialog::init().

void KDirOperator::setAcceptDrops | ( | bool | b | ) | `[virtual]`

Reimplemented - allow dropping of files if `b` is true.

Parameters:

  | b | true if the widget should allow dropping of files

Reimplemented from QWidget.

Definition at line 922 of file kdiroperator.cpp.

References QWidget::setAcceptDrops(), and KFileView::widget().

void KDirOperator::setDropOptions | ( | int | options | ) |

Sets the options for dropping files.

See also:
  KFileView::DropOptions

Since:
  3.2

Definition at line 929 of file kdiroperator.cpp.

References KFileView::setDropOptions().

KIO::CopyJob * KDirOperator::trash | ( | const KFileItemList & | items,
|  | QWidget * | parent,
|  | bool | ask = `true`,
|  | bool | showProgress = `true`
| ) |

Starts and returns a KIO::CopyJob to trash the given `items`.

Parameters:

  | items | the list of items to be trashed
  | parent | the parent widget used for the confirmation dialog
  | ask | specifies whether a confirmation dialog should be shown
  | showProgress | passed to the CopyJob to show a progress dialog

Since:
  3.4

Definition at line 505 of file kdiroperator.cpp.

References QValueList::append(), QPtrListIterator::current(), KMessageBox::information(), KURL::isLocalFile(), KURL::path(), KURL::prettyURL(), KIO::Job::setAutoErrorHandlingEnabled(), KIO::Job::setWindow(), QWidget::topLevelWidget(), KIO::trash(), KURL::url(), url(), KMessageBox::warningContinueCancel(), and KMessageBox::warningContinueCancelList().

Referenced by setupActions(), and trashSelected().

KFileView * KDirOperator::createView | ( | QWidget * | parent,
|  | KFile::FileView | view
| ) | `[protected, virtual]`

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.

Parameters:

  | parent | is the QWidget to be set as parent
  | view | is the predefined view to be set, note: this can be several ones OR:ed together.

Returns:
  the created KFileView

See also:
  KFileView

  KCombiView

  KFileDetailView

  KFileIconView

  KFilePreview

  KFile::FileView

  setView

Definition at line 874 of file kdiroperator.cpp.

References QWidget::acceptDrops(), KFile::isPreviewInfo(), QWidget::setAcceptDrops(), KFileView::setOnlyDoubleClickSelectsFiles(), KCombiView::setRight(), KFileView::setViewName(), and KFileView::widget().

Referenced by setView().

void KDirOperator::setDirLister | ( | KDirLister * | lister | ) | `[protected]`

| Sets a custom KDirLister to list directories. Definition at line 1103 of file kdiroperator.cpp. References endl(), insertNewFiles(), itemDeleted(), kdDebug(), KDirLister::setAutoUpdate(), KDirLister::setMainWindow(), and QWidget::topLevelWidget(). Referenced by KDirOperator().

void KDirOperator::setupActions | ( |  | ) | `[protected]`

Sets up all the actions.

Called from the constructor, you usually better not call this.

Definition at line 1244 of file kdiroperator.cpp.

References back(), KStdAction::back(), cdUp(), deleteSelected(), forward(), KStdAction::forward(), QString::fromLatin1(), home(), KStdAction::home(), mkdir(), KActionMenu::popupMenu(), KStdAction::redisplay(), rereadDir(), KToggleAction::setCheckedState(), KToggleAction::setExclusiveGroup(), KAction::setIcon(), KAction::setShortcut(), KAction::setText(), trash(), trashSelected(), and KStdAction::up().

Referenced by KDirOperator().

void KDirOperator::updateSortActions | ( |  | ) | `[protected]`

Updates the sorting-related actions to comply with the current sorting.

See also:
  sorting

Definition at line 1403 of file kdiroperator.cpp.

References KFileView::isReversed(), KToggleAction::setChecked(), and KAction::setEnabled().

Referenced by setSorting().

void KDirOperator::updateViewActions | ( |  | ) | `[protected]`

| Updates the view-related actions to comply with the current KFile::FileView. Definition at line 1420 of file kdiroperator.cpp. References KAction::isEnabled(), and KToggleAction::setChecked().

void KDirOperator::setupMenu | ( |  | ) | `[protected]`

Sets up the context-menu with all the necessary actions.

Called from the constructor, you usually don't need to call this.

Since:
  3.1

Definition at line 1344 of file kdiroperator.cpp.

Referenced by activatedMenu(), and KDirOperator().

void KDirOperator::prepareCompletionObjects | ( |  | ) | `[protected]`

| Synchronizes the completion objects with the entries of the currently listed url. Automatically called from makeCompletion() and makeDirCompletion() Definition at line 1220 of file kdiroperator.cpp. References KCompletion::addItem(), KFileItem::isDir(), KFileView::items(), and KFileItem::name(). Referenced by makeCompletion(), and makeDirCompletion().

bool KDirOperator::checkPreviewSupport | ( |  | ) | `[protected]`

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 800 of file kdiroperator.cpp.

References KActionCollection::action(), KGlobal::config(), KConfigBase::readBoolEntry(), and KAction::setEnabled().

Referenced by clearFilter(), setMimeFilter(), and setNameFilter().

void KDirOperator::back | ( |  | ) | `[slot]`

| Goes one step back in the history and opens that url. Definition at line 736 of file kdiroperator.cpp. References QPtrStack::isEmpty(), QPtrStack::pop(), QPtrStack::push(), and setURL(). Referenced by pathChanged(), and setupActions().

void KDirOperator::forward | ( |  | ) | `[slot]`

| Goes one step forward in the history and opens that url. Definition at line 750 of file kdiroperator.cpp. References QPtrStack::isEmpty(), QPtrStack::pop(), QPtrStack::push(), and setURL(). Referenced by setupActions().

void KDirOperator::home | ( |  | ) | `[slot]`

| Enters the home directory. Definition at line 774 of file kdiroperator.cpp. References KURL::setPath(), and setURL(). Referenced by pathChanged(), and setupActions().

void KDirOperator::cdUp | ( |  | ) | `[slot]`

| Goes one directory up from the current url. Definition at line 767 of file kdiroperator.cpp. References KURL::cd(), and setURL(). Referenced by setupActions().

void KDirOperator::updateDir | ( |  | ) | `[slot]`

| to update the view after changing the settings Definition at line 684 of file kdiroperator.cpp. References KDirLister::emitChanges(), and KFileView::listingCompleted().

void KDirOperator::rereadDir | ( |  | ) | `[slot]`

| Re-reads the current url. Definition at line 691 of file kdiroperator.cpp. References KDirLister::openURL(), and pathChanged(). Referenced by setupActions().

void KDirOperator::mkdir | ( |  | ) | `[slot]`

| Opens a dialog to create a new directory. Definition at line 385 of file kdiroperator.cpp. References KInputDialog::getText(), KURL::pathOrURL(), KIO::RenameDlg::suggestName(), and url(). Referenced by setupActions().

void KDirOperator::deleteSelected | ( |  | ) | `[slot]`

| Deletes the currently selected files/directories. Definition at line 495 of file kdiroperator.cpp. References del(), and KFileView::selectedItems(). Referenced by setupActions(), and trashSelected().

void KDirOperator::updateSelectionDependentActions | ( |  | ) | `[slot]`

| 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. References KActionCollection::action(), QPtrList::isEmpty(), KFileView::selectedItems(), and KAction::setEnabled(). Referenced by activatedMenu().

QString KDirOperator::makeCompletion | ( | const QString & |  | ) | `[slot]`

| Tries to complete the given string (only completes files). Definition at line 1198 of file kdiroperator.cpp. References KFileView::clearSelection(), KCompletion::makeCompletion(), and prepareCompletionObjects().

QString KDirOperator::makeDirCompletion | ( | const QString & |  | ) | `[slot]`

| Tries to complete the given string (only completes directores). Definition at line 1209 of file kdiroperator.cpp. References KFileView::clearSelection(), KCompletion::makeCompletion(), and prepareCompletionObjects().

void KDirOperator::trashSelected | ( | KAction::ActivationReason | ,
|  | Qt::ButtonState |
| ) | `[slot]`

Trashes the currently selected files/directories.

Since:
  3.4

Definition at line 558 of file kdiroperator.cpp.

References deleteSelected(), KFileView::selectedItems(), and trash().

Referenced by setupActions().

void KDirOperator::resetCursor | ( |  | ) | `[protected, slot]`

| Restores the normal cursor after showing the busy-cursor. Also hides the progressbar. Definition at line 176 of file kdiroperator.cpp. References QApplication::restoreOverrideCursor(). Referenced by close(), insertNewFiles(), setURL(), and ~KDirOperator().

void KDirOperator::pathChanged | ( |  | ) | `[protected, slot]`

| Called after setURL() to load the directory, update the history, etc. Definition at line 698 of file kdiroperator.cpp. References back(), KCompletion::clear(), KFileView::clear(), QPtrList::clear(), KMessageBox::error(), home(), QPtrStack::isEmpty(), QApplication::restoreOverrideCursor(), QApplication::setOverrideCursor(), and viewWidget(). Referenced by rereadDir(), and setURL().

void KDirOperator::insertNewFiles | ( | const KFileItemList & | newone | ) | `[protected, slot]`

Adds a new list of KFileItems to the view (coming from KDirLister).

Definition at line 1133 of file kdiroperator.cpp.

References KFileView::addItemList(), QPtrListIterator::current(), KFileView::ensureItemVisible(), KFileItem::isDir(), KFileView::numDirs(), KFileView::numFiles(), resetCursor(), KFileView::setCurrentItem(), QTimer::singleShot(), KURL::url(), and KFileItem::url().

Referenced by setDirLister().

void KDirOperator::itemDeleted | ( | KFileItem * |  | ) | `[protected, slot]`

| Removes the given KFileItem item from the view (usually called from KDirLister). Definition at line 1164 of file kdiroperator.cpp. References KFileView::numDirs(), KFileView::numFiles(), KFileView::removeItem(), and QPtrList::removeRef(). Referenced by setDirLister().

void KDirOperator::selectDir | ( | const KFileItem * | item | ) | `[protected, slot]`

| Enters the directory specified by the given `item`. Definition at line 1159 of file kdiroperator.cpp. References setURL().

void KDirOperator::selectFile | ( | const KFileItem * | item | ) | `[protected, slot]`

| Emits fileSelected( item ). Definition at line 1174 of file kdiroperator.cpp. References QApplication::restoreOverrideCursor().

void KDirOperator::highlightFile | ( | const KFileItem * | i | ) | `[inline, protected, slot]`

| Emits fileHighlighted( i ). Definition at line 753 of file kdiroperator.h.

void KDirOperator::activatedMenu | ( | const KFileItem * | ,
|  | const QPoint & | pos
| ) | `[protected, virtual, slot]`

| Called upon right-click to activate the popupmenu. Definition at line 247 of file kdiroperator.cpp. References KActionMenu::popup(), setupMenu(), and updateSelectionDependentActions().

void KDirOperator::sortByName | ( |  | ) | `[inline, protected, slot]`

| Changes sorting to sort by name. Definition at line 763 of file kdiroperator.h.

void KDirOperator::sortBySize | ( |  | ) | `[inline, protected, slot]`

| Changes sorting to sort by size. Definition at line 768 of file kdiroperator.h.

void KDirOperator::sortByDate | ( |  | ) | `[inline, protected, slot]`

| Changes sorting to sort by date. Definition at line 773 of file kdiroperator.h.

void KDirOperator::sortReversed | ( |  | ) | `[inline, protected, slot]`

| Changes sorting to reverse sorting. Definition at line 778 of file kdiroperator.h.

void KDirOperator::toggleDirsFirst | ( |  | ) | `[inline, protected, slot]`

| Toggles showing directories first / having them sorted like files. Definition at line 783 of file kdiroperator.h.

void KDirOperator::toggleIgnoreCase | ( |  | ) | `[inline, protected, slot]`

| Toggles case sensitive / case insensitive sorting. Definition at line 788 of file kdiroperator.h.

void KDirOperator::slotCompletionMatch | ( | const QString & | match | ) | `[protected, slot]`

| Tries to make the given `match` as current item in the view and emits completion( match ). Definition at line 1238 of file kdiroperator.cpp. References setCurrentItem(). Referenced by KDirOperator().

void KDirOperator::viewChanged | ( | KFileView * | newView | ) | `[signal]`

| 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. Referenced by setView().

void KDirOperator::fileHighlighted | ( | const KFileItem * | item | ) | `[signal]`

| Emitted when a file is highlighted or generally the selection changes in multiselection mode. In the latter case, `item` is 0L. You can access the selected items with selectedItems().

void KDirOperator::dropped | ( | const KFileItem * | item,
|  | QDropEvent * | event,
|  | const KURL::List & | urls
| ) | `[signal]`

Emitted when files are dropped.

Dropping files is disabled by default. You need to enable it with setAcceptDrops()

Parameters:

  | item | the item on which the drop occurred or 0.
  | event | the drop event itself.
  | urls | the urls that where dropped.

Since:
  3.2

The documentation for this class was generated from the following files:

- kdiroperator.h
- kdiroperator.cpp

This file is part of the documentation for kio Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:24:29 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003