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

Kate

ExpandingWidgetModel Class Reference

#include <expandingwidgetmodel.h>

Inheritance diagram for ExpandingWidgetModel:

Inheritance graph
[legend]

List of all members.


Detailed Description

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

Definition at line 34 of file expandingwidgetmodel.h.


Public Types

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

Public Slots

void placeExpandingWidgets ()

Public Member Functions

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
 ExpandingWidgetModel (QWidget *parent)
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
virtual ~ExpandingWidgetModel ()

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)

Static Protected Attributes

static QIcon m_collapsedIcon
static QIcon m_expandedIcon

Member Enumeration Documentation

enum ExpandingWidgetModel::ExpandingType

Enumerator:
NotExpandable 
Expandable 
Expanded 

Definition at line 41 of file expandingwidgetmodel.h.

enum ExpandingWidgetModel::ExpansionType

Enumerator:
NotExpanded 
ExpandDownwards 
ExpandUpwards 

Definition at line 63 of file expandingwidgetmodel.h.


Constructor & Destructor Documentation

ExpandingWidgetModel::ExpandingWidgetModel ( QWidget *  parent  ) 

Definition at line 40 of file expandingwidgetmodel.cpp.

ExpandingWidgetModel::~ExpandingWidgetModel (  )  [virtual]

Definition at line 45 of file expandingwidgetmodel.cpp.


Member Function Documentation

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

Definition at line 338 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::cacheIcons (  )  const [protected]

Definition at line 422 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 107 of file expandingwidgetmodel.cpp.

void ExpandingWidgetModel::clearMatchQualities (  ) 

Definition at line 96 of file expandingwidgetmodel.cpp.

virtual int ExpandingWidgetModel::contextMatchQuality ( const QModelIndex &  index  )  const [protected, pure virtual]

Returns:
the context-match quality from 0 to 10 if it could be determined, else -1

Implemented in KateArgumentHintModel, and KateCompletionModel.

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.

Todo:
Choose a color from the color scheme

Reimplemented in KateArgumentHintModel, and KateCompletionModel.

Definition at line 72 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 412 of file expandingwidgetmodel.cpp.

int ExpandingWidgetModel::expandingWidgetsHeight (  )  const

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

Definition at line 401 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 KateArgumentHintModel, and KateCompletionModel.

bool ExpandingWidgetModel::isExpandable ( const QModelIndex &  index  )  const

Returns:
whether the row given through index is expandable

Definition at line 272 of file expandingwidgetmodel.cpp.

bool ExpandingWidgetModel::isExpanded ( const QModelIndex &  row  )  const

Returns:
whether row is currently expanded

Definition at line 287 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 121 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 49 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 233 of file expandingwidgetmodel.cpp.

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

Definition at line 226 of file expandingwidgetmodel.cpp.

QModelIndex ExpandingWidgetModel::partiallyExpandedRow (  )  const

Returns the first row that is currently partially expanded.

Definition at line 100 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 135 of file expandingwidgetmodel.cpp.

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

Definition at line 128 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 351 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 395 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:
row The row

Todo:
allow multiple partially expanded rows

Reimplemented in KateCompletionModel.

Definition at line 139 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 293 of file expandingwidgetmodel.cpp.

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

Implemented in KateArgumentHintModel.


Member Data Documentation

QIcon ExpandingWidgetModel::m_collapsedIcon [static, protected]

Definition at line 134 of file expandingwidgetmodel.h.

QIcon ExpandingWidgetModel::m_expandedIcon [static, protected]

Definition at line 133 of file expandingwidgetmodel.h.


The documentation for this class was generated from the following files:
  • expandingwidgetmodel.h
  • expandingwidgetmodel.cpp

Kate

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal