TopSideBarWidget Class Reference

Top sidebar container widget. More...

#include <TopSideBarWidget.h>

Inheritance diagram for TopSideBarWidget:

Public Types
enum class	AcceptPosition { LeftSide , RightSide }
	Append position specifier. More...

Public Member Functions
	TopSideBarWidget (QWidget *parent=nullptr)
	Constructs the top sidebar widget.
	~TopSideBarWidget ()
	Destroys the top sidebar widget.
void	installHookedWindow (DesktopMainWindow *mainWindow)
	Installs the main window reference for event handling.
void	append_to_toolside (StatusBarIconWidget *src, AcceptPosition position)
	Appends a status bar widget to the sidebar.
void	handle_possibleEvent (IconEvent *events)
	Processes icon events.
StatusBarIconWidget *	queryFromName (const QString &name)
	Queries status icon widget by name.
void	setHeight (const int height)
	Sets the sidebar height.
int	height_min () const
	Gets the minimum allowed height.
int	height_max () const
	Gets the maximum allowed height.
int	height () const
	Gets the current height.

Detailed Description

Top sidebar container widget.

Holds and manages status bar icon widgets in the top sidebar area.

Member Enumeration Documentation

AcceptPosition

enum class TopSideBarWidget::AcceptPosition

strong

Append position specifier.

Enumerator
LeftSide	Left side of the sidebar.
RightSide	Right side of the sidebar.

Constructor & Destructor Documentation

TopSideBarWidget()

TopSideBarWidget::TopSideBarWidget ( QWidget *  parent = nullptr )

explicit

Constructs the top sidebar widget.

Parameters

parent

Parent widget (optional)

Member Function Documentation

append_to_toolside()

void TopSideBarWidget::append_to_toolside	(	StatusBarIconWidget *	src,
		AcceptPosition	position
	)

Appends a status bar widget to the sidebar.

Parameters

src	Widget to append
position	Target side (left/right)

handle_possibleEvent()

void TopSideBarWidget::handle_possibleEvent

(

IconEvent *

events

)

Processes icon events.

Parameters

events

Event to handle

height()

int TopSideBarWidget::height ( ) const

inline

Gets the current height.

Returns

Current height value

height_max()

int TopSideBarWidget::height_max

(

)

const

Gets the maximum allowed height.

Returns

Maximum height value

height_min()

int TopSideBarWidget::height_min

(

)

const

Gets the minimum allowed height.

Returns

Minimum height value

installHookedWindow()

void TopSideBarWidget::installHookedWindow

(

DesktopMainWindow *

mainWindow

)

Installs the main window reference for event handling.

Parameters

mainWindow

Pointer to the main window

queryFromName()

StatusBarIconWidget * TopSideBarWidget::queryFromName

(

const QString &

name

)

Queries status icon widget by name.

Parameters

name	Name of the widget to find

Returns

Pointer to widget if found, nullptr otherwise

setHeight()

void TopSideBarWidget::setHeight

(

const int

height

)

Sets the sidebar height.

Parameters

height

New height value

---

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

• ui/topstatusbar/TopSideBarWidget.h
• ui/topstatusbar/TopSideBarWidget.cpp