KLayout Manual: Main Index » Class Index » API reference - Class QDirModel

API reference - Class QDirModel

Notation used in Ruby API documentation

Description: Binding of QDirModel

Class hierarchy: QDirModel » QAbstractItemModel » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

void beginInsertColumns(const QModelIndex parent,int first,int last)

Description: Method void QDirModel::beginInsertColumns(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

void beginInsertRows(const QModelIndex parent,int first,int last)

Description: Method void QDirModel::beginInsertRows(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

bool beginMoveColumns(const QModelIndex sourceParent,int sourceFirst,int sourceLast,const QModelIndex destinationParent,int destinationColumn)

Description: Method bool QDirModel::beginMoveColumns(const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)

This method is protected and can only be called from inside a derived class.

bool beginMoveRows(const QModelIndex sourceParent,int sourceFirst,int sourceLast,const QModelIndex destinationParent,int destinationRow)

Description: Method bool QDirModel::beginMoveRows(const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)

This method is protected and can only be called from inside a derived class.

void beginRemoveColumns(const QModelIndex parent,int first,int last)

Description: Method void QDirModel::beginRemoveColumns(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

void beginRemoveRows(const QModelIndex parent,int first,int last)

Description: Method void QDirModel::beginRemoveRows(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

void beginResetModel

Description: Method void QDirModel::beginResetModel()

This method is protected and can only be called from inside a derived class.

[virtual,const] QModelIndex buddy(const QModelIndex index)

Description: Virtual method QModelIndex QDirModel::buddy(const QModelIndex &index)

This method can be reimplemented in a derived class.

[virtual,const] bool canFetchMore(const QModelIndex parent)

Description: Virtual method bool QDirModel::canFetchMore(const QModelIndex &parent)

This method can be reimplemented in a derived class.

void changePersistentIndex(const QModelIndex from,const QModelIndex to)

Description: Method void QDirModel::changePersistentIndex(const QModelIndex &from, const QModelIndex &to)

This method is protected and can only be called from inside a derived class.

void changePersistentIndexList(QModelIndex[] from,QModelIndex[] to)

Description: Method void QDirModel::changePersistentIndexList(const QList<QModelIndex> &from, const QList<QModelIndex> &to)

This method is protected and can only be called from inside a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QDirModel::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

[virtual,const] int columnCount(const QModelIndex parent)

Description: Virtual method int QDirModel::columnCount(const QModelIndex &parent)

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] QModelIndex createIndex(int row,int column,void * data = 0)

Description: Method QModelIndex QDirModel::createIndex(int row, int column, void *data)

This method is protected and can only be called from inside a derived class.

[const] QModelIndex createIndex(int row,int column,int id)

Description: Method QModelIndex QDirModel::createIndex(int row, int column, int id)

This method is protected and can only be called from inside a derived class.

[const] QModelIndex createIndex(int row,int column,unsigned int id)

Description: Method QModelIndex QDirModel::createIndex(int row, int column, quint32 id)

This method is protected and can only be called from inside a derived class.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QDirModel::customEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual,const] QVariant data(const QModelIndex index,int role)

Description: Virtual method QVariant QDirModel::data(const QModelIndex &index, int role)

This method can be reimplemented in a derived class.

[event] void dataChanged(const QModelIndex topLeft,const QModelIndex bottomRight)

Description: Signal declaration for QDirModel::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight)

You can bind a procedure to this signal.

bool decodeData(int row,int column,const QModelIndex parent,QDataStream stream)

Description: Method bool QDirModel::decodeData(int row, int column, const QModelIndex &parent, QDataStream &stream)

This method is protected and can only be called from inside a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QDirModel::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QDirModel::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool dropMimeData(const QMimeData ptr data,const Qt_DropAction action,int row,int column,const QModelIndex parent)

Description: Virtual method bool QDirModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

This method can be reimplemented in a derived class.

[const] void encodeData(QModelIndex[] indexes,QDataStream stream)

Description: Method void QDirModel::encodeData(const QList<QModelIndex> &indexes, QDataStream &stream)

This method is protected and can only be called from inside a derived class.

void endInsertColumns

Description: Method void QDirModel::endInsertColumns()

This method is protected and can only be called from inside a derived class.

void endInsertRows

Description: Method void QDirModel::endInsertRows()

This method is protected and can only be called from inside a derived class.

void endMoveColumns

Description: Method void QDirModel::endMoveColumns()

This method is protected and can only be called from inside a derived class.

void endMoveRows

Description: Method void QDirModel::endMoveRows()

This method is protected and can only be called from inside a derived class.

void endRemoveColumns

Description: Method void QDirModel::endRemoveColumns()

This method is protected and can only be called from inside a derived class.

void endRemoveRows

Description: Method void QDirModel::endRemoveRows()

This method is protected and can only be called from inside a derived class.

void endResetModel

Description: Method void QDirModel::endResetModel()

This method is protected and can only be called from inside a derived class.

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QDirModel::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QDirModel::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[virtual] void fetchMore(const QModelIndex parent)

Description: Virtual method void QDirModel::fetchMore(const QModelIndex &parent)

This method can be reimplemented in a derived class.

[const] QIcon fileIcon(const QModelIndex index)

Description: Method QIcon QDirModel::fileIcon(const QModelIndex &index)

[const] QFileInfo fileInfo(const QModelIndex index)

Description: Method QFileInfo QDirModel::fileInfo(const QModelIndex &index)

[const] string fileName(const QModelIndex index)

Description: Method QString QDirModel::fileName(const QModelIndex &index)

[const] string filePath(const QModelIndex index)

Description: Method QString QDirModel::filePath(const QModelIndex &index)

[const] QDir_QFlags_Filter filter

Description: Method QFlags<QDir::Filter> QDirModel::filter()

Python specific notes:

The object exposes a readable attribute 'filter'. This is the getter.

void filter=(const QDir_QFlags_Filter filters)

Description: Method void QDirModel::setFilter(QFlags<QDir::Filter> filters)

Python specific notes:

The object exposes a writable attribute 'filter'. This is the setter.

[virtual,const] Qt_QFlags_ItemFlag flags(const QModelIndex index)

Description: Virtual method QFlags<Qt::ItemFlag> QDirModel::flags(const QModelIndex &index)

This method can be reimplemented in a derived class.

[virtual,const] bool hasChildren(const QModelIndex index)

Description: Virtual method bool QDirModel::hasChildren(const QModelIndex &index)

This method can be reimplemented in a derived class.

[virtual,const] QVariant headerData(int section,const Qt_Orientation orientation,int role)

Description: Virtual method QVariant QDirModel::headerData(int section, Qt::Orientation orientation, int role)

This method can be reimplemented in a derived class.

[event] void headerDataChanged(const Qt_Orientation orientation,int first,int last)

Description: Signal declaration for QDirModel::headerDataChanged(Qt::Orientation orientation, int first, int last)

You can bind a procedure to this signal.

[const] QFileIconProvider ptr iconProvider

Description: Method QFileIconProvider *QDirModel::iconProvider()

Python specific notes:

The object exposes a readable attribute 'iconProvider'. This is the getter.

void iconProvider=(QFileIconProvider ptr provider)

Description: Method void QDirModel::setIconProvider(QFileIconProvider *provider)

Python specific notes:

The object exposes a writable attribute 'iconProvider'. This is the setter.

[virtual,const] QModelIndex index(int row,int column,const QModelIndex parent)

Description: Virtual method QModelIndex QDirModel::index(int row, int column, const QModelIndex &parent)

This method can be reimplemented in a derived class.

[virtual] bool insertColumns(int column,int count,const QModelIndex parent)

Description: Virtual method bool QDirModel::insertColumns(int column, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

[virtual] bool insertRows(int row,int count,const QModelIndex parent)

Description: Virtual method bool QDirModel::insertRows(int row, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

[const] bool isDir?(const QModelIndex index)

Description: Method bool QDirModel::isDir(const QModelIndex &index)

[const] bool isReadOnly?

Description: Method bool QDirModel::isReadOnly()

Python specific notes:

The object exposes a readable attribute 'readOnly'. This is the getter.

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[event] void layoutAboutToBeChanged

Description: Signal declaration for QDirModel::layoutAboutToBeChanged()

You can bind a procedure to this signal.

[event] void layoutChanged

Description: Signal declaration for QDirModel::layoutChanged()

You can bind a procedure to this signal.

[const] bool lazyChildCount

Description: Method bool QDirModel::lazyChildCount()

Python specific notes:

The object exposes a readable attribute 'lazyChildCount'. This is the getter.

void lazyChildCount=(bool enable)

Description: Method void QDirModel::setLazyChildCount(bool enable)

Python specific notes:

The object exposes a writable attribute 'lazyChildCount'. This is the setter.

[virtual,const] QModelIndex[] match(const QModelIndex start,int role,const QVariant value,int hits,const Qt_QFlags_MatchFlag flags)

Description: Virtual method QList<QModelIndex> QDirModel::match(const QModelIndex &start, int role, const QVariant &value, int hits, QFlags<Qt::MatchFlag> flags)

This method can be reimplemented in a derived class.

[virtual,const] QMimeData ptr mimeData(QModelIndex[] indexes)

Description: Virtual method QMimeData *QDirModel::mimeData(const QList<QModelIndex> &indexes)

This method can be reimplemented in a derived class.

[virtual,const] string[] mimeTypes

Description: Virtual method QStringList QDirModel::mimeTypes()

This method can be reimplemented in a derived class.

QModelIndex mkdir(const QModelIndex parent,string name)

Description: Method QModelIndex QDirModel::mkdir(const QModelIndex &parent, const QString &name)

[const] string[] nameFilters

Description: Method QStringList QDirModel::nameFilters()

Python specific notes:

The object exposes a readable attribute 'nameFilters'. This is the getter.

void nameFilters=(string[] filters)

Description: Method void QDirModel::setNameFilters(const QStringList &filters)

Python specific notes:

The object exposes a writable attribute 'nameFilters'. This is the setter.

[static] new QDirModel new(string[] nameFilters,const QDir_QFlags_Filter filters,const QDir_QFlags_SortFlag sort,QObject ptr parent = 0)

Description: Constructor QDirModel::QDirModel(const QStringList &nameFilters, QFlags<QDir::Filter> filters, QFlags<QDir::SortFlag> sort, QObject *parent)

This method creates an object of class QDirModel.

Python specific notes:

This method is the default initializer of the object

[static] new QDirModel new(QObject ptr parent = 0)

Description: Constructor QDirModel::QDirModel(QObject *parent)

This method creates an object of class QDirModel.

Python specific notes:

This method is the default initializer of the object

[virtual,const] QModelIndex parent(const QModelIndex child)

Description: Virtual method QModelIndex QDirModel::parent(const QModelIndex &child)

This method can be reimplemented in a derived class.

[const] QModelIndex[] persistentIndexList

Description: Method QList<QModelIndex> QDirModel::persistentIndexList()

This method is protected and can only be called from inside a derived class.

[const] bool readOnly

Description: Method bool QDirModel::isReadOnly()

Python specific notes:

The object exposes a readable attribute 'readOnly'. This is the getter.

void readOnly=(bool enable)

Description: Method void QDirModel::setReadOnly(bool enable)

Python specific notes:

The object exposes a writable attribute 'readOnly'. This is the setter.

[const] int receivers(string signal)

Description: Method int QDirModel::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

void refresh(const QModelIndex parent = QModelIndex())

Description: Method void QDirModel::refresh(const QModelIndex &parent)

bool remove(const QModelIndex index)

Description: Method bool QDirModel::remove(const QModelIndex &index)

[virtual] bool removeColumns(int column,int count,const QModelIndex parent)

Description: Virtual method bool QDirModel::removeColumns(int column, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

[virtual] bool removeRows(int row,int count,const QModelIndex parent)

Description: Virtual method bool QDirModel::removeRows(int row, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

void reset

Description: Method void QDirModel::reset()

This method is protected and can only be called from inside a derived class.

[const] bool resolveSymlinks

Description: Method bool QDirModel::resolveSymlinks()

Python specific notes:

The object exposes a readable attribute 'resolveSymlinks'. This is the getter.

void resolveSymlinks=(bool enable)

Description: Method void QDirModel::setResolveSymlinks(bool enable)

Python specific notes:

The object exposes a writable attribute 'resolveSymlinks'. This is the setter.

[virtual] void revert

Description: Virtual method void QDirModel::revert()

This method can be reimplemented in a derived class.

bool rmdir(const QModelIndex index)

Description: Method bool QDirModel::rmdir(const QModelIndex &index)

[virtual,const] int rowCount(const QModelIndex parent)

Description: Virtual method int QDirModel::rowCount(const QModelIndex &parent)

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject *QDirModel::sender()

This method is protected and can only be called from inside a derived class.

[virtual] bool setData(const QModelIndex index,const QVariant value,int role)

Description: Virtual method bool QDirModel::setData(const QModelIndex &index, const QVariant &value, int role)

This method can be reimplemented in a derived class.

void setFilter(const QDir_QFlags_Filter filters)

Description: Method void QDirModel::setFilter(QFlags<QDir::Filter> filters)

Python specific notes:

The object exposes a writable attribute 'filter'. This is the setter.

[virtual] bool setHeaderData(int section,const Qt_Orientation orientation,const QVariant value,int role)

Description: Virtual method bool QDirModel::setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role)

This method can be reimplemented in a derived class.

void setIconProvider(QFileIconProvider ptr provider)

Description: Method void QDirModel::setIconProvider(QFileIconProvider *provider)

Python specific notes:

The object exposes a writable attribute 'iconProvider'. This is the setter.

void setLazyChildCount(bool enable)

Description: Method void QDirModel::setLazyChildCount(bool enable)

Python specific notes:

The object exposes a writable attribute 'lazyChildCount'. This is the setter.

void setNameFilters(string[] filters)

Description: Method void QDirModel::setNameFilters(const QStringList &filters)

Python specific notes:

The object exposes a writable attribute 'nameFilters'. This is the setter.

void setReadOnly(bool enable)

Description: Method void QDirModel::setReadOnly(bool enable)

Python specific notes:

The object exposes a writable attribute 'readOnly'. This is the setter.

void setResolveSymlinks(bool enable)

Description: Method void QDirModel::setResolveSymlinks(bool enable)

Python specific notes:

The object exposes a writable attribute 'resolveSymlinks'. This is the setter.

void setSorting(const QDir_QFlags_SortFlag sort)

Description: Method void QDirModel::setSorting(QFlags<QDir::SortFlag> sort)

Python specific notes:

The object exposes a writable attribute 'sorting'. This is the setter.

[virtual] void sort(int column,const Qt_SortOrder order)

Description: Virtual method void QDirModel::sort(int column, Qt::SortOrder order)

This method can be reimplemented in a derived class.

[const] QDir_QFlags_SortFlag sorting

Description: Method QFlags<QDir::SortFlag> QDirModel::sorting()

Python specific notes:

The object exposes a readable attribute 'sorting'. This is the getter.

void sorting=(const QDir_QFlags_SortFlag sort)

Description: Method void QDirModel::setSorting(QFlags<QDir::SortFlag> sort)

Python specific notes:

The object exposes a writable attribute 'sorting'. This is the setter.

[virtual,const] QSize span(const QModelIndex index)

Description: Virtual method QSize QDirModel::span(const QModelIndex &index)

This method can be reimplemented in a derived class.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] bool submit

Description: Virtual method bool QDirModel::submit()

This method can be reimplemented in a derived class.

[virtual,const] Qt_QFlags_DropAction supportedDropActions

Description: Virtual method QFlags<Qt::DropAction> QDirModel::supportedDropActions()

This method can be reimplemented in a derived class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QDirModel::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QDirModel::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QDirModel::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QDirModel::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QDirModel::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.