KCategoryDrawer

Search for usage in LXR

#include <KCategoryDrawer>

Inheritance diagram for KCategoryDrawer:

Signals

void actionRequested (int action, const QModelIndex &index)
 
void collapseOrExpandClicked (const QModelIndex &index)
 

Public Member Functions

 KCategoryDrawer (KCategorizedView *view)
 
virtual int categoryHeight (const QModelIndex &index, const QStyleOption &option) const
 
virtual void drawCategory (const QModelIndex &index, int sortRole, const QStyleOption &option, QPainter *painter) const
 
virtual int leftMargin () const
 
virtual int rightMargin () const
 
KCategorizedViewview () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

virtual void mouseButtonDoubleClicked (const QModelIndex &index, const QRect &blockRect, QMouseEvent *event)
 
virtual void mouseButtonPressed (const QModelIndex &index, const QRect &blockRect, QMouseEvent *event)
 
virtual void mouseButtonReleased (const QModelIndex &index, const QRect &blockRect, QMouseEvent *event)
 
virtual void mouseLeft (const QModelIndex &index, const QRect &blockRect)
 
virtual void mouseMoved (const QModelIndex &index, const QRect &blockRect, QMouseEvent *event)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

The category drawing is performed by this class.

It also gives information about the category height and margins.

Definition at line 32 of file kcategorydrawer.h.

Member Function Documentation

void KCategoryDrawer::actionRequested ( int  action,
const QModelIndex index 
)
signal

Emit this signal on your subclass implementation to notify that something happened.

Usually this will be triggered when you have received an event, and its position matched some "hot spot".

You give this action the integer you want, and having connected this signal to your code, the connected slot can perform the needed changes (view, model, selection model, delegate...)

int KCategoryDrawer::categoryHeight ( const QModelIndex index,
const QStyleOption option 
) const
virtual
Returns
The category height for the category represented by index index with style options option.

Definition at line 87 of file kcategorydrawer.cpp.

void KCategoryDrawer::collapseOrExpandClicked ( const QModelIndex index)
signal

This signal becomes emitted when collapse or expand has been clicked.

void KCategoryDrawer::drawCategory ( const QModelIndex index,
int  sortRole,
const QStyleOption option,
QPainter painter 
) const
virtual

This method purpose is to draw a category represented by the given.

Parameters
indexwith the given
sortRolesorting role
Note
This method will be called one time per category, always with the first element in that category

Definition at line 41 of file kcategorydrawer.cpp.

int KCategoryDrawer::leftMargin ( ) const
virtual
Note
0 by default
Since
4.4

Definition at line 100 of file kcategorydrawer.cpp.

void KCategoryDrawer::mouseButtonDoubleClicked ( const QModelIndex index,
const QRect blockRect,
QMouseEvent event 
)
protectedvirtual

Method called when the mouse button has been double clicked.

Parameters
indexThe representative index of the block of items.
blockRectThe rect occupied by the block of items.
eventThe mouse event.
Warning
You explicitly have to determine whether the event has been accepted or not. You have to call event->accept() or event->ignore() at all possible case branches in your code.

Definition at line 130 of file kcategorydrawer.cpp.

void KCategoryDrawer::mouseButtonPressed ( const QModelIndex index,
const QRect blockRect,
QMouseEvent event 
)
protectedvirtual

Method called when the mouse button has been pressed.

Parameters
indexThe representative index of the block of items.
blockRectThe rect occupied by the block of items.
eventThe mouse event.
Warning
You explicitly have to determine whether the event has been accepted or not. You have to call event->accept() or event->ignore() at all possible case branches in your code.

Definition at line 115 of file kcategorydrawer.cpp.

void KCategoryDrawer::mouseButtonReleased ( const QModelIndex index,
const QRect blockRect,
QMouseEvent event 
)
protectedvirtual

Method called when the mouse button has been released.

Parameters
indexThe representative index of the block of items.
blockRectThe rect occupied by the block of items.
eventThe mouse event.
Warning
You explicitly have to determine whether the event has been accepted or not. You have to call event->accept() or event->ignore() at all possible case branches in your code.

Definition at line 120 of file kcategorydrawer.cpp.

void KCategoryDrawer::mouseLeft ( const QModelIndex index,
const QRect blockRect 
)
protectedvirtual

Method called when the mouse button has left this block.

Parameters
indexThe representative index of the block of items.
blockRectThe rect occupied by the block of items.

Definition at line 135 of file kcategorydrawer.cpp.

void KCategoryDrawer::mouseMoved ( const QModelIndex index,
const QRect blockRect,
QMouseEvent event 
)
protectedvirtual

Method called when the mouse has been moved.

Parameters
indexThe representative index of the block of items.
blockRectThe rect occupied by the block of items.
eventThe mouse event.

Definition at line 125 of file kcategorydrawer.cpp.

int KCategoryDrawer::rightMargin ( ) const
virtual
Note
0 by default
Since
4.4

Definition at line 105 of file kcategorydrawer.cpp.

KCategorizedView * KCategoryDrawer::view ( ) const
Returns
The view this category drawer is associated with.

Definition at line 110 of file kcategorydrawer.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Sep 23 2021 22:40:14 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.