KCategoryDrawer

#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

KCategorizedView *	view () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () 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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

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 context, Functor functor, 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)

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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

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.

Constructor & Destructor Documentation

◆ KCategoryDrawer()

KCategoryDrawer::KCategoryDrawer ( KCategorizedView * view )

Definition at line 35 of file kcategorydrawer.cpp.

Member Function Documentation

◆ actionRequested

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...)

◆ categoryHeight()

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 92 of file kcategorydrawer.cpp.

◆ collapseOrExpandClicked

void KCategoryDrawer::collapseOrExpandClicked ( const QModelIndex & index )

signal

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

◆ drawCategory()

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

index	with the given
sortRole	sorting role

Note: This method will be called one time per category, always with the first element in that category

Definition at line 43 of file kcategorydrawer.cpp.

◆ leftMargin()

int KCategoryDrawer::leftMargin ( ) const

virtual

Note: 0 by default

Since: 4.4

Definition at line 104 of file kcategorydrawer.cpp.

◆ mouseButtonDoubleClicked()

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

protectedvirtual

Method called when the mouse button has been double clicked.

Parameters

index	The representative index of the block of items.
blockRect	The rect occupied by the block of items.
event	The 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 134 of file kcategorydrawer.cpp.

◆ mouseButtonPressed()

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

protectedvirtual

Method called when the mouse button has been pressed.

Parameters

index	The representative index of the block of items.
blockRect	The rect occupied by the block of items.
event	The 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 119 of file kcategorydrawer.cpp.

◆ mouseButtonReleased()

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

protectedvirtual

Method called when the mouse button has been released.

Parameters

index	The representative index of the block of items.
blockRect	The rect occupied by the block of items.
event	The 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 124 of file kcategorydrawer.cpp.

◆ mouseLeft()

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

protectedvirtual

Method called when the mouse button has left this block.

Parameters

index	The representative index of the block of items.
blockRect	The rect occupied by the block of items.

Definition at line 139 of file kcategorydrawer.cpp.

◆ mouseMoved()

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

protectedvirtual

Method called when the mouse has been moved.

Parameters

index	The representative index of the block of items.
blockRect	The rect occupied by the block of items.
event	The mouse event.

Definition at line 129 of file kcategorydrawer.cpp.

◆ rightMargin()

int KCategoryDrawer::rightMargin ( ) const

virtual

Note: 0 by default

Since: 4.4

Definition at line 109 of file kcategorydrawer.cpp.

◆ view()

KCategorizedView * KCategoryDrawer::view ( ) const

Returns: The view this category drawer is associated with.

Definition at line 114 of file kcategorydrawer.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KItemViews

KCategoryDrawer

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KCategoryDrawer()

Member Function Documentation

◆ actionRequested

◆ categoryHeight()

◆ collapseOrExpandClicked

◆ drawCategory()

◆ leftMargin()

◆ mouseButtonDoubleClicked()

◆ mouseButtonPressed()

◆ mouseButtonReleased()

◆ mouseLeft()

◆ mouseMoved()

◆ rightMargin()

◆ view()