Status Bar class. More...

#include <KviStatusBar.h>

Inheritance diagram for KviStatusBar:

Public Member Functions
KviStatusBarApplet *	appletAt (const QPoint &pnt, bool bBestMatch=false)
	Returns the applet at the given point. More...

bool	appletExists (KviStatusBarApplet *pApplet)
	Returns true if the applet exists, false otherwise. More...

KviMainWindow *	frame ()
	Returns the frame pointer. More...

int	insertPermanentWidgetAtTheEnd (QWidget *widget, int stretch=0)
	Inserts an applet at the end of the statusbar as a permanent widget and returns its index. More...

	KviStatusBar (KviMainWindow *pFrame)
	Constructs the statusbar object. More...

void	queueMessage (KviStatusBarMessage *pMsg)
	Queue a statusbar message in the stack. More...

void	registerAppletDescriptor (KviStatusBarAppletDescriptor *d)
	Registers the applet descriptor. More...

	~KviStatusBar ()
	Destroys the statusbar object. More...

Protected Slots
void	appletsPopupAboutToShow ()
	Shows the per-applet popup menu. More...

void	appletsPopupActivated (QAction *pAction)
	Called when the user activates the per-applet popup. More...

void	contextMenuRequested (const QPoint &pos)
	Called when the user requests a context menu. More...

void	contextPopupAboutToShow ()
	Shows the applet common popup menu. More...

void	messageTimerFired ()
	Called when the timer timeouts. More...

void	removeClickedApplet ()
	Called when the user removes an applet from the statusbar. More...

void	setPermanentMessage ()
	Sets the permanent message to be shown. More...

Protected Member Functions
KviStatusBarApplet *	createApplet (const QString &szInternalName)
	Create an applet. More...

void	dragEnterEvent (QDragEnterEvent *event)

void	dragMoveEvent (QDragMoveEvent *de)

void	dropEvent (QDropEvent *de)

virtual bool	event (QEvent *e)

void	load ()
	Saves the statusbar stack. More...

virtual void	mouseDoubleClickEvent (QMouseEvent *e)

virtual void	mousePressEvent (QMouseEvent *e)

void	recalcMinimumHeight ()
	Recalculates the minimum height of the status bar. More...

void	registerApplet (KviStatusBarApplet *pApplet)
	Registers the given applet in the statusbar. More...

void	save ()
	Saves the statusbar stack. More...

void	showFirstMessageInQueue ()
	Shows the first message in the queue stack. More...

void	showLayoutHelp ()
	Shows the common help for every applet. More...

void	tipRequest (QHelpEvent *e)
	Shows the right tooltip. More...

void	unregisterApplet (KviStatusBarApplet *pApplet)
	Unegisters the given applet in the statusbar. More...

Protected Attributes
bool	m_bStopLayoutOnAddRemove

int	m_iLastMinimumHeight

KviPointerHashTable< QString, KviStatusBarAppletDescriptor > *	m_pAppletDescriptors

KviPointerList < KviStatusBarApplet > *	m_pAppletList

QMenu *	m_pAppletsPopup

KviTalHBox *	m_pBox

KviStatusBarApplet *	m_pClickedApplet

QMenu *	m_pContextPopup

KviMainWindow *	m_pFrame

QLabel *	m_pMessageLabel

KviPointerList < KviStatusBarMessage > *	m_pMessageQueue

QTimer *	m_pMessageTimer

KviDynamicToolTip *	m_pToolTip

Friends
class	KviMainWindow

class	KviStatusBarApplet

Detailed Description

Status Bar class.

Constructor & Destructor Documentation

KviStatusBar::KviStatusBar ( KviMainWindow * pFrame )

Constructs the statusbar object.

Parameters

pFrame The parent frame class

Returns: KviStatusBar

References connect(), contextMenuRequested(), m_bStopLayoutOnAddRemove, m_iLastMinimumHeight, m_pAppletDescriptors, m_pAppletList, m_pAppletsPopup, m_pClickedApplet, m_pContextPopup, m_pFrame, m_pMessageLabel, m_pMessageQueue, m_pMessageTimer, KviStatusBarClock::selfRegister(), KviStatusBarConnectionTimer::selfRegister(), KviStatusBarSeparator::selfRegister(), KviStatusBarAwayIndicator::selfRegister(), KviStatusBarLagIndicator::selfRegister(), KviStatusBarUpdateIndicator::selfRegister(), KviPointerHashTable< Key, T >::setAutoDelete(), KviPointerList< T >::setAutoDelete(), and setPermanentMessage().

KviStatusBar::~KviStatusBar ( )

Destroys the statusbar object.

References m_bStopLayoutOnAddRemove, m_pAppletDescriptors, m_pAppletList, m_pMessageLabel, m_pMessageQueue, m_pMessageTimer, and save().

Member Function Documentation

KviStatusBarApplet * KviStatusBar::appletAt	(	const QPoint &	pnt,
		bool	bBestMatch = `false`
	)

Returns the applet at the given point.

If bBestMatch is specified and no applets are found, the last applet will be returned

Parameters

pnt	The source point
bBestMatch	Whether to return the best match

Returns: KviStatusBarApplet *

Warning: pnt is global!

References KviPointerList< T >::first(), KviPointerList< T >::last(), m_pAppletList, and KviPointerList< T >::next().

Referenced by contextMenuRequested(), and tipRequest().

bool KviStatusBar::appletExists ( KviStatusBarApplet * pApplet )

Returns true if the applet exists, false otherwise.

Parameters

pApplet The pointer to the applet to check existence

Returns: bool

References KviPointerList< T >::findRef(), and m_pAppletList.

Referenced by contextPopupAboutToShow(), dragMoveEvent(), and removeClickedApplet().

void KviStatusBar::appletsPopupAboutToShow ( )

protectedslot

Shows the per-applet popup menu.

Returns: void

References KviPointerHashTableIterator< Key, T >::current(), d, g_pModuleManager, KviModuleManager::loadModulesByCaps(), m_pAppletDescriptors, and m_pAppletsPopup.

Referenced by contextPopupAboutToShow().

void KviStatusBar::appletsPopupActivated ( QAction * pAction )

protectedslot

Called when the user activates the per-applet popup.

Parameters

iId	The id of the applet

Returns: void

References KviPointerHashTableIterator< Key, T >::current(), d, KviPointerList< T >::findRef(), KviPointerList< T >::inSort(), m_bStopLayoutOnAddRemove, m_pAppletDescriptors, m_pAppletList, m_pClickedApplet, KviPointerList< T >::removeRef(), and showLayoutHelp().

Referenced by contextPopupAboutToShow().

void KviStatusBar::contextMenuRequested ( const QPoint & pos )

protectedslot

Called when the user requests a context menu.

Parameters

pos	The position of the mouse

Returns: void

References appletAt(), connect(), contextPopupAboutToShow(), m_pClickedApplet, and m_pContextPopup.

Referenced by KviStatusBar().

void KviStatusBar::contextPopupAboutToShow ( )

protectedslot

Shows the applet common popup menu.

Returns: void

References __tr2qs, appletExists(), appletsPopupAboutToShow(), appletsPopupActivated(), connect(), KviStatusBarApplet::descriptor(), KviStatusBarApplet::fillContextPopup(), m_pAppletsPopup, m_pClickedApplet, m_pContextPopup, Normal, p, removeClickedApplet(), and KviStatusBarAppletDescriptor::visibleName().

Referenced by contextMenuRequested().

KviStatusBarApplet * KviStatusBar::createApplet ( const QString & szInternalName )

protected

Create an applet.

It searches for the given name and if found in the applet descriptor stack, it will passes creates the applet

Parameters

szInternalName The internal name of the applet

Returns: KviStatusBarApplet *

References KviStatusBarAppletDescriptor::create(), d, KviPointerHashTable< Key, T >::find(), and m_pAppletDescriptors.

Referenced by load().

void KviStatusBar::dragEnterEvent ( QDragEnterEvent * event )

protected

void KviStatusBar::dragMoveEvent ( QDragMoveEvent * de )

protected

References appletExists(), KviPointerList< T >::first(), KviStatusBarApplet::index(), KviPointerList< T >::last(), m_pAppletList, m_pClickedApplet, KviPointerList< T >::prev(), KviStatusBarApplet::setIndex(), and KviPointerList< T >::sort().

void KviStatusBar::dropEvent ( QDropEvent * de )

protected

References m_pClickedApplet.

bool KviStatusBar::event ( QEvent * e )

protectedvirtual

References tipRequest().

KviMainWindow* KviStatusBar::frame ( )

inline

Returns the frame pointer.

Returns: KviMainWindow *

Referenced by KviStatusBarAwayIndicator::KviStatusBarAwayIndicator(), KviStatusBarLagIndicator::KviStatusBarLagIndicator(), KviStatusBarAwayIndicator::mouseDoubleClickEvent(), KviStatusBarLagIndicator::mouseDoubleClickEvent(), KviStatusBarAwayIndicator::tipText(), KviStatusBarLagIndicator::tipText(), KviStatusBarAwayIndicator::updateDisplay(), and KviStatusBarLagIndicator::updateDisplay().

int KviStatusBar::insertPermanentWidgetAtTheEnd	(	QWidget *	widget,
		int	stretch = `0`
	)

Inserts an applet at the end of the statusbar as a permanent widget and returns its index.

Parameters

widget	The widget to insert
stretch	Stretch factor used to compute widget size when the statusbar gets resized. Defaults to 0.

Returns: int

References KviPointerList< T >::count(), and m_pAppletList.

Referenced by CreateStatusBarAwayIndicator(), CreateStatusBarClock(), CreateStatusBarConnectionTimer(), CreateStatusBarLagIndicator(), CreateStatusBarSeparator(), CreateStatusBarUpdateIndicator(), CreateTorrentClientApplet(), and KVSO_CLASS_FUNCTION().

void KviStatusBar::load ( )

protected

Saves the statusbar stack.

Returns: void

References createApplet(), KviCString::Format, g_pApp, g_pModuleManager, KviModuleManager::getModule(), KviApplication::getReadOnlyConfigPath(), i, KviStatusBarApplet::loadState(), KviCString::ptr(), KviConfigurationFile::Read, KviConfigurationFile::readEntry(), KviConfigurationFile::readIntEntry(), and KviConfigurationFile::setGroup().

Referenced by KviMainWindow::KviMainWindow(), and KviMainWindow::toggleStatusBar().

void KviStatusBar::messageTimerFired ( )

protectedslot

Called when the timer timeouts.

Remove the first item from the stack and sets the second one as permanent

Returns: void

References KviPointerList< T >::isEmpty(), m_pMessageQueue, m_pMessageTimer, KviPointerList< T >::removeFirst(), setPermanentMessage(), and showFirstMessageInQueue().

Referenced by showFirstMessageInQueue().

void KviStatusBar::mouseDoubleClickEvent ( QMouseEvent * e )

protectedvirtual

References __tr2qs, KviMainWindow::activeContext(), c, KviIrcContext::Connected, KviIrcContext::connection(), KviIrcConnection::currentNetworkName(), KviIrcConnection::currentServerName(), KviIrcConnectionUserInfo::hostName(), KviIrcConnectionUserInfo::isAway(), KviIrcConnectionUserInfo::localHostIp(), m_pFrame, KviIrcConnectionUserInfo::nickName(), KviIrcContext::state(), KviIrcConnection::userInfo(), KviIrcConnectionUserInfo::userMode(), and KviIrcConnectionUserInfo::userName().

void KviStatusBar::mousePressEvent ( QMouseEvent * e )

protectedvirtual

References KviStatusBarApplet::index(), m_pAppletList, m_pClickedApplet, and KviPointerList< T >::sort().

void KviStatusBar::queueMessage ( KviStatusBarMessage * pMsg )

Queue a statusbar message in the stack.

Parameters

pMsg	The pointer to the message to queue

Returns: void

Warning: It takes the ownership of pMsg

References KviPointerList< T >::append(), KviPointerList< T >::count(), KviPointerList< T >::first(), m_pMessageQueue, m_pMessageTimer, KviPointerList< T >::prepend(), KviStatusBarMessage::priority(), and showFirstMessageInQueue().

Referenced by showLayoutHelp().

void KviStatusBar::recalcMinimumHeight ( )

protected

Recalculates the minimum height of the status bar.

Returns: void

References l, KviPointerList< T >::last(), m_iLastMinimumHeight, m_pAppletList, m_pMessageLabel, KviPointerList< T >::prev(), RICHTEXTLABELTRICK, and VMARGIN.

void KviStatusBar::registerApplet ( KviStatusBarApplet * pApplet )

protected

Registers the given applet in the statusbar.

Parameters

pApplet The pointer to the applet

Returns: void

References KviPointerList< T >::inSort(), and m_pAppletList.

Referenced by KviStatusBarApplet::KviStatusBarApplet().

void KviStatusBar::registerAppletDescriptor ( KviStatusBarAppletDescriptor * d )

Registers the applet descriptor.

Parameters

d	The applet description to register

Returns: void

References d, KviStatusBarAppletDescriptor::internalName(), m_pAppletDescriptors, and KviPointerHashTable< Key, T >::replace().

Referenced by StatusBarApplet::selfRegister(), KviStatusBarClock::selfRegister(), KviStatusBarConnectionTimer::selfRegister(), KviStatusBarSeparator::selfRegister(), KviStatusBarAwayIndicator::selfRegister(), KviStatusBarLagIndicator::selfRegister(), and KviStatusBarUpdateIndicator::selfRegister().

void KviStatusBar::removeClickedApplet ( )

protectedslot

Called when the user removes an applet from the statusbar.

Returns: void

References appletExists(), and m_pClickedApplet.

Referenced by contextPopupAboutToShow().

void KviStatusBar::save ( )

protected

Saves the statusbar stack.

Returns: void

References KviApplication::Config, KviPointerList< T >::count(), KviPointerList< T >::first(), KviCString::Format, g_pApp, KviApplication::getLocalKvircDirectory(), i, m_pAppletList, KviPointerList< T >::next(), KviCString::ptr(), KviConfigurationFile::setGroup(), KviPointerList< T >::sort(), KviConfigurationFile::Write, and KviConfigurationFile::writeEntry().

Referenced by ~KviStatusBar().

void KviStatusBar::setPermanentMessage ( )

protectedslot

Sets the permanent message to be shown.

The message varies upon the connection status

Returns: void

References __tr2qs, KviMainWindow::activeContext(), c, KviIrcContext::Connected, KviIrcContext::Connecting, KviIrcContext::connection(), KviIrcConnection::currentNickName(), KviIrcConnection::currentServerName(), KviIrcContext::LoggingIn, m_pFrame, m_pMessageLabel, m_pMessageTimer, KviIrcContext::state(), KviIrcConnection::userInfo(), and KviIrcConnectionUserInfo::userMode().

Referenced by KviStatusBar(), and messageTimerFired().

void KviStatusBar::showFirstMessageInQueue ( )

protected

Shows the first message in the queue stack.

Returns: void

References connect(), KviPointerList< T >::first(), m_pMessageLabel, m_pMessageQueue, m_pMessageTimer, messageTimerFired(), KviStatusBarMessage::text(), and KviStatusBarMessage::timeout().

Referenced by messageTimerFired(), and queueMessage().

void KviStatusBar::showLayoutHelp ( )

protected

Shows the common help for every applet.

Returns: void

References __tr2qs, and queueMessage().

Referenced by appletsPopupActivated().

void KviStatusBar::tipRequest ( QHelpEvent * e )

protected

Shows the right tooltip.

If an applet is found at the position of the triggered event, the right tooltip will be show, otherwise a common one will be show

Parameters

e	The event triggered

Returns: void

References __tr2qs, KviMainWindow::activeContext(), appletAt(), c, KviIrcContext::Connected, KviStatusBarApplet::descriptor(), m_pFrame, KviIrcContext::state(), KviStatusBarApplet::tipText(), and KviStatusBarAppletDescriptor::visibleName().

Referenced by event().

void KviStatusBar::unregisterApplet ( KviStatusBarApplet * pApplet )

protected

Unegisters the given applet in the statusbar.

Parameters

pApplet The pointer to the applet

Returns: void

References m_pAppletList, and KviPointerList< T >::removeRef().

Referenced by KviStatusBarApplet::~KviStatusBarApplet().

Friends And Related Function Documentation

friend class KviMainWindow

friend

friend class KviStatusBarApplet

friend

Member Data Documentation

bool KviStatusBar::m_bStopLayoutOnAddRemove

protected

Referenced by appletsPopupActivated(), KviStatusBar(), and ~KviStatusBar().

int KviStatusBar::m_iLastMinimumHeight

protected

Referenced by KviStatusBar(), and recalcMinimumHeight().

KviPointerHashTable<QString, KviStatusBarAppletDescriptor>* KviStatusBar::m_pAppletDescriptors

protected

Referenced by appletsPopupAboutToShow(), appletsPopupActivated(), createApplet(), KviStatusBar(), registerAppletDescriptor(), and ~KviStatusBar().

KviPointerList<KviStatusBarApplet>* KviStatusBar::m_pAppletList

protected

Referenced by appletAt(), appletExists(), appletsPopupActivated(), dragMoveEvent(), insertPermanentWidgetAtTheEnd(), KviStatusBar(), mousePressEvent(), recalcMinimumHeight(), registerApplet(), save(), unregisterApplet(), and ~KviStatusBar().

QMenu* KviStatusBar::m_pAppletsPopup

protected

Referenced by appletsPopupAboutToShow(), contextPopupAboutToShow(), and KviStatusBar().

KviTalHBox* KviStatusBar::m_pBox

protected

KviStatusBarApplet* KviStatusBar::m_pClickedApplet

protected

Referenced by appletsPopupActivated(), contextMenuRequested(), contextPopupAboutToShow(), dragMoveEvent(), dropEvent(), KviStatusBar(), mousePressEvent(), and removeClickedApplet().

QMenu* KviStatusBar::m_pContextPopup

protected

Referenced by contextMenuRequested(), contextPopupAboutToShow(), and KviStatusBar().

KviMainWindow* KviStatusBar::m_pFrame

protected

Referenced by KviStatusBar(), mouseDoubleClickEvent(), setPermanentMessage(), and tipRequest().

QLabel* KviStatusBar::m_pMessageLabel

protected

Referenced by KviStatusBar(), recalcMinimumHeight(), setPermanentMessage(), showFirstMessageInQueue(), and ~KviStatusBar().

KviPointerList<KviStatusBarMessage>* KviStatusBar::m_pMessageQueue

protected

Referenced by KviStatusBar(), messageTimerFired(), queueMessage(), showFirstMessageInQueue(), and ~KviStatusBar().

QTimer* KviStatusBar::m_pMessageTimer

protected

Referenced by KviStatusBar(), messageTimerFired(), queueMessage(), setPermanentMessage(), showFirstMessageInQueue(), and ~KviStatusBar().

KviDynamicToolTip* KviStatusBar::m_pToolTip

protected

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

src/kvirc/ui/KviStatusBar.h
src/kvirc/ui/KviStatusBar.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation