#include <tdediroperator.h>

Inherits TQWidget.

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

TQString	makeCompletion (const TQString &)

TQString	makeDirCompletion (const TQString &)

void	trashSelected (TDEAction::ActivationReason, TQt::ButtonState)

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)

Public Member Functions
	KDirOperator (const KURL &urlName=KURL(), TQWidget 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 TQString &filter)

const TQString &	nameFilter () const

void	setMimeFilter (const TQStringList &mimetypes)

TQStringList	mimeFilter () const

void	clearFilter ()

KURL	url () const

void	setURL (const KURL &url, bool clearforward)

void	setCurrentItem (const TQString &filename)

void	setView (KFileView *view)

KFileView *	view () const

TQWidget *	viewWidget () const

void	setView (KFile::FileView view)

void	setSorting (TQDir::SortSpec)

TQDir::SortSpec	sorting () const

bool	isRoot () const

KDirLister *	dirLister () const

KProgress *	progressBar () const

void	setMode (KFile::Mode m)

KFile::Mode	mode () const

void	setPreviewWidget (const TQWidget *w)

const KFileItemList *	selectedItems () const

bool	isSelected (const KFileItem *item) const

int	numDirs () const

int	numFiles () const

TDECompletion *	completionObject () const

TDECompletion *	dirCompletionObject () const

TDEActionCollection *	actionCollection () const

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

bool	mkdir (const TQString &directory, bool enterDirectory=true)

TDEIO::DeleteJob *	del (const KFileItemList &items, bool ask=true, bool showProgress=true)

TDEIO::DeleteJob *	del (const KFileItemList &items, TQWidget *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)

TDEIO::CopyJob *	trash (const KFileItemList &items, TQWidget *parent, bool ask=true, bool showProgress=true)

bool	eventFilter (TQObject obj, TQEvent ev)

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 TQPoint &pos)

void	sortByName ()

void	sortBySize ()

void	sortByDate ()

void	sortReversed ()

void	toggleDirsFirst ()

void	toggleIgnoreCase ()

void	slotCompletionMatch (const TQString &match)

Protected Member Functions
virtual KFileView *	createView (TQWidget *parent, KFile::FileView view)

void	setDirLister (KDirLister *lister)

virtual void	resizeEvent (TQResizeEvent *)

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.

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 TDEIO::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.nosp@m.@kbe.nosp@m.ar.or.nosp@m.g 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, TQ_SIGNAL(urlEntered(const KURL&)),
        TQ_SLOT(urlEntered(const KURL&)));
connect(op, TQ_SIGNAL(fileHighlighted(const KFileItem *)),
        TQ_SLOT(fileHighlighted(const KFileItem *)));
connect(op, TQ_SIGNAL(fileSelected(const KFileItem *)),
        TQ_SLOT(fileSelected(const KFileItem *)));
connect(op, TQ_SIGNAL(finishedLoading()),
        TQ_SLOT(slotLoadingFinished()));
 
op->readConfig( TDEGlobal::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()).

A widget for displaying files and browsing directories.

Author: Stephan Kulow coolo.nosp@m.@kde.nosp@m..org, Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 96 of file tdediroperator.h.

Member Enumeration Documentation

◆ ActionTypes

enum KDirOperator::ActionTypes

The various action types.

These values can be or'd together

Since: 3.1

Definition at line 105 of file tdediroperator.h.

Constructor & Destructor Documentation

◆ KDirOperator()

KDirOperator::KDirOperator	(	const KURL &	urlName = `KURL()`,
		TQWidget *	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 tdediroperator.cpp.

◆ ~KDirOperator()

KDirOperator::~KDirOperator ( )

virtual

Destroys the KDirOperator.

Definition at line 152 of file tdediroperator.cpp.

Member Function Documentation

◆ actionCollection()

TDEActionCollection * 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 TDEActionCollection::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 );

KDirOperator::actionCollection

TDEActionCollection * actionCollection() const

an accessor to a collection of all available Actions.

Definition: tdediroperator.h:389

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

Returns: all available Actions

Definition at line 389 of file tdediroperator.h.

◆ activatedMenu

void KDirOperator::activatedMenu	(	const KFileItem *	,
		const TQPoint &	pos
	)

protectedvirtualslot

Called upon right-click to activate the popupmenu.

Definition at line 249 of file tdediroperator.cpp.

◆ back

void KDirOperator::back ( )

slot

Goes one step back in the history and opens that url.

Definition at line 748 of file tdediroperator.cpp.

◆ cdUp

void KDirOperator::cdUp ( )

slot

Goes one directory up from the current url.

Definition at line 779 of file tdediroperator.cpp.

◆ checkPreviewSupport()

bool KDirOperator::checkPreviewSupport ( )

protected

Checks if there support from TDEIO::PreviewJob for the currently shown files, taking mimeFilter() and nameFilter() into account Enables/disables the preview-action accordingly.

Definition at line 812 of file tdediroperator.cpp.

◆ clearFilter()

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 793 of file tdediroperator.cpp.

◆ clearHistory()

void KDirOperator::clearHistory ( )

Clears the forward and backward history.

Definition at line 1635 of file tdediroperator.cpp.

◆ close() [1/2]

void KDirOperator::close ( )

Stops loading immediately.

You don't need to call this, usually.

Definition at line 575 of file tdediroperator.cpp.

◆ close() [2/2]

virtual bool KDirOperator::close ( bool alsoDelete )

inlinevirtual

Reimplemented to avoid "hidden virtual" warnings.

Definition at line 140 of file tdediroperator.h.

◆ completionObject()

TDECompletion * KDirOperator::completionObject ( ) const

inline

Returns: a TDECompletion 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 328 of file tdediroperator.h.

◆ createView()

KFileView * KDirOperator::createView	(	TQWidget *	parent,
		KFile::FileView	view
	)

protectedvirtual

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 TQWidget 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 886 of file tdediroperator.cpp.

◆ del() [1/2]

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

Starts and returns a TDEIO::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 438 of file tdediroperator.cpp.

◆ del() [2/2]

TDEIO::DeleteJob * KDirOperator::del	(	const KFileItemList &	items,
		TQWidget *	parent,
		bool	ask = `true`,
		bool	showProgress = `true`
	)

Starts and returns a TDEIO::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 444 of file tdediroperator.cpp.

◆ deleteSelected

void KDirOperator::deleteSelected ( )

slot

Deletes the currently selected files/directories.

Definition at line 497 of file tdediroperator.cpp.

◆ dirCompletionObject()

TDECompletion * KDirOperator::dirCompletionObject ( ) const

inline

Returns: a TDECompletion 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 340 of file tdediroperator.h.

◆ dirHighlighting()

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 1670 of file tdediroperator.cpp.

◆ dirLister()

KDirLister * KDirOperator::dirLister ( ) const

inline

Returns: the object listing the directory

Definition at line 259 of file tdediroperator.h.

◆ dirOnlyMode() [1/2]

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 tdediroperator.h.

◆ dirOnlyMode() [2/2]

static bool KDirOperator::dirOnlyMode ( uint mode )

inlinestatic

Definition at line 539 of file tdediroperator.h.

◆ dropped

void KDirOperator::dropped	(	const KFileItem *	item,
		TQDropEvent *	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

◆ eventFilter()

bool KDirOperator::eventFilter	(	TQObject *	obj,
		TQEvent *	ev
	)

Definition at line 1744 of file tdediroperator.cpp.

◆ fileHighlighted

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().

◆ forward

void KDirOperator::forward ( )

slot

Goes one step forward in the history and opens that url.

Definition at line 762 of file tdediroperator.cpp.

◆ highlightFile

void KDirOperator::highlightFile ( const KFileItem * i )

inlineprotectedslot

Emits fileHighlighted( i )

Definition at line 753 of file tdediroperator.h.

◆ home

void KDirOperator::home ( )

slot

Enters the home directory.

Definition at line 786 of file tdediroperator.cpp.

◆ insertNewFiles

void KDirOperator::insertNewFiles ( const KFileItemList & newone )

protectedslot

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

Definition at line 1150 of file tdediroperator.cpp.

◆ isRoot()

bool KDirOperator::isRoot ( ) const

inline

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

Definition at line 254 of file tdediroperator.h.

◆ isSelected()

bool KDirOperator::isSelected ( const KFileItem * item ) const

inline

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

Definition at line 304 of file tdediroperator.h.

◆ itemDeleted

void KDirOperator::itemDeleted ( KFileItem * item )

protectedslot

Removes the given KFileItem item from the view (usually called from KDirLister).

Definition at line 1181 of file tdediroperator.cpp.

◆ makeCompletion

TQString KDirOperator::makeCompletion ( const TQString & string )

slot

Tries to complete the given string (only completes files).

Definition at line 1215 of file tdediroperator.cpp.

◆ makeDirCompletion

TQString KDirOperator::makeDirCompletion ( const TQString & string )

slot

Tries to complete the given string (only completes directores).

Definition at line 1226 of file tdediroperator.cpp.

◆ mimeFilter()

TQStringList KDirOperator::mimeFilter ( ) const

inline

Returns: the current mime filter.

Definition at line 179 of file tdediroperator.h.

◆ mkdir [1/2]

void KDirOperator::mkdir ( )

slot

Opens a dialog to create a new directory.

Definition at line 387 of file tdediroperator.cpp.

◆ mkdir() [2/2]

bool KDirOperator::mkdir	(	const TQString &	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 402 of file tdediroperator.cpp.

◆ mode()

KFile::Mode KDirOperator::mode ( ) const

Returns: the listing/selection mode.

Definition at line 1088 of file tdediroperator.cpp.

◆ nameFilter()

const TQString & KDirOperator::nameFilter ( ) const

inline

Returns: the current namefilter.

See also: setNameFilter

Definition at line 155 of file tdediroperator.h.

◆ numDirs()

int KDirOperator::numDirs ( ) const

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

Definition at line 282 of file tdediroperator.cpp.

◆ numFiles()

int KDirOperator::numFiles ( ) const

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

Definition at line 287 of file tdediroperator.cpp.

◆ onlyDoubleClickSelectsFiles()

bool KDirOperator::onlyDoubleClickSelectsFiles ( ) const

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

See also: setOnlyDoubleClickSelectsFiles

Definition at line 1581 of file tdediroperator.cpp.

◆ pathChanged

void KDirOperator::pathChanged ( )

protectedslot

Called after setURL() to load the directory, update the history, etc.

Definition at line 710 of file tdediroperator.cpp.

◆ prepareCompletionObjects()

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 1237 of file tdediroperator.cpp.

◆ progressBar()

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 1630 of file tdediroperator.cpp.

◆ readConfig()

void KDirOperator::readConfig	(	TDEConfig *	kc,
		const TQString &	group = `TQString::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 1449 of file tdediroperator.cpp.

◆ rereadDir

void KDirOperator::rereadDir ( )

slot

Re-reads the current url.

Definition at line 693 of file tdediroperator.cpp.

◆ resetCursor

void KDirOperator::resetCursor ( )

protectedslot

Restores the normal cursor after showing the busy-cursor.

Also hides the progressbar.

Definition at line 178 of file tdediroperator.cpp.

◆ resizeEvent()

void KDirOperator::resizeEvent ( TQResizeEvent * )

protectedvirtual

Definition at line 1565 of file tdediroperator.cpp.

◆ selectDir

void KDirOperator::selectDir ( const KFileItem * item )

protectedslot

Enters the directory specified by the given item.

Definition at line 1176 of file tdediroperator.cpp.

◆ selectedItems()

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 297 of file tdediroperator.h.

◆ selectFile

void KDirOperator::selectFile ( const KFileItem * item )

protectedslot

Emits fileSelected( item )

Definition at line 1191 of file tdediroperator.cpp.

◆ setAcceptDrops()

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

Definition at line 934 of file tdediroperator.cpp.

◆ setCurrentItem()

void KDirOperator::setCurrentItem ( const TQString & 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 1198 of file tdediroperator.cpp.

◆ setDirLister()

void KDirOperator::setDirLister ( KDirLister * lister )

protected

Sets a custom KDirLister to list directories.

Definition at line 1120 of file tdediroperator.cpp.

◆ setDropOptions()

void KDirOperator::setDropOptions ( int options )

Sets the options for dropping files.

See also: KFileView::DropOptions

Since: 3.2

Definition at line 941 of file tdediroperator.cpp.

◆ setEnableDirHighlighting()

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, because this behavior introduces bug #136630. Don't enable until this bug is fixed.

Definition at line 1665 of file tdediroperator.cpp.

◆ setMimeFilter()

void KDirOperator::setMimeFilter ( const TQStringList & mimetypes )

Sets a list of mimetypes as filter.

Only files of those mimetypes will be shown.

Example:

TQStringList 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 806 of file tdediroperator.cpp.

◆ setMode()

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 1093 of file tdediroperator.cpp.

◆ setNameFilter()

void KDirOperator::setNameFilter ( const TQString & 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 800 of file tdediroperator.cpp.

◆ setOnlyDoubleClickSelectsFiles()

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 1574 of file tdediroperator.cpp.

◆ setPreviewWidget()

void KDirOperator::setPreviewWidget ( const TQWidget * 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 266 of file tdediroperator.cpp.

◆ setShowHiddenFiles()

void KDirOperator::setShowHiddenFiles ( bool s )

inline

Enables/disables showing hidden files.

Definition at line 128 of file tdediroperator.h.

◆ setSorting()

void KDirOperator::setSorting ( TQDir::SortSpec spec )

Sets the way to sort files and directories.

Definition at line 170 of file tdediroperator.cpp.

◆ setupActions()

void KDirOperator::setupActions ( )

protected

Sets up all the actions.

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

Definition at line 1261 of file tdediroperator.cpp.

◆ setupMenu() [1/2]

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 1362 of file tdediroperator.cpp.

◆ setupMenu() [2/2]

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 1367 of file tdediroperator.cpp.

◆ setURL()

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 638 of file tdediroperator.cpp.

◆ setView() [1/2]

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

Sets one of the predefined fileviews.

See also: KFile::FileView

Definition at line 948 of file tdediroperator.cpp.

◆ setView() [2/2]

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; KCombiView; view

Definition at line 1106 of file tdediroperator.cpp.

◆ setViewConfig()

void KDirOperator::setViewConfig	(	TDEConfig *	config,
		const TQString &	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 TDEGlobal::config() anyway.

See also: viewConfig; viewConfigGroup

Since: 3.1

Definition at line 1728 of file tdediroperator.cpp.

◆ showHiddenFiles()

bool KDirOperator::showHiddenFiles ( ) const

inline

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

Definition at line 133 of file tdediroperator.h.

◆ slotCompletionMatch

void KDirOperator::slotCompletionMatch ( const TQString & match )

protectedslot

Tries to make the given match as current item in the view and emits completion( match )

Definition at line 1255 of file tdediroperator.cpp.

◆ sortByDate

void KDirOperator::sortByDate ( )

inlineprotectedslot

Changes sorting to sort by date.

Definition at line 773 of file tdediroperator.h.

◆ sortByName

void KDirOperator::sortByName ( )

inlineprotectedslot

Changes sorting to sort by name.

Definition at line 763 of file tdediroperator.h.

◆ sortBySize

void KDirOperator::sortBySize ( )

inlineprotectedslot

Changes sorting to sort by size.

Definition at line 768 of file tdediroperator.h.

◆ sorting()

TQDir::SortSpec KDirOperator::sorting ( ) const

inline

Returns: the current way of sorting files and directories

Definition at line 249 of file tdediroperator.h.

◆ sortReversed

void KDirOperator::sortReversed ( )

inlineprotectedslot

Changes sorting to reverse sorting.

Definition at line 778 of file tdediroperator.h.

◆ toggleDirsFirst

void KDirOperator::toggleDirsFirst ( )

inlineprotectedslot

Toggles showing directories first / having them sorted like files.

Definition at line 783 of file tdediroperator.h.

◆ toggleIgnoreCase

void KDirOperator::toggleIgnoreCase ( )

inlineprotectedslot

Toggles case sensitive / case insensitive sorting.

Definition at line 788 of file tdediroperator.h.

◆ trash()

TDEIO::CopyJob * KDirOperator::trash	(	const KFileItemList &	items,
		TQWidget *	parent,
		bool	ask = `true`,
		bool	showProgress = `true`
	)

Starts and returns a TDEIO::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 507 of file tdediroperator.cpp.

◆ trashSelected

void KDirOperator::trashSelected	(	TDEAction::ActivationReason	reason,
		TQt::ButtonState	state
	)

slot

Trashes the currently selected files/directories.

Since: 3.4

Definition at line 560 of file tdediroperator.cpp.

◆ updateDir

void KDirOperator::updateDir ( )

slot

to update the view after changing the settings

Definition at line 686 of file tdediroperator.cpp.

◆ updateSelectionDependentActions

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 257 of file tdediroperator.cpp.

◆ updateSortActions()

void KDirOperator::updateSortActions ( )

protected

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

See also: sorting

Definition at line 1421 of file tdediroperator.cpp.

◆ updateViewActions()

void KDirOperator::updateViewActions ( )

protected

Updates the view-related actions to comply with the current KFile::FileView.

Definition at line 1438 of file tdediroperator.cpp.

◆ url()

KURL KDirOperator::url ( ) const

Returns: the current url

Definition at line 774 of file tdediroperator.cpp.

◆ view()

KFileView * KDirOperator::view ( ) const

inline

Returns: the currently used view.

See also: setView

Definition at line 226 of file tdediroperator.h.

◆ viewChanged

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.

◆ viewConfig()

TDEConfig * KDirOperator::viewConfig ( )

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

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

Since: 3.1

Definition at line 1734 of file tdediroperator.cpp.

◆ viewConfigGroup()

TQString 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 1739 of file tdediroperator.cpp.

◆ viewWidget()

TQWidget * 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 232 of file tdediroperator.h.

◆ virtual_hook()

void KDirOperator::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Definition at line 1762 of file tdediroperator.cpp.

◆ writeConfig()

void KDirOperator::writeConfig	(	TDEConfig *	kc,
		const TQString &	group = `TQString::null`
	)

virtual

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

See also: readConfig; setViewConfig

Definition at line 1505 of file tdediroperator.cpp.

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

tdeio/tdefile

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ ActionTypes

Constructor & Destructor Documentation

◆ KDirOperator()

◆ ~KDirOperator()

Member Function Documentation

◆ actionCollection()

◆ activatedMenu

◆ back

◆ cdUp

◆ checkPreviewSupport()

◆ clearFilter()

◆ clearHistory()

◆ close() [1/2]

◆ close() [2/2]

◆ completionObject()

◆ createView()

◆ del() [1/2]

◆ del() [2/2]

◆ deleteSelected

◆ dirCompletionObject()

◆ dirHighlighting()

◆ dirLister()

◆ dirOnlyMode() [1/2]

◆ dirOnlyMode() [2/2]

◆ dropped

◆ eventFilter()

◆ fileHighlighted

◆ forward

◆ highlightFile

◆ home

◆ insertNewFiles

◆ isRoot()

◆ isSelected()

◆ itemDeleted

◆ makeCompletion

◆ makeDirCompletion

◆ mimeFilter()

◆ mkdir [1/2]

◆ mkdir() [2/2]

◆ mode()

◆ nameFilter()

◆ numDirs()

◆ numFiles()

◆ onlyDoubleClickSelectsFiles()

◆ pathChanged

◆ prepareCompletionObjects()

◆ progressBar()

◆ readConfig()

◆ rereadDir

◆ resetCursor

◆ resizeEvent()

◆ selectDir

◆ selectedItems()

◆ selectFile

◆ setAcceptDrops()

◆ setCurrentItem()

◆ setDirLister()

◆ setDropOptions()

◆ setEnableDirHighlighting()

◆ setMimeFilter()

◆ setMode()

◆ setNameFilter()

◆ setOnlyDoubleClickSelectsFiles()

◆ setPreviewWidget()

◆ setShowHiddenFiles()

◆ setSorting()

◆ setupActions()

◆ setupMenu() [1/2]

◆ setupMenu() [2/2]

◆ setURL()