Detailed Description

Classes
class	GlobalAreaWidget

class	GlobalAreaTabStyle

class	CloseButton

class	GlobalArea

Class Documentation

◆ GlobalAreaWidget

class GlobalAreaWidget

Deprecated:: Use `SidebarWidget` with `SidebarContextSensitivity::Global` instead

Public Member Functions
	GlobalAreaWidget (const QString &title)

Public Member Functions inherited from SidebarWidget
	SidebarWidget (const QString &title)

	~SidebarWidget ()

const QString &	title () const

void	enableRefreshTimer (int interval)

void	setRefreshQuiesce (bool enable)

virtual void	notifyRefresh ()

virtual void	notifyFontChanged ()

virtual void	notifyOffsetChanged (uint64_t)

virtual void	notifyThemeChanged ()

virtual void	notifyViewChanged (ViewFrame *)

virtual void	notifyViewLocationChanged (View *, const ViewLocation &)

virtual void	focus ()

virtual void	closing ()

virtual void	setPrimaryOrientation (Qt::Orientation)

virtual QWidget *	headerWidget ()

Additional Inherited Members
Protected Attributes inherited from SidebarWidget
QString	m_title

UIActionHandler	m_actionHandler

ContextMenuManager *	m_contextMenuManager = nullptr

Menu *	m_menu = nullptr

QTimer *	m_updateTimer = nullptr

Constructor & Destructor Documentation

◆ GlobalAreaWidget()

GlobalAreaWidget::GlobalAreaWidget ( const QString & title )

◆ GlobalAreaTabStyle

class GlobalAreaTabStyle

Public Member Functions
virtual QSize	sizeForTab (const QWidget *widget, const DockableTabInfo &info, int idx, int count, int active) const override

virtual QRect	closeButtonRect (const QWidget *widget, const DockableTabInfo &info, int idx, int count, int active) const override

virtual QRect	closeIconRect (const QWidget *widget, const DockableTabInfo &info, int idx, int count, int active) const override

virtual void	paintTab (const QWidget *widget, QStylePainter &p, const DockableTabInfo &info, int idx, int count, int active, DockableTabInteractionState state, const QRect &rect) const override

virtual DockableTabStyle *	duplicate () override

Public Member Functions inherited from DockableTabStyle
virtual	~DockableTabStyle ()

virtual QSize	sizeForTab (const QWidget *widget, const DockableTabInfo &info, int idx, int count, int active) const

virtual QRect	closeButtonRect (const QWidget *widget, const DockableTabInfo &info, int idx, int count, int active) const

virtual QRect	closeIconRect (const QWidget *widget, const DockableTabInfo &info, int idx, int count, int active) const

virtual void	paintTab (const QWidget *widget, QStylePainter &p, const DockableTabInfo &info, int idx, int count, int active, DockableTabInteractionState state, const QRect &rect) const

virtual void	paintBase (const QWidget *widget, QStylePainter &p, const QRect &rect, const QRect &activeRect) const

virtual DockableTabStyle *	duplicate ()

Member Function Documentation

◆ sizeForTab()

virtual QSize GlobalAreaTabStyle::sizeForTab	(	const QWidget *	widget,
		const DockableTabInfo &	info,
		int	idx,
		int	count,
		int	active
	)		const

overridevirtual

Reimplemented from DockableTabStyle.

◆ closeButtonRect()

virtual QRect GlobalAreaTabStyle::closeButtonRect	(	const QWidget *	widget,
		const DockableTabInfo &	info,
		int	idx,
		int	count,
		int	active
	)		const

overridevirtual

Reimplemented from DockableTabStyle.

◆ closeIconRect()

virtual QRect GlobalAreaTabStyle::closeIconRect	(	const QWidget *	widget,
		const DockableTabInfo &	info,
		int	idx,
		int	count,
		int	active
	)		const

overridevirtual

Reimplemented from DockableTabStyle.

◆ paintTab()

virtual void GlobalAreaTabStyle::paintTab	(	const QWidget *	widget,
		QStylePainter &	p,
		const DockableTabInfo &	info,
		int	idx,
		int	count,
		int	active,
		DockableTabInteractionState	state,
		const QRect &	rect
	)		const

overridevirtual

Reimplemented from DockableTabStyle.

◆ duplicate()

virtual DockableTabStyle * GlobalAreaTabStyle::duplicate ( )

overridevirtual

Reimplemented from DockableTabStyle.

◆ CloseButton

class CloseButton

Signals
void	clicked ()

Public Member Functions
	CloseButton ()

virtual QSize	sizeHint () const override

Protected Member Functions
virtual void	paintEvent (QPaintEvent *event) override

virtual void	enterEvent (QEnterEvent *event) override

virtual void	leaveEvent (QEvent *event) override

virtual void	mouseMoveEvent (QMouseEvent *event) override

virtual void	mousePressEvent (QMouseEvent *event) override

virtual void	mouseReleaseEvent (QMouseEvent *event) override

Constructor & Destructor Documentation

◆ CloseButton()

CloseButton::CloseButton ( )

Member Function Documentation

◆ sizeHint()

virtual QSize CloseButton::sizeHint ( ) const

overridevirtual

◆ paintEvent()

virtual void CloseButton::paintEvent ( QPaintEvent * event )

overrideprotectedvirtual

◆ enterEvent()

virtual void CloseButton::enterEvent ( QEnterEvent * event )

overrideprotectedvirtual

◆ leaveEvent()

virtual void CloseButton::leaveEvent ( QEvent * event )

overrideprotectedvirtual

◆ mouseMoveEvent()

virtual void CloseButton::mouseMoveEvent ( QMouseEvent * event )

overrideprotectedvirtual

◆ mousePressEvent()

virtual void CloseButton::mousePressEvent ( QMouseEvent * event )

overrideprotectedvirtual

◆ mouseReleaseEvent()

virtual void CloseButton::mouseReleaseEvent ( QMouseEvent * event )

overrideprotectedvirtual

◆ clicked

void CloseButton::clicked ( )

signal

◆ GlobalArea

class GlobalArea

Public Member Functions
	GlobalArea (QWidget owner, Sidebar sidebar)

void	addWidget (GlobalAreaWidget *widget, bool canClose=false)

void	initRegisteredWidgets (UIContext *context)

bool	isWidgetVisible (const QString &title)

bool	toggleVisible ()

bool	toggleWidgetVisible (const QString &title)

void	focusWidget (const QString &title)

GlobalAreaWidget *	widget (const QString &title)

void	closeTab (QWidget *widget)

Static Public Member Functions
static void	addWidget (const std::function< GlobalAreaWidget (UIContext )> &createWidget)

static GlobalArea *	current ()

template<class T >
static T *	widget (const QString &title)

template<class T >
static UIAction	globalAreaAction (const QString &title, const std::function< void(T *obj)> &activate)

template<class T >
static UIAction	globalAreaAction (const QString &title, const std::function< void(T *obj, const UIActionContext &ctxt)> &activate)

template<class T >
static UIAction	globalAreaAction (const QString &title, const std::function< void(T obj)> &activate, const std::function< bool(T obj)> &isValid)

template<class T >
static UIAction	globalAreaAction (const QString &title, const std::function< void(T obj, const UIActionContext &ctxt)> &activate, const std::function< bool(T obj, const UIActionContext &ctxt)> &isValid)

template<class T >
static std::function< bool(const UIActionContext &)>	globalAreaActionChecked (const QString &title, const std::function< bool(T *obj)> &isChecked)

template<class T >
static std::function< bool(const UIActionContext &)>	globalAreaActionChecked (const QString &title, const std::function< bool(T *obj, const UIActionContext &ctxt)> &isChecked)

Constructor & Destructor Documentation

◆ GlobalArea()

GlobalArea::GlobalArea	(	QWidget *	owner,
		Sidebar *	sidebar
	)

Member Function Documentation

◆ addWidget() [1/2]

void GlobalArea::addWidget	(	GlobalAreaWidget *	widget,
		bool	canClose = `false`
	)

◆ addWidget() [2/2]

static void GlobalArea::addWidget ( const std::function< GlobalAreaWidget *(UIContext *)> & createWidget )

static

◆ initRegisteredWidgets()

void GlobalArea::initRegisteredWidgets ( UIContext * context )

◆ isWidgetVisible()

bool GlobalArea::isWidgetVisible ( const QString & title )

◆ toggleVisible()

bool GlobalArea::toggleVisible ( )

◆ toggleWidgetVisible()

bool GlobalArea::toggleWidgetVisible ( const QString & title )

◆ focusWidget()

void GlobalArea::focusWidget ( const QString & title )

◆ widget() [1/2]

GlobalAreaWidget * GlobalArea::widget ( const QString & title )

◆ closeTab()

void GlobalArea::closeTab ( QWidget * widget )

◆ current()

static GlobalArea * GlobalArea::current ( )

inlinestatic

◆ widget() [2/2]

template<class T >

static T * GlobalArea::widget ( const QString & title )

inlinestatic

◆ globalAreaAction() [1/4]

template<class T >

static UIAction GlobalArea::globalAreaAction	(	const QString &	title,
		const std::function< void(T *obj)> &	activate
	)

inlinestatic

◆ globalAreaAction() [2/4]

template<class T >

static UIAction GlobalArea::globalAreaAction	(	const QString &	title,
		const std::function< void(T *obj, const UIActionContext &ctxt)> &	activate
	)

inlinestatic

◆ globalAreaAction() [3/4]

template<class T >

static UIAction GlobalArea::globalAreaAction	(	const QString &	title,
		const std::function< void(T *obj)> &	activate,
		const std::function< bool(T *obj)> &	isValid
	)

inlinestatic

◆ globalAreaAction() [4/4]

template<class T >

static UIAction GlobalArea::globalAreaAction	(	const QString &	title,
		const std::function< void(T *obj, const UIActionContext &ctxt)> &	activate,
		const std::function< bool(T *obj, const UIActionContext &ctxt)> &	isValid
	)

inlinestatic

◆ globalAreaActionChecked() [1/2]

template<class T >

static std::function< bool(const UIActionContext &)> GlobalArea::globalAreaActionChecked	(	const QString &	title,
		const std::function< bool(T *obj)> &	isChecked
	)

inlinestatic

◆ globalAreaActionChecked() [2/2]

template<class T >

static std::function< bool(const UIActionContext &)> GlobalArea::globalAreaActionChecked	(	const QString &	title,
		const std::function< bool(T *obj, const UIActionContext &ctxt)> &	isChecked
	)

inlinestatic

Detailed Description

Classes

Class Documentation

◆ GlobalAreaWidget

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ GlobalAreaWidget()

◆ GlobalAreaTabStyle

Public Member Functions

Member Function Documentation

◆ sizeForTab()

◆ closeButtonRect()

◆ closeIconRect()

◆ paintTab()

◆ duplicate()

◆ CloseButton

Signals

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ CloseButton()

Member Function Documentation

◆ sizeHint()

◆ paintEvent()

◆ enterEvent()

◆ leaveEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ clicked

◆ GlobalArea

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ GlobalArea()

Member Function Documentation

◆ addWidget() [1/2]

◆ addWidget() [2/2]

◆ initRegisteredWidgets()

◆ isWidgetVisible()

◆ toggleVisible()

◆ toggleWidgetVisible()

◆ focusWidget()

◆ widget() [1/2]

◆ closeTab()

◆ current()

◆ widget() [2/2]

◆ globalAreaAction() [1/4]

◆ globalAreaAction() [2/4]

◆ globalAreaAction() [3/4]

◆ globalAreaAction() [4/4]

◆ globalAreaActionChecked() [1/2]

◆ globalAreaActionChecked() [2/2]