• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KFile

Public Types | Signals | Public Member Functions | List of all members
KFilePlacesModel Class Reference

#include <kfileplacesmodel.h>

Inheritance diagram for KFilePlacesModel:
Inheritance graph
[legend]

Public Types

enum  AdditionalRoles {
  UrlRole = 0x069CD12B, HiddenRole = 0x0741CAAC, SetupNeededRole = 0x059A935D, FixedDeviceRole = 0x332896C1,
  CapacityBarRecommendedRole = 0x1548C5C4
}
 

Signals

void errorMessage (const QString &message)
 
void setupDone (const QModelIndex &index, bool success)
 

Public Member Functions

 KFilePlacesModel (QObject *parent=0)
 
 ~KFilePlacesModel ()
 
void addPlace (const QString &text, const KUrl &url, const QString &iconName=QString(), const QString &appName=QString())
 
void addPlace (const QString &text, const KUrl &url, const QString &iconName, const QString &appName, const QModelIndex &after)
 
KBookmark bookmarkForIndex (const QModelIndex &index) const
 
QModelIndex closestItem (const KUrl &url) const
 
int columnCount (const QModelIndex &parent=QModelIndex()) const
 
QVariant data (const QModelIndex &index, int role) const
 
Solid::Device deviceForIndex (const QModelIndex &index) const
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
void editPlace (const QModelIndex &index, const QString &text, const KUrl &url, const QString &iconName=QString(), const QString &appName=QString())
 
QAction * ejectActionForIndex (const QModelIndex &index) const
 
Qt::ItemFlags flags (const QModelIndex &index) const
 
int hiddenCount () const
 
KIcon icon (const QModelIndex &index) const
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const
 
bool isDevice (const QModelIndex &index) const
 
bool isHidden (const QModelIndex &index) const
 
QMimeData * mimeData (const QModelIndexList &indexes) const
 
QStringList mimeTypes () const
 
QModelIndex parent (const QModelIndex &child) const
 
void removePlace (const QModelIndex &index) const
 
void requestEject (const QModelIndex &index)
 
void requestSetup (const QModelIndex &index)
 
void requestTeardown (const QModelIndex &index)
 
int rowCount (const QModelIndex &parent=QModelIndex()) const
 
void setPlaceHidden (const QModelIndex &index, bool hidden)
 
bool setupNeeded (const QModelIndex &index) const
 
Qt::DropActions supportedDropActions () const
 
QAction * teardownActionForIndex (const QModelIndex &index) const
 
QString text (const QModelIndex &index) const
 
KUrl url (const QModelIndex &index) const
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual  ~QAbstractItemModel ()
 
virtual QModelIndex buddy (const QModelIndex &index) const
 
virtual bool canFetchMore (const QModelIndex &parent) const
 
virtual int columnCount (const QModelIndex &parent) const =0
 
void columnsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void columnsInserted (const QModelIndex &parent, int start, int end)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsRemoved (const QModelIndex &parent, int start, int end)
 
virtual QVariant data (const QModelIndex &index, int role) const =0
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)
 
virtual void fetchMore (const QModelIndex &parent)
 
virtual bool hasChildren (const QModelIndex &parent) const
 
bool hasIndex (int row, int column, const QModelIndex &parent) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const =0
 
bool insertColumn (int column, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent)
 
bool insertRow (int row, const QModelIndex &parent)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent)
 
virtual QMap< int, QVariant > itemData (const QModelIndex &index) const
 
void layoutAboutToBeChanged ()
 
void layoutChanged ()
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, QFlags< Qt::MatchFlag > flags) const
 
void modelAboutToBeReset ()
 
void modelReset ()
 
virtual QModelIndex parent (const QModelIndex &index) const =0
 
bool removeColumn (int column, const QModelIndex &parent)
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
virtual bool removeRows (int row, int count, const QModelIndex &parent)
 
virtual void revert ()
 
const QHash< int, QByteArray > & roleNames () const
 
virtual int rowCount (const QModelIndex &parent) const =0
 
void rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void rowsInserted (const QModelIndex &parent, int start, int end)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsRemoved (const QModelIndex &parent, int start, int end)
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role)
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 
void setSupportedDragActions (QFlags< Qt::DropAction > actions)
 
QModelIndex sibling (int row, int column, const QModelIndex &index) const
 
virtual void sort (int column, Qt::SortOrder order)
 
virtual QSize span (const QModelIndex &index) const
 
virtual bool submit ()
 
Qt::DropActions supportedDragActions () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QAbstractItemModel
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void beginResetModel ()
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndex createIndex (int row, int column, void *ptr) const
 
QModelIndex createIndex (int row, int column, int id) const
 
QModelIndex createIndex (int row, int column, quint32 id) const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const
 
void reset ()
 
void resetInternalData ()
 
void setRoleNames (const QHash< int, QByteArray > &roleNames)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This class is a list view model.

Each entry represents a "place" where user can access files. Only revelant when used with QListView or QTableView.

Definition at line 40 of file kfileplacesmodel.h.

Member Enumeration Documentation

enum KFilePlacesModel::AdditionalRoles
Enumerator
UrlRole 
HiddenRole 
SetupNeededRole 
FixedDeviceRole 
CapacityBarRecommendedRole 

Definition at line 44 of file kfileplacesmodel.h.

Constructor & Destructor Documentation

KFilePlacesModel::KFilePlacesModel ( QObject *  parent = 0)

Definition at line 90 of file kfileplacesmodel.cpp.

KFilePlacesModel::~KFilePlacesModel ( )

Definition at line 172 of file kfileplacesmodel.cpp.

Member Function Documentation

void KFilePlacesModel::addPlace ( const QString &  text,
const KUrl &  url,
const QString &  iconName = QString(),
const QString &  appName = QString() 
)

Definition at line 634 of file kfileplacesmodel.cpp.

void KFilePlacesModel::addPlace ( const QString &  text,
const KUrl &  url,
const QString &  iconName,
const QString &  appName,
const QModelIndex &  after 
)

Definition at line 640 of file kfileplacesmodel.cpp.

KBookmark KFilePlacesModel::bookmarkForIndex ( const QModelIndex &  index) const

Definition at line 226 of file kfileplacesmodel.cpp.

QModelIndex KFilePlacesModel::closestItem ( const KUrl &  url) const

Returns the closest item for the URL url.

The closest item is defined as item which is equal to the URL or at least is a parent URL. If there are more than one possible parent URL candidates, the item which covers the bigger range of the URL is returned.

Example: the url is '/home/peter/Documents/Music'. Available items are:

  • /home/peter
  • /home/peter/Documents

The returned item will the one for '/home/peter/Documents'.

Definition at line 281 of file kfileplacesmodel.cpp.

int KFilePlacesModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const

Get the number of columns for a model index.

Definition at line 274 of file kfileplacesmodel.cpp.

QVariant KFilePlacesModel::data ( const QModelIndex &  index,
int  role 
) const

Get a visible data based on Qt role for the given index.

Return the device information for the give index.

Parameters
indexThe QModelIndex which contains the row, column to fetch the data.
roleThe Interview data role(ex: Qt::DisplayRole).
Returns
the data for the given index and role.

Definition at line 240 of file kfileplacesmodel.cpp.

Solid::Device KFilePlacesModel::deviceForIndex ( const QModelIndex &  index) const

Definition at line 212 of file kfileplacesmodel.cpp.

bool KFilePlacesModel::dropMimeData ( const QMimeData *  data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex &  parent 
)
virtual

Reimplemented from QAbstractItemModel.

Definition at line 534 of file kfileplacesmodel.cpp.

void KFilePlacesModel::editPlace ( const QModelIndex &  index,
const QString &  text,
const KUrl &  url,
const QString &  iconName = QString(),
const QString &  appName = QString() 
)

Definition at line 659 of file kfileplacesmodel.cpp.

QAction * KFilePlacesModel::ejectActionForIndex ( const QModelIndex &  index) const

Definition at line 771 of file kfileplacesmodel.cpp.

void KFilePlacesModel::errorMessage ( const QString &  message)
signal
Qt::ItemFlags KFilePlacesModel::flags ( const QModelIndex &  index) const
virtual

Reimplemented from QAbstractItemModel.

Definition at line 483 of file kfileplacesmodel.cpp.

int KFilePlacesModel::hiddenCount ( ) const

Definition at line 713 of file kfileplacesmodel.cpp.

KIcon KFilePlacesModel::icon ( const QModelIndex &  index) const

Definition at line 187 of file kfileplacesmodel.cpp.

QModelIndex KFilePlacesModel::index ( int  row,
int  column,
const QModelIndex &  parent = QModelIndex() 
) const

Get the children model index for the given row and column.

Definition at line 249 of file kfileplacesmodel.cpp.

bool KFilePlacesModel::isDevice ( const QModelIndex &  index) const

Definition at line 202 of file kfileplacesmodel.cpp.

bool KFilePlacesModel::isHidden ( const QModelIndex &  index) const

Definition at line 197 of file kfileplacesmodel.cpp.

QMimeData * KFilePlacesModel::mimeData ( const QModelIndexList &  indexes) const
virtual

Reimplemented from QAbstractItemModel.

Definition at line 510 of file kfileplacesmodel.cpp.

QStringList KFilePlacesModel::mimeTypes ( ) const
virtual

Reimplemented from QAbstractItemModel.

Definition at line 501 of file kfileplacesmodel.cpp.

QModelIndex KFilePlacesModel::parent ( const QModelIndex &  child) const

Get the parent QModelIndex for the given model child.

Definition at line 260 of file kfileplacesmodel.cpp.

void KFilePlacesModel::removePlace ( const QModelIndex &  index) const

Definition at line 681 of file kfileplacesmodel.cpp.

void KFilePlacesModel::requestEject ( const QModelIndex &  index)

Definition at line 799 of file kfileplacesmodel.cpp.

void KFilePlacesModel::requestSetup ( const QModelIndex &  index)

Definition at line 817 of file kfileplacesmodel.cpp.

void KFilePlacesModel::requestTeardown ( const QModelIndex &  index)

Definition at line 786 of file kfileplacesmodel.cpp.

int KFilePlacesModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const

Get the number of rows for a model index.

Definition at line 266 of file kfileplacesmodel.cpp.

void KFilePlacesModel::setPlaceHidden ( const QModelIndex &  index,
bool  hidden 
)

Definition at line 697 of file kfileplacesmodel.cpp.

void KFilePlacesModel::setupDone ( const QModelIndex &  index,
bool  success 
)
signal
bool KFilePlacesModel::setupNeeded ( const QModelIndex &  index) const

Definition at line 182 of file kfileplacesmodel.cpp.

Qt::DropActions KFilePlacesModel::supportedDropActions ( ) const
virtual

Reimplemented from QAbstractItemModel.

Definition at line 478 of file kfileplacesmodel.cpp.

QAction * KFilePlacesModel::teardownActionForIndex ( const QModelIndex &  index) const

Definition at line 727 of file kfileplacesmodel.cpp.

QString KFilePlacesModel::text ( const QModelIndex &  index) const

Definition at line 192 of file kfileplacesmodel.cpp.

KUrl KFilePlacesModel::url ( const QModelIndex &  index) const

Definition at line 177 of file kfileplacesmodel.cpp.

The documentation for this class was generated from the following files:
  • kfileplacesmodel.h
  • kfileplacesmodel.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:27:27 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KFile

Skip menu "KFile"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal