KParts::StatusBarExtension Class Reference

#include <KParts/StatusBarExtension>

Inheritance diagram for KParts::StatusBarExtension:

Public Member Functions
	StatusBarExtension (KParts::Part *parent)
	StatusBarExtension (KParts::ReadOnlyPart *parent)
void	addStatusBarItem (QWidget *widget, int stretch, bool permanent)
bool	eventFilter (QObject *watched, QEvent *ev) override
void	removeStatusBarItem (QWidget *widget)
void	setStatusBar (QStatusBar *status)
QStatusBar *	statusBar () 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)
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

Static Public Member Functions
static StatusBarExtension *	childObject (QObject *obj)
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)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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)

Detailed Description

An extension for KParts that allows more sophisticated statusbar handling.

Every part can use this class to customize the statusbar as long as it is active. Add items via addStatusBarItem and remove an item with removeStatusBarItem.

IMPORTANT: do NOT add any items immediately after constructing the extension. Give the application time to set the statusbar in the extension if necessary.

Definition at line 41 of file statusbarextension.h.

Constructor & Destructor Documentation

StatusBarExtension() [1/2]

StatusBarExtension::StatusBarExtension ( KParts::Part * parent )

explicit

Definition at line 95 of file statusbarextension.cpp.

StatusBarExtension() [2/2]

StatusBarExtension::StatusBarExtension ( KParts::ReadOnlyPart * parent )

explicit

Definition at line 102 of file statusbarextension.cpp.

~StatusBarExtension()

StatusBarExtension::~StatusBarExtension ( )

override

Definition at line 109 of file statusbarextension.cpp.

Member Function Documentation

addStatusBarItem()

void StatusBarExtension::addStatusBarItem	(	QWidget *	widget,
		int	stretch,
		bool	permanent )

This adds a widget to the statusbar for this part.

If you use this method instead of using statusBar() directly, this extension will take care of removing the items when the parts GUI is deactivated and will re-add them when it is reactivated. The parameters are the same as QStatusBar::addWidget().

Note that you can't use KStatusBar methods (inserting text items by id) but you can create a KStatusBarLabel with a dummy id instead, and use it directly in order to get the same look and feel.

Parameters

widget	the widget to add
stretch	the stretch factor. 0 for a minimum size.
permanent	passed to QStatusBar::addWidget as the "permanent" bool. Note that the item isn't really permanent though, it goes away when the part is unactivated. This simply controls whether temporary messages hide the widget, and whether it's added to the left or to the right side.

@Note that the widget does not technically become a child of the StatusBarExtension in a QObject sense. However, it will be deleted when the StatusBarExtension is deleted.

IMPORTANT: do NOT add any items immediately after constructing the extension. Give the application time to set the statusbar in the extension if necessary.

Definition at line 172 of file statusbarextension.cpp.

childObject()

StatusBarExtension * StatusBarExtension::childObject ( QObject * obj )

static

Queries obj for a child object which inherits from this StatusBarExtension class.

Convenience method.

Definition at line 122 of file statusbarextension.cpp.

eventFilter()

bool StatusBarExtension::eventFilter ( QObject * watched, QEvent * ev )

overridevirtual

Reimplemented from QObject.

Definition at line 127 of file statusbarextension.cpp.

removeStatusBarItem()

void StatusBarExtension::removeStatusBarItem

(

QWidget *

widget

)

Remove a widget from the statusbar for this part.

Definition at line 182 of file statusbarextension.cpp.

setStatusBar()

void StatusBarExtension::setStatusBar

(

QStatusBar *

status

)

This allows the hosting application to set a particular QStatusBar for this part.

If it doesn't do this, the statusbar used will be the one of the KMainWindow in which the part is embedded. Konqueror uses this to assign a view-statusbar to the part. The part should never call this method!

Definition at line 167 of file statusbarextension.cpp.

statusBar()

QStatusBar * StatusBarExtension::statusBar

(

)

const

Returns

the statusbar of the KMainWindow in which this part is currently embedded. WARNING: this could return 0L

Definition at line 154 of file statusbarextension.cpp.

---

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

• statusbarextension.h
• statusbarextension.cpp