KLFContainerSideWidgetManager Class Reference

A generic container side widget show/hide manager (mac only) More...

#include <klfsidewidget.h>

Inheritance diagram for KLFContainerSideWidgetManager:

Collaboration diagram for KLFContainerSideWidgetManager:

List of all members.

Public Slots
virtual void	showSideWidget (bool show)
Public Member Functions
	KLFContainerSideWidgetManager (QWidget *parentWidget=NULL, QWidget *sideWidget=NULL, QObject *managerParent=NULL)
virtual	~KLFContainerSideWidgetManager ()
virtual bool	sideWidgetVisible () const
bool	eventFilter (QObject *obj, QEvent *event)
Protected Member Functions
void	init ()
	Must be called in subclasses' constructor.
virtual QWidget *	createContainerWidget (QWidget *pw)=0
	Must be reimplemented to create the container widget.
virtual QWidget *	containerWidget () const
virtual void	newSideWidgetSet (QWidget *oldSideWidget, QWidget *newSideWidget)
virtual void	newParentWidgetSet (QWidget *oldWidget, QWidget *newWidget)

---

Detailed Description

A generic container side widget show/hide manager (mac only)

Warning:

NOTE: You do not have to instantiate this class yourself to use KLFSideWidget. This is automatically done in KLFSideWidget::setSideWidgetManager().

This class is provided in case you want to subclass it and use part of its functionality to write custom, more advanced side widget managers. See also KLFSideWidgetManagerBase.

This class provides a generic container-based side widget manager, meant to be subclassed for more specific functionality. For example, both KLFFloatSideWidgetManager and KLFDrawerSideWidgetManager inherit this class.

Subclasses must reimplement createContainerWidget() to actually create the widget which will contain the side widget. Also, subclasses must not forget to call init() in their constructor.

Definition at line 223 of file klfsidewidget.h.

---

Constructor & Destructor Documentation

KLFContainerSideWidgetManager::KLFContainerSideWidgetManager	(	QWidget *	parentWidget = NULL,
		QWidget *	sideWidget = NULL,
		QObject *	managerParent = NULL
	)

Definition at line 429 of file klfsidewidget.cpp.

References QObject::connect(), QObject::destroyed(), KLF_INIT_PRIVATE, klfDbg, and KLFSideWidgetManagerBase::sideWidget().

KLFContainerSideWidgetManager::~KLFContainerSideWidgetManager

(

)

[virtual]

Definition at line 466 of file klfsidewidget.cpp.

References KLF_DEBUG_BLOCK, KLF_DELETE_PRIVATE, KLF_FUNC_NAME, klfDbg, and KLFSideWidgetManagerBase::sideWidget().

---

Member Function Documentation

QWidget * KLFContainerSideWidgetManager::containerWidget

(

)

const [protected, virtual]

Definition at line 461 of file klfsidewidget.cpp.

Referenced by KLFFloatSideWidgetManager::setWFlags(), KLFFloatSideWidgetManager::showSideWidget(), and KLFFloatSideWidgetManager::sideWidgetVisible().

virtual QWidget* KLFContainerSideWidgetManager::createContainerWidget

(

QWidget *

pw

)

[protected, pure virtual]

Must be reimplemented to create the container widget.

Implemented in KLFFloatSideWidgetManager.

Referenced by init().

bool KLFContainerSideWidgetManager::eventFilter	(	QObject *	obj,
		QEvent *	event
	)		[virtual]

Reimplemented from QObject.

Definition at line 491 of file klfsidewidget.cpp.

References klfDbg, KLFSideWidgetManagerBase::showSideWidget(), and QEvent::type().

void KLFContainerSideWidgetManager::init

(

)

[protected]

Must be called in subclasses' constructor.

Definition at line 441 of file klfsidewidget.cpp.

References QObject::connect(), createContainerWidget(), QObject::destroyed(), KLF_ASSERT_NOT_NULL, KLFSideWidgetManagerBase::setOurParentWidget(), and KLFSideWidgetManagerBase::setSideWidget().

Referenced by KLFFloatSideWidgetManager::KLFFloatSideWidgetManager().

void KLFContainerSideWidgetManager::newParentWidgetSet	(	QWidget *	oldWidget,
		QWidget *	newWidget
	)		[protected, virtual]

Reimplemented from KLFSideWidgetManagerBase.

Definition at line 559 of file klfsidewidget.cpp.

void KLFContainerSideWidgetManager::newSideWidgetSet	(	QWidget *	oldSideWidget,
		QWidget *	newSideWidget
	)		[protected, virtual]

Reimplemented from KLFSideWidgetManagerBase.

Reimplemented in KLFFloatSideWidgetManager.

Definition at line 522 of file klfsidewidget.cpp.

References QObject::connect(), QObject::destroyed(), QObject::disconnect(), KLF_ASSERT_NOT_NULL, KLF_DEBUG_BLOCK, KLF_FUNC_NAME, klfDbg, and KLFSideWidgetManagerBase::sideWidgetShown().

void KLFContainerSideWidgetManager::showSideWidget

(

bool

show

)

[virtual, slot]

Implements KLFSideWidgetManagerBase.

Reimplemented in KLFFloatSideWidgetManager.

Definition at line 511 of file klfsidewidget.cpp.

References KLF_ASSERT_NOT_NULL, and KLFSideWidgetManagerBase::sideWidgetShown().

bool KLFContainerSideWidgetManager::sideWidgetVisible

(

)

const [virtual]

Implements KLFSideWidgetManagerBase.

Reimplemented in KLFFloatSideWidgetManager.

Definition at line 505 of file klfsidewidget.cpp.

References KLF_ASSERT_NOT_NULL.

---

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

• src/klftools/klfsidewidget.h
• src/klftools/klfsidewidget.cpp