// -*- c++ -*-
/* This file is part of the KDE libraries
Copyright (C) 1997 Stephan Kulow
Copyright (C) 2001 Carsten Pfeiffer
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef KFILEVIEW_H
#define KFILEVIEW_H
class QPoint;
class KActionCollection;
#include
#include "kfileitem.h"
#include "kfile.h"
/**
* internal class to make easier to use signals possible
* @internal
**/
class KFileViewSignaler : public QObject
{
Q_OBJECT
public:
/**
* Call this method when an item is selected (depends on single click /
* double click configuration). Emits the appropriate signal.
**/
void activate( const KFileItem *item ) {
if ( item->isDir() )
emit dirActivated( item );
else
emit fileSelected( item );
}
/**
* emits the highlighted signal for item. Call this in your view class
* whenever the selection changes.
*/
void highlightFile(const KFileItem *i) { emit fileHighlighted(i); }
void activateMenu( const KFileItem *i, const QPoint& pos ) {
emit activatedMenu( i, pos );
}
void changeSorting( QDir::SortSpec sorting ) {
emit sortingChanged( sorting );
}
signals:
void dirActivated(const KFileItem*);
void sortingChanged( QDir::SortSpec );
/**
* the item maybe be 0L, indicating that we're in multiselection mode and
* the selection has changed.
*/
void fileHighlighted(const KFileItem*);
void fileSelected(const KFileItem*);
void activatedMenu( const KFileItem *i, const QPoint& );
};
/**
* This class defines an interface to all file views. Its intent is
* to allow to switch the view of the files in the selector very easily.
* It defines some pure virtual functions, that must be implemented to
* make a file view working.
*
* Since this class is not a widget, but it's meant to be added to other
* widgets, its most important function is @ref widget. This should return
* a pointer to the implemented widget.
*
* @short A base class for views of the KDE file selector
* @author Stephan Kulow
* @version $Id: kfileview_h.html 149726 2002-04-16 07:39:43Z dfaure $
**/
class KFileView {
public:
KFileView();
/**
* Destructor
*/
virtual ~KFileView();
/**
* inserts a list of items.
**/
void addItemList(const KFileItemList &list);
/**
* a pure virtual function to get a QWidget, that can be added to
* other widgets. This function is needed to make it possible for
* derived classes to derive from other widgets.
**/
virtual QWidget *widget() = 0;
/**
* ### As const-method, to be fixed in 3.0
*/
QWidget *widget() const { return const_cast(this)->widget(); }
/**
* Sets @p filename the current item in the view, if available.
*/
void setCurrentItem( const QString &filename );
/**
* Reimplement this to set @p item the current item in the view, e.g.
* the item having focus.
*/
virtual void setCurrentItem( const KFileItem *item ) = 0;
/**
* @returns the "current" KFileItem, e.g. where the cursor is.
* Returns 0L when there is no current item (e.g. in an empty view).
* Subclasses have to implement this.
*/
virtual KFileItem *currentFileItem() const = 0;
/**
* Clears the view and all item lists.
*/
virtual void clear();
/**
* does a repaint of the view.
*
* The default implementation calls
* widget()->repaint(f)
**/
virtual void updateView(bool f = true);
virtual void updateView(const KFileItem*);
/**
* Removes an item from the list; has to be implemented by the view.
* Call KFileView::removeItem( item ) after removing it.
*/
virtual void removeItem(const KFileItem *item);
/**
* This hook is called when all items of the currently listed directory
* are listed and inserted into the view, i.e. there won't come any new
* items anymore.
*/
virtual void listingCompleted();
/**
* Returns the sorting order of the internal list. Newly added files
* are added through this sorting.
*/
QDir::SortSpec sorting() const { return m_sorting; }
/**
* Sets the sorting order of the view.
*
* Default is QDir::Name | QDir::IgnoreCase | QDir::DirsFirst
* Override this in your subclass and sort accordingly (usually by
* setting the sorting-key for every item and telling QIconView
* or QListView to sort.
*
* A view may choose to use a different sorting than QDir::Name, Time
* or Size. E.g. to sort by mimetype or any possible string. Set the
* sorting to QDir::Unsorted for that and do the rest internally.
*
* @see #sortingKey
*/
virtual void setSorting(QDir::SortSpec sort);
/**
* Tells whether the current items are in reversed order (shortcut to
* sorting() & QDir::Reversed).
*/
bool isReversed() const { return (m_sorting & QDir::Reversed); }
void sortReversed();
/**
* @returns the number of dirs and files
**/
uint count() const { return filesNumber + dirsNumber; }
/**
* @returns the number of files.
**/
uint numFiles() const { return filesNumber; }
/**
* @returns the number of directories
**/
uint numDirs() const { return dirsNumber; }
virtual void setSelectionMode( KFile::SelectionMode sm );
virtual KFile::SelectionMode selectionMode() const;
enum ViewMode {
Files = 1,
Directories = 2,
All = Files | Directories
};
virtual void setViewMode( ViewMode vm );
virtual ViewMode viewMode() const { return view_mode; }
/**
* @returns the localized name of the view, which could be displayed
* somewhere, e.g. in a menu, where the user can choose between views.
* @see #setViewName
*/
QString viewName() const { return m_viewName; }
/**
* Sets the name of the view, which could be displayed somewhere.
* E.g. "Image Preview".
*/
void setViewName( const QString& name ) { m_viewName = name; }
virtual void setParentView(KFileView *parent);
/**
* The derived view must implement this function to add
* the file in the widget.
*
* Make sure to call this implementation, i.e.
* KFileView::insertItem( i );
*
*/
virtual void insertItem( KFileItem *i);
/**
* pure virtual function, that should be implemented to clear
* the view. At this moment the list is already empty
**/
virtual void clearView() = 0;
/**
* pure virtual function, that should be implemented to make item i
* visible, i.e. by scrolling the view appropriately.
*/
virtual void ensureItemVisible( const KFileItem *i ) = 0;
/**
* Clears any selection, unhighlights everything. Must be implemented by
* the view.
*/
virtual void clearSelection() = 0;
/**
* Selects all items. You may want to override this, if you can implement
* it more efficiently than calling setSelected() with every item.
* This works only in Multiselection mode of course.
*/
virtual void selectAll();
/**
* Inverts the current selection, i.e. selects all items, that were up to
* now not selected and deselects the other.
*/
virtual void invertSelection();
/**
* Tells the view that it should highlight the item.
* This function must be implemented by the view.
**/
virtual void setSelected(const KFileItem *, bool enable) = 0;
/**
* @returns whether the given item is currently selected.
* Must be implemented by the view.
*/
virtual bool isSelected( const KFileItem * ) const = 0;
/**
* @returns all currently highlighted items.
*/
const KFileItemList * selectedItems() const;
/**
* @returns all items currently available in the current sort-order
*/
const KFileItemList * items() const;
virtual KFileItem * firstFileItem() const = 0;
virtual KFileItem * nextItem( const KFileItem * ) const = 0;
virtual KFileItem * prevItem( const KFileItem * ) const = 0;
/**
* 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.
*
* Every view has to decide when to call select( item ) when a file was
* single-clicked, based on @ref onlyDoubleClickSelectsFiles().
*/
void setOnlyDoubleClickSelectsFiles( bool enable ) {
myOnlyDoubleClickSelectsFiles = enable;
}
/**
* @returns whether files (not directories) should only be select()ed by
* double-clicks.
* @see #setOnlyDoubleClickSelectsFiles
*/
bool onlyDoubleClickSelectsFiles() const {
return myOnlyDoubleClickSelectsFiles;
}
/**
* increases the number of dirs and files.
* @returns true if the item fits the view mode
*/
bool updateNumbers(const KFileItem *i);
// ### make virtual and override in kfilepreview and kcombiview
// Made virtual and overrode in kfilepreview -- ellis, 2002/01/27
/**
* @returns the view-specific action-collection. Every view should
* add its actions here (if it has any) to make them available to
* e.g. the KDirOperator's popup-menu.
*/
virtual KActionCollection * actionCollection() const;
KFileViewSignaler * signaler() const { return sig; }
virtual void readConfig( KConfig *, const QString& group = QString::null );
virtual void writeConfig( KConfig *, const QString& group = QString::null);
/**
* This method calculates a QString from the given parameters, that is
* suitable for sorting with e.g. QIconView or QListView. Their
* Item-classes usually have a setKey( const QString& ) method or a virtual
* method QString key() that is used for sorting.
*
* @param value Any string that should be used as sort criterion
* @param isDir Tells whether the key is computed for an item representing
* a directory (directories are usually sorted before files)
* @param sortSpec An ORed combination of QDir::SortSpec flags.
* Currently, the values IgnoreCase, Reversed and
* DirsFirst are taken into account.
*/
static QString sortingKey( const QString& value, bool isDir, int sortSpec);
/**
* An overloaded method that takes not a QString, but a number as sort
* criterion. You can use this for file-sizes or dates/times for example.
* If you use a time_t, you need to cast that to KIO::filesize_t because
* of ambiguity problems.
*/
static QString sortingKey( KIO::filesize_t value, bool isDir,int sortSpec);
protected:
/**
* compares two items in the current context (sortMode and others)
* returns -1, if i1 is before i2 and 1, if the other case is true
* in case, both are equal (in current context), the behaviour is
* undefined!
**/
// int compareItems(const KFileItem *fi1, const KFileItem *fi2) const;
/**
* @internal
* class to distribute the signals
**/
KFileViewSignaler *sig;
/**
* Call this if you changed the sort order and want to perform the actual
* sorting and show the new items.
*/
/*
void resort() {
if ( count() > 1 ) {
const KFileItemList *selected = KFileView::selectedItems();
const KFileItem *current = KFileView::currentFileItem();
KFileItem *item = myFirstItem;
myFirstItem = 0L;
insertSorted( item, count() );
// restore the old selection
KFileItemListIterator it( *selected );
for ( ; it.current(); ++it ) {
setSelected( it.current(), true );
}
setCurrentItem( current );
}
}
*/
private:
static QDir::SortSpec defaultSortSpec;
QDir::SortSpec m_sorting;
QString m_viewName;
/**
* counters
**/
uint filesNumber;
uint dirsNumber;
ViewMode view_mode;
KFile::SelectionMode selection_mode;
// never use! It's only guaranteed to contain valid items in the items()
// method!
mutable KFileItemList m_itemList;
mutable KFileItemList *m_selectedList;
bool myOnlyDoubleClickSelectsFiles;
protected:
virtual void virtual_hook( int id, void* data );
private:
class KFileViewPrivate;
KFileViewPrivate *d;
};
#endif // KFILEINFOLISTWIDGET_H
| Generated by: dfaure on faure on Tue Apr 16 08:50:13 2002, using kdoc 2.0a53. |