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

Kate

Public Types | Public Slots | Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
ExpandingWidgetModel Class Referenceabstract

#include <expandingwidgetmodel.h>

Inheritance diagram for ExpandingWidgetModel:
Inheritance graph
[legend]

Public Types

enum  ExpandingType { NotExpandable =0, Expandable, Expanded }
 
enum  ExpansionType { NotExpanded = 0, ExpandDownwards, ExpandUpwards }
 

Public Slots

void placeExpandingWidgets ()
 

Public Member Functions

 ExpandingWidgetModel (QWidget *parent)
 
virtual ~ExpandingWidgetModel ()
 
bool canCollapseCurrentItem () const
 
bool canExpandCurrentItem () const
 
void clearExpanding ()
 
void clearMatchQualities ()
 
virtual QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
 
QWidget * expandingWidget (const QModelIndex &row) const
 
int expandingWidgetsHeight () const
 
virtual bool indexIsItem (const QModelIndex &index) const =0
 
bool isExpandable (const QModelIndex &index) const
 
bool isExpanded (const QModelIndex &row) const
 
ExpansionType isPartiallyExpanded (const QModelIndex &index) const
 
uint matchColor (const QModelIndex &index) const
 
QRect partialExpandRect (const QModelIndex &row) const
 
QString partialExpandText (const QModelIndex &row) const
 
QModelIndex partiallyExpandedRow () const
 
int partiallyExpandWidgetHeight () const
 
void placeExpandingWidget (const QModelIndex &row)
 
virtual void rowSelected (const QModelIndex &row)
 
void setCurrentItemExpanded (bool)
 
void setExpanded (QModelIndex index, bool expanded)
 
virtual QTreeView * treeView () const =0
 
- Public Member Functions inherited from QAbstractTableModel
 QAbstractTableModel (QObject *parent)
 
 ~QAbstractTableModel ()
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) 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 Qt::ItemFlags flags (const QModelIndex &index) const
 
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
 
virtual QMimeData * mimeData (const QModelIndexList &indexes) const
 
virtual QStringList mimeTypes () 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
 
virtual Qt::DropActions supportedDropActions () 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
 

Protected Member Functions

int basicRowHeight (const QModelIndex &index) const
 
void cacheIcons () const
 
virtual int contextMatchQuality (const QModelIndex &index) const =0
 
void partiallyUnExpand (const QModelIndex &index)
 
- 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 Attributes

static QIcon m_collapsedIcon
 
static QIcon m_expandedIcon
 

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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Cares about expanding/un-expanding items in a tree-view together with ExpandingDelegate.

Definition at line 36 of file expandingwidgetmodel.h.

Member Enumeration Documentation

enum ExpandingWidgetModel::ExpandingType
Enumerator
NotExpandable 
Expandable 
Expanded 

Definition at line 43 of file expandingwidgetmodel.h.

enum ExpandingWidgetModel::ExpansionType
Enumerator
NotExpanded 
ExpandDownwards 
ExpandUpwards 

Definition at line 65 of file expandingwidgetmodel.h.

Constructor & Destructor Documentation

ExpandingWidgetModel::ExpandingWidgetModel ( QWidget *  parent)

Definition at line 44 of file expandingwidgetmodel.cpp.

ExpandingWidgetModel::~ExpandingWidgetModel ( )
virtual

Definition at line 49 of file expandingwidgetmodel.cpp.

Member Function Documentation

int ExpandingWidgetModel::basicRowHeight ( const QModelIndex &  index) const
protected

Definition at line 357 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::cacheIcons ( ) const
protected

Definition at line 441 of file expandingwidgetmodel.cpp.

bool ExpandingWidgetModel::canCollapseCurrentItem ( ) const
Returns
whether the current item can be collapsed
bool ExpandingWidgetModel::canExpandCurrentItem ( ) const

The following three are convenience-functions for the current item that could be replaced by the later ones.

Returns
whether the current item can be expanded
void ExpandingWidgetModel::clearExpanding ( )

Unexpand all rows and clear all cached information about them(this includes deleting the expanding-widgets)

Definition at line 123 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::clearMatchQualities ( )

Definition at line 112 of file expandingwidgetmodel.cpp.

virtual int ExpandingWidgetModel::contextMatchQuality ( const QModelIndex &  index) const
protectedpure virtual
Returns
the context-match quality from 0 to 10 if it could be determined, else -1

Implemented in KateCompletionModel, and KateArgumentHintModel.

QVariant ExpandingWidgetModel::data ( const QModelIndex &  index,
int  role = Qt::DisplayRole 
) const
virtual

Does not request data from index, this only returns local data like highlighting for expanded rows and similar.

Reimplemented in KateCompletionModel, and KateArgumentHintModel.

Definition at line 88 of file expandingwidgetmodel.cpp.

QWidget * ExpandingWidgetModel::expandingWidget ( const QModelIndex &  row) const
Returns
the expanding-widget for the given row, if available. Expanding-widgets are in best case available for all expanded rows. This does not return the partially-expand widget.

Definition at line 431 of file expandingwidgetmodel.cpp.

int ExpandingWidgetModel::expandingWidgetsHeight ( ) const

Returns the total height added through all open expanding-widgets.

Definition at line 420 of file expandingwidgetmodel.cpp.

virtual bool ExpandingWidgetModel::indexIsItem ( const QModelIndex &  index) const
pure virtual

Should return true if the given row should be painted like a contained item(as opposed to label-rows etc.)

Implemented in KateCompletionModel, and KateArgumentHintModel.

bool ExpandingWidgetModel::isExpandable ( const QModelIndex &  index) const
Returns
whether the row given through index is expandable

Definition at line 290 of file expandingwidgetmodel.cpp.

bool ExpandingWidgetModel::isExpanded ( const QModelIndex &  row) const
Returns
whether row is currently expanded

Definition at line 305 of file expandingwidgetmodel.cpp.

ExpandingWidgetModel::ExpansionType ExpandingWidgetModel::isPartiallyExpanded ( const QModelIndex &  index) const

Returns whether the given index is currently partially expanded. Does not do any other checks like calling models for data.

Definition at line 139 of file expandingwidgetmodel.cpp.

uint ExpandingWidgetModel::matchColor ( const QModelIndex &  index) const

Returns the match-color for the given index, or zero if match-quality could not be computed.

Definition at line 58 of file expandingwidgetmodel.cpp.

QRect ExpandingWidgetModel::partialExpandRect ( const QModelIndex &  row) const

Returns the rectangle for the partially expanded part of the given row.

Definition at line 251 of file expandingwidgetmodel.cpp.

QString ExpandingWidgetModel::partialExpandText ( const QModelIndex &  row) const

Definition at line 244 of file expandingwidgetmodel.cpp.

QModelIndex ExpandingWidgetModel::partiallyExpandedRow ( ) const

Returns the first row that is currently partially expanded.

Definition at line 116 of file expandingwidgetmodel.cpp.

int ExpandingWidgetModel::partiallyExpandWidgetHeight ( ) const

Amount by which the height of a row increases when it is partially expanded.

Todo:
use font-metrics text-height*2 for 2 lines

Definition at line 153 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::partiallyUnExpand ( const QModelIndex &  index)
protected

Definition at line 146 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::placeExpandingWidget ( const QModelIndex &  row)

Places and shows the expanding-widget for the given row, if it should be visible and is valid.

Also shows the partial-expanding-widget when it should be visible.

Definition at line 370 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::placeExpandingWidgets ( )
slot

Place or hides all expanding-widgets to the correct positions. Should be called after the view was scrolled.

Definition at line 414 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::rowSelected ( const QModelIndex &  row)
virtual

Notifies underlying models that the item was selected, collapses any previous partially expanded line, checks whether this line should be partially expanded, and eventually does it.

Does nothing when nothing needs to be done. Does NOT show the expanding-widget. That is done immediately when painting by ExpandingDelegate, to reduce flickering.

See also
showPartialExpandWidget()
Parameters
rowThe row
Todo:
allow multiple partially expanded rows

Reimplemented in KateCompletionModel.

Definition at line 157 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::setCurrentItemExpanded ( bool  )

Expand/collapse the current item.

void ExpandingWidgetModel::setExpanded ( QModelIndex  index,
bool  expanded 
)

Change the expand-state of the row given through index. The display will be updated.

Definition at line 311 of file expandingwidgetmodel.cpp.

virtual QTreeView* ExpandingWidgetModel::treeView ( ) const
pure virtual

Implemented in KateArgumentHintModel.

Member Data Documentation

QIcon ExpandingWidgetModel::m_collapsedIcon
staticprotected

Definition at line 136 of file expandingwidgetmodel.h.

QIcon ExpandingWidgetModel::m_expandedIcon
staticprotected

Definition at line 135 of file expandingwidgetmodel.h.


The documentation for this class was generated from the following files:
  • expandingwidgetmodel.h
  • expandingwidgetmodel.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:57:00 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Kate

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

applications API Reference

Skip menu "applications API Reference"
  •   kate
  •       kate
  •   KTextEditor
  •   Kate
  • Konsole

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