KFile
#include <kfileplacesmodel.h>

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, const QString &appName, const QModelIndex &after) |
void | addPlace (const QString &text, const KUrl &url, const QString &iconName=QString(), const QString &appName=QString()) |
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 |
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
◆ AdditionalRoles
Enumerator | |
---|---|
UrlRole | |
HiddenRole | |
SetupNeededRole | |
FixedDeviceRole | |
CapacityBarRecommendedRole |
Definition at line 44 of file kfileplacesmodel.h.
Constructor & Destructor Documentation
◆ KFilePlacesModel()
KFilePlacesModel::KFilePlacesModel | ( | QObject * | parent = 0 | ) |
Definition at line 90 of file kfileplacesmodel.cpp.
◆ ~KFilePlacesModel()
KFilePlacesModel::~KFilePlacesModel | ( | ) |
Definition at line 172 of file kfileplacesmodel.cpp.
Member Function Documentation
◆ addPlace() [1/2]
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.
◆ addPlace() [2/2]
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.
◆ bookmarkForIndex()
KBookmark KFilePlacesModel::bookmarkForIndex | ( | const QModelIndex & | index | ) | const |
Definition at line 226 of file kfileplacesmodel.cpp.
◆ closestItem()
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.
◆ columnCount()
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.
◆ data()
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
-
index The QModelIndex which contains the row, column to fetch the data. role The Interview data role(ex: Qt::DisplayRole).
- Returns
- the data for the given index and role.
Definition at line 240 of file kfileplacesmodel.cpp.
◆ deviceForIndex()
Solid::Device KFilePlacesModel::deviceForIndex | ( | const QModelIndex & | index | ) | const |
Definition at line 212 of file kfileplacesmodel.cpp.
◆ dropMimeData()
bool KFilePlacesModel::dropMimeData | ( | const QMimeData * | data, |
Qt::DropAction | action, | ||
int | row, | ||
int | column, | ||
const QModelIndex & | parent | ||
) |
Definition at line 534 of file kfileplacesmodel.cpp.
◆ editPlace()
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.
◆ ejectActionForIndex()
QAction * KFilePlacesModel::ejectActionForIndex | ( | const QModelIndex & | index | ) | const |
Definition at line 771 of file kfileplacesmodel.cpp.
◆ errorMessage
|
signal |
◆ flags()
Qt::ItemFlags KFilePlacesModel::flags | ( | const QModelIndex & | index | ) | const |
Definition at line 483 of file kfileplacesmodel.cpp.
◆ hiddenCount()
int KFilePlacesModel::hiddenCount | ( | ) | const |
Definition at line 713 of file kfileplacesmodel.cpp.
◆ icon()
KIcon KFilePlacesModel::icon | ( | const QModelIndex & | index | ) | const |
Definition at line 187 of file kfileplacesmodel.cpp.
◆ index()
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.
◆ isDevice()
bool KFilePlacesModel::isDevice | ( | const QModelIndex & | index | ) | const |
Definition at line 202 of file kfileplacesmodel.cpp.
◆ isHidden()
bool KFilePlacesModel::isHidden | ( | const QModelIndex & | index | ) | const |
Definition at line 197 of file kfileplacesmodel.cpp.
◆ mimeData()
QMimeData * KFilePlacesModel::mimeData | ( | const QModelIndexList & | indexes | ) | const |
Definition at line 510 of file kfileplacesmodel.cpp.
◆ mimeTypes()
QStringList KFilePlacesModel::mimeTypes | ( | ) | const |
Definition at line 501 of file kfileplacesmodel.cpp.
◆ parent()
QModelIndex KFilePlacesModel::parent | ( | const QModelIndex & | child | ) | const |
Get the parent QModelIndex for the given model child.
Definition at line 260 of file kfileplacesmodel.cpp.
◆ removePlace()
void KFilePlacesModel::removePlace | ( | const QModelIndex & | index | ) | const |
Definition at line 681 of file kfileplacesmodel.cpp.
◆ requestEject()
void KFilePlacesModel::requestEject | ( | const QModelIndex & | index | ) |
Definition at line 799 of file kfileplacesmodel.cpp.
◆ requestSetup()
void KFilePlacesModel::requestSetup | ( | const QModelIndex & | index | ) |
Definition at line 817 of file kfileplacesmodel.cpp.
◆ requestTeardown()
void KFilePlacesModel::requestTeardown | ( | const QModelIndex & | index | ) |
Definition at line 786 of file kfileplacesmodel.cpp.
◆ rowCount()
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.
◆ setPlaceHidden()
void KFilePlacesModel::setPlaceHidden | ( | const QModelIndex & | index, |
bool | hidden | ||
) |
Definition at line 697 of file kfileplacesmodel.cpp.
◆ setupDone
|
signal |
◆ setupNeeded()
bool KFilePlacesModel::setupNeeded | ( | const QModelIndex & | index | ) | const |
Definition at line 182 of file kfileplacesmodel.cpp.
◆ supportedDropActions()
Qt::DropActions KFilePlacesModel::supportedDropActions | ( | ) | const |
Definition at line 478 of file kfileplacesmodel.cpp.
◆ teardownActionForIndex()
QAction * KFilePlacesModel::teardownActionForIndex | ( | const QModelIndex & | index | ) | const |
Definition at line 727 of file kfileplacesmodel.cpp.
◆ text()
QString KFilePlacesModel::text | ( | const QModelIndex & | index | ) | const |
Definition at line 192 of file kfileplacesmodel.cpp.
◆ url()
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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.