[KLF Backend][KLF Tools][KLF Home]
KLatexFormula Project
KLFShowHideSideWidgetManager Class Reference

A show-widget/hide-widget side widget show/hide manager. More...

#include <klfsidewidget.h>

Inheritance diagram for KLFShowHideSideWidgetManager:
Collaboration diagram for KLFShowHideSideWidgetManager:

Public Slots

virtual void showSideWidget (bool show)
void setOrientation (Qt::Orientation o)
void setCalcSpacing (int cs)
Public Slots inherited from KLFSideWidgetManagerBase
virtual void showSideWidget (bool show)=0
 Show or hide the side widget.
void showSideWidget ()
void hideSideWidget (bool hide=true)
void toggleSideWidget ()
virtual void waitForShowHideActionFinished (int timeout_ms=2000)

Public Member Functions

 KLFShowHideSideWidgetManager (QWidget *parentWidget=NULL, QWidget *sideWidget=NULL, QObject *managerParent=NULL)
virtual ~KLFShowHideSideWidgetManager ()
Qt::Orientation orientation () const
int calcSpacing () const
virtual bool eventFilter (QObject *obj, QEvent *event)
virtual bool sideWidgetVisible () const
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 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

virtual bool event (QEvent *event)
virtual void newSideWidgetSet (QWidget *oldSideWidget, QWidget *newSideWidget)
virtual void newParentWidgetSet (QWidget *oldParentWidget, QWidget *newParentWidget)
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)

Properties

Qt::Orientation orientation
int calcSpacing
Properties inherited from QObject
 objectName

Additional Inherited Members

Signals inherited from KLFSideWidgetManagerBase
void sideWidgetShown (bool shown)
 Emitted whenever the shown status of the side widget has changed.
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)

Detailed Description

A show-widget/hide-widget side widget show/hide manager.

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 manager just shows and hides the widget inside its original parent layout, and adapts the parent's size correctly upon each show/hide.

Definition at line 168 of file klfsidewidget.h.

Constructor & Destructor Documentation

◆ KLFShowHideSideWidgetManager()

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

◆ ~KLFShowHideSideWidgetManager()

KLFShowHideSideWidgetManager::~KLFShowHideSideWidgetManager ( )
virtual

Definition at line 203 of file klfsidewidget.cpp.

References KLF_DELETE_PRIVATE.

Member Function Documentation

◆ calcSpacing()

int KLFShowHideSideWidgetManager::calcSpacing ( ) const

◆ event()

bool KLFShowHideSideWidgetManager::event ( QEvent * event)
protectedvirtual

Reimplemented from QObject.

Definition at line 307 of file klfsidewidget.cpp.

References event(), and QObject::event().

Referenced by calcSpacing(), event(), eventFilter(), and setCalcSpacing().

◆ eventFilter()

◆ newParentWidgetSet()

void KLFShowHideSideWidgetManager::newParentWidgetSet ( QWidget * oldParentWidget,
QWidget * newParentWidget )
protectedvirtual

Reimplemented from KLFSideWidgetManagerBase.

Definition at line 256 of file klfsidewidget.cpp.

References KLF_DEBUG_BLOCK.

Referenced by setCalcSpacing().

◆ newSideWidgetSet()

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

◆ orientation()

Qt::Orientation KLFShowHideSideWidgetManager::orientation ( ) const

◆ setCalcSpacing

void KLFShowHideSideWidgetManager::setCalcSpacing ( int cs)
slot

◆ setOrientation

void KLFShowHideSideWidgetManager::setOrientation ( Qt::Orientation o)
slot

◆ showSideWidget

◆ sideWidgetVisible()

bool KLFShowHideSideWidgetManager::sideWidgetVisible ( ) const
virtual

Property Documentation

◆ calcSpacing

int KLFShowHideSideWidgetManager::calcSpacing
readwrite

Definition at line 173 of file klfsidewidget.h.

◆ orientation

Qt::Orientation KLFShowHideSideWidgetManager::orientation
readwrite

Definition at line 172 of file klfsidewidget.h.


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

Generated by doxygen 1.14.0