[KLF Backend][KLF Tools][KLF Home]
KLatexFormula Project
Public Slots | Public Member Functions | Protected Member Functions | List of all members
KLFContainerSideWidgetManager Class Referenceabstract

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

#include <klfsidewidget.h>

Inheritance diagram for KLFContainerSideWidgetManager:
Inheritance graph
[legend]
Collaboration diagram for KLFContainerSideWidgetManager:
Collaboration graph
[legend]

Public Slots

virtual void showSideWidget (bool show)
 
- Public Slots inherited from KLFSideWidgetManagerBase
virtual void showSideWidget (bool show)=0
 Show or hide the side widget. More...
 
void showSideWidget ()
 
void hideSideWidget (bool hide=true)
 
void toggleSideWidget ()
 
virtual void waitForShowHideActionFinished (int timeout_ms=2000)
 

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)
 
- Public Member Functions inherited from KLFSideWidgetManagerBase
 KLFSideWidgetManagerBase (QWidget *parentWidget=NULL, QWidget *sideWidget=NULL, bool requireSideWidgetParentConsistency=false, QObject *managerParent=NULL)
 
virtual ~KLFSideWidgetManagerBase ()
 
virtual QWidget * sideWidget () const
 
virtual QWidget * ourParentWidget () const
 
void setSideWidget (QWidget *widget)
 
void setOurParentWidget (QWidget *widget)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual const QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const
 
const QObjectList & children () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
bool inherits (const char *className) const
 
void deleteLater ()
 

Protected Member Functions

void init ()
 Must be called in subclasses' constructor. More...
 
virtual QWidget * createContainerWidget (QWidget *pw)=0
 Must be reimplemented to create the container widget. More...
 
virtual QWidget * containerWidget () const
 
virtual void newSideWidgetSet (QWidget *oldSideWidget, QWidget *newSideWidget)
 
virtual void newParentWidgetSet (QWidget *oldWidget, QWidget *newWidget)
 
- Protected Member Functions inherited from KLFSideWidgetManagerBase
virtual bool showHideIsAnimating ()
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 

Additional Inherited Members

- Signals inherited from KLFSideWidgetManagerBase
void sideWidgetShown (bool shown)
 Emitted whenever the shown status of the side widget has changed. More...
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
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 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 QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Properties inherited from QObject
 objectName
 

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::KLFContainerSideWidgetManager ( QWidget *  parentWidget = NULL,
QWidget *  sideWidget = NULL,
QObject managerParent = NULL 
)

◆ ~KLFContainerSideWidgetManager()

KLFContainerSideWidgetManager::~KLFContainerSideWidgetManager ( )
virtual

Member Function Documentation

◆ containerWidget()

QWidget * KLFContainerSideWidgetManager::containerWidget ( ) const
protectedvirtual

◆ createContainerWidget()

virtual QWidget* KLFContainerSideWidgetManager::createContainerWidget ( QWidget *  pw)
protectedpure virtual

Must be reimplemented to create the container widget.

Implemented in KLFFloatSideWidgetManager.

Referenced by init().

◆ eventFilter()

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

Reimplemented from QObject.

Definition at line 491 of file klfsidewidget.cpp.

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

◆ init()

void KLFContainerSideWidgetManager::init ( )
protected

◆ newParentWidgetSet()

void KLFContainerSideWidgetManager::newParentWidgetSet ( QWidget *  oldWidget,
QWidget *  newWidget 
)
protectedvirtual

Reimplemented from KLFSideWidgetManagerBase.

Definition at line 559 of file klfsidewidget.cpp.

References KLF_DEBUG_BLOCK, KLF_FUNC_NAME, KLF_PRIVATE_HEAD, klfDbg, and QObject::parent().

◆ newSideWidgetSet()

void KLFContainerSideWidgetManager::newSideWidgetSet ( QWidget *  oldSideWidget,
QWidget *  newSideWidget 
)
protectedvirtual

◆ showSideWidget

void KLFContainerSideWidgetManager::showSideWidget ( bool  show)
virtualslot

◆ sideWidgetVisible()

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:

Generated by doxygen 1.8.13