The UI ribbon is a horizontal menu bar typically located at the top of the application interface or along the side. It organizes commands and tools into tabs and groups for easy access. Each tab contains related functionality, categorized into sections such as File, Edit, View, etc. Within these sections, buttons, dropdowns, and other controls allow users to interact with the application features efficiently. The ribbon improves usability by presenting frequently-used commands in a visually organized manner. More...

#include <Ribbon.h>

Inheritance diagram for Ribbon:

[legend]

Collaboration diagram for Ribbon:

[legend]

Public Member Functions
void	addBottomRightWidget (QWidget *widget)

virtual RibbonGroup *	addGroup (const TranslatedString &label)
	Handle window drag events.

virtual void	addGroup (RibbonGroup *group)

void	addTopLeftWidget (QWidget *widget)

RibbonGroup &	group (const TranslatedString &group_name)

const RibbonGroup &	group (const TranslatedString &group_name) const

RibbonGroup &	group (uint04 index)

DockWidget< RibbonGroup > *	groupDock (const RibbonGroup *group)

DockWidget< RibbonGroup > *	groupDock (const TranslatedString &group_name)

DockWidget< RibbonGroup > *	groupDock (uint04 index)

Dictionary< TranslatedString, DockWidget< RibbonGroup > * > &	groups ()

virtual bool	hasGroup (const TranslatedString &group) const

bool	isVertical ()

QSize	minimumSizeHint () const override

RibbonGroup &	operator[] (const TranslatedString &location)

virtual void	removeAllGroups ()

virtual void	removeGroup (const TranslatedString &label)

virtual void	removeGroup (uint04 index)

void	resizeEvent (QResizeEvent *resize_event) override

	Ribbon (QWidget *parent=nullptr)

SectionWidget *	section () const

void	setFixedNumOfRows (uint01 fixed_num_of_rows)

void	setGroupName (uint04 index, const TranslatedString &group_name)

void	setInverseRibbonArea (bool inverse_ribbon_area)

void	setLayoutMode (RibbonLayoutMode mode)

void	setTabLock (bool tab_lock)

QSize	sizeHint () const override

void	slideInIdx (uint04 idx, enum StackAnimationDirection direction=StackAnimationDirection::e_automatic) override

void	updateRibbonLayout ()

	~Ribbon ()

Public Member Functions inherited from ContainerWidgetBase
	ContainerWidgetBase (QWidget *parent=nullptr)

virtual	~ContainerWidgetBase ()

Public Member Functions inherited from QCustomStackedWidgetBase
void	setAnimation (enum QEasingCurve::Type animationtype)

void	setCustomPixmap (QPixmap *pixmap)

void	setSpeed (int speed)

void	setVerticalMode (bool vertical=true)

void	setWrap (bool wrap)

Additional Inherited Members
Public Types inherited from QCustomStackedWidgetBase
enum	StackAnimationDirection { e_left_to_right , e_right_to_left , e_top_to_bottom , e_bottom_to_top , e_automatic }

Signals inherited from QCustomStackedWidgetBase
void	animationFinished ()

Static Public Attributes inherited from QCustomStackedWidgetBase
static ApplicationOption< sint04 >	default_stack_animation_speed

Protected Slots inherited from QCustomStackedWidgetBase
void	animationDoneSlot ()

void	childDestroyedSlot (QObject *widget)

Protected Member Functions inherited from ContainerWidgetBase
virtual FloatingWidget *	addSectionContent (SectionContent *sc)

virtual SectionWidget *	addSectionContent (SectionContent sc, SectionWidget sw, DropArea area=e_drop_center)

void	beginResetAll ()

void	bringFloatingWidgetsForward ()

virtual void	clearAllNonFloatingContent ()

virtual void	clearAllSectionContent ()

Buffer< SectionContent * >	contents () const

DropOverlay *	dropOverlay ()

void	endResetAll ()

bool	event (QEvent *event) override

bool	hasSectionContent (SectionContent *sc)

bool	hideSectionContent (SectionContent *sc, PopupInfo end=PopupInfo())

bool	isSectionContentVisible (SectionContent *sc)

FloatingWidget *	makeFloating (SectionContent *sc, bool show, PopupInfo start=PopupInfo(), PopupInfo end=PopupInfo())

FloatingWidget *	makeFullScreen (SectionContent *sc, PopupInfo start=PopupInfo())

QSize	minimumSizeHint () const override

QRect	outerBottomDropRect () const

QRect	outerLeftDropRect () const

QRect	outerRightDropRect () const

QRect	outerTopDropRect () const

bool	popWindowStack ()

bool	raiseSectionContent (SectionContent *sc)

void	removeFromResetShow (UUID id)

bool	removeSectionContent (SectionContent *sc)

void	resizeEvent (QResizeEvent *event) override

virtual void	setShouldAnimateAdd (bool animate)

void	setTabLock (bool tab_lock)

bool	showSectionContent (SectionContent *sc, PopupInfo start=PopupInfo(), PopupInfo end=PopupInfo())

QSize	sizeHint () const override

void	swapSectionContent (SectionContent section_a, SectionContent section_b)

Protected Member Functions inherited from QCustomStackedWidgetBase
uint04	activeIndex () const

QWidget *	activeWidget () const

virtual uint04	addWidget (QWidget *w)

double	animationPercent () const

uint04	count () const

uint04	currentIndex () const

QWidget *	currentWidget () const

bool	eventFilter (QObject object, QEvent event) override

uint04	indexOf (QWidget *widget) const

void	insertWidget (uint04 index, QWidget *w)

QSize	minimumSizeHint () const override

virtual void	moveContent (uint04 from, uint04 to)

void	paintEvent (QPaintEvent *) override

	QCustomStackedWidgetBase (QWidget *parent=nullptr)

void	removeWidget (QWidget *widget)

void	removeWidget (QWidget widget, QWidget slide_to_if_active)

void	resizeEvent (QResizeEvent *event) override

void	setAnimationPercent (double animation_percent)

virtual void	setCurrentIdx (uint04 current_index)

void	showEvent (QShowEvent *event) override

QSize	sizeHint () const override

virtual void	slideInAnimation (enum StackAnimationDirection direction=e_automatic, bool cache_in_image=false)

virtual void	slideInAnimation (PopupInfo origin_rect, enum StackAnimationDirection direction=e_automatic, bool cache_in_image=false)

virtual void	slideInIdx (uint04 idx, int delay_time=0, enum StackAnimationDirection direction=e_automatic)

virtual void	slideInIdx (uint04 idx, PopupInfo origin_rect, int delay_time=0, enum StackAnimationDirection direction=e_automatic)

virtual void	slideInNext ()

virtual void	slideInPrev ()

virtual void	slideInWgt (QWidget *widget, enum StackAnimationDirection direction=e_automatic, bool force_slide=false)

virtual void	swapIndices (uint04 a, uint04 b)

QWidget *	widget (uint04 index) const

virtual	~QCustomStackedWidgetBase ()

Protected Attributes inherited from ContainerWidgetBase
bool	m_animate_add = true

DropOverlay *	m_drop_overlay

Buffer< std::pair< QPointer< QWidget >, Buffer< QPointer< FloatingWidget > > > >	m_fullscreen_stack

Buffer< std::pair< QPointer< QWidget >, Buffer< QPointer< FloatingWidget > > > >	m_reset_fullscreen_stack

bool	m_reset_is_on_home = false

Buffer< UUID >	m_reset_visible_sections

Dictionary< UUID, SectionContent * >	m_section_content

Dictionary< UUID, SectionWidget * >	m_sections

Buffer< SharedSectionContentArea * >	m_shared_content

SectionWidget *	m_top_section_widget = nullptr

SharedSectionContentArea *	m_top_splitter = nullptr

Protected Attributes inherited from QCustomStackedWidgetBase
double	m_animation_percent

enum QEasingCurve::Type	m_animationtype

Buffer< QWidget * >	m_child_widgets

uint04	m_current_index

bool	m_is_animating

uint04	m_last

int	m_last_animation_time

QPointer< QPropertyAnimation >	m_move_animation

uint04	m_next

uint04	m_now

QPoint	m_offset

PopupInfo	m_popup_info

int	m_speed

bool	m_vertical

bool	m_wrap = false

Properties inherited from QCustomStackedWidgetBase
double	animation_percent

Detailed Description

The UI ribbon is a horizontal menu bar typically located at the top of the application interface or along the side. It organizes commands and tools into tabs and groups for easy access. Each tab contains related functionality, categorized into sections such as File, Edit, View, etc. Within these sections, buttons, dropdowns, and other controls allow users to interact with the application features efficiently. The ribbon improves usability by presenting frequently-used commands in a visually organized manner.

Constructor & Destructor Documentation

◆ Ribbon()

Ribbon ( QWidget * parent = nullptr )

explicit

◆ ~Ribbon()

~Ribbon ( )

Member Function Documentation

◆ addBottomRightWidget()

void addBottomRightWidget ( QWidget * widget )

◆ addGroup() [1/2]

virtual RibbonGroup * addGroup ( const TranslatedString & label )

virtual

Handle window drag events.

◆ addGroup() [2/2]

virtual void addGroup ( RibbonGroup * group )

virtual

◆ addTopLeftWidget()

void addTopLeftWidget ( QWidget * widget )

◆ group() [1/3]

RibbonGroup & group ( const TranslatedString & group_name )

◆ group() [2/3]

const RibbonGroup & group ( const TranslatedString & group_name ) const

◆ group() [3/3]

RibbonGroup & group ( uint04 index )

◆ groupDock() [1/3]

DockWidget< RibbonGroup > * groupDock ( const RibbonGroup * group )

◆ groupDock() [2/3]

DockWidget< RibbonGroup > * groupDock ( const TranslatedString & group_name )

inline

◆ groupDock() [3/3]

DockWidget< RibbonGroup > * groupDock ( uint04 index )

inline

◆ groups()

Dictionary< TranslatedString, DockWidget< RibbonGroup > * > & groups ( )

inline

◆ hasGroup()

virtual bool hasGroup ( const TranslatedString & group ) const

virtual

◆ isVertical()

bool isVertical ( )

inline

◆ minimumSizeHint()

QSize minimumSizeHint ( ) const

override

◆ operator[]()

RibbonGroup & operator[] ( const TranslatedString & location )

inline

◆ removeAllGroups()

virtual void removeAllGroups ( )

virtual

◆ removeGroup() [1/2]

virtual void removeGroup ( const TranslatedString & label )

virtual

◆ removeGroup() [2/2]

virtual void removeGroup ( uint04 index )

virtual

◆ resizeEvent()

void resizeEvent ( QResizeEvent * resize_event )

override

◆ section()

SectionWidget * section ( ) const

◆ setFixedNumOfRows()

void setFixedNumOfRows ( uint01 fixed_num_of_rows )

◆ setGroupName()

void setGroupName	(	uint04	index,
		const TranslatedString &	group_name )

◆ setInverseRibbonArea()

void setInverseRibbonArea ( bool inverse_ribbon_area )

◆ setLayoutMode()

void setLayoutMode ( RibbonLayoutMode mode )

◆ setTabLock()

void setTabLock ( bool tab_lock )

inline

◆ sizeHint()

QSize sizeHint ( ) const

override

◆ slideInIdx()

void slideInIdx	(	uint04	idx,
		enum StackAnimationDirection	direction = StackAnimationDirection::e_automatic )

inlineoverridevirtual

Reimplemented from QCustomStackedWidgetBase.

◆ updateRibbonLayout()

void updateRibbonLayout ( )

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

Widgets/Headers/Ribbon.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ribbon()

◆ ~Ribbon()

Member Function Documentation

◆ addBottomRightWidget()

◆ addGroup() [1/2]

◆ addGroup() [2/2]

◆ addTopLeftWidget()

◆ group() [1/3]

◆ group() [2/3]

◆ group() [3/3]

◆ groupDock() [1/3]

◆ groupDock() [2/3]

◆ groupDock() [3/3]

◆ groups()

◆ hasGroup()

◆ isVertical()

◆ minimumSizeHint()

◆ operator[]()

◆ removeAllGroups()

◆ removeGroup() [1/2]

◆ removeGroup() [2/2]

◆ resizeEvent()

◆ section()

◆ setFixedNumOfRows()

◆ setGroupName()

◆ setInverseRibbonArea()

◆ setLayoutMode()

◆ setTabLock()

◆ sizeHint()

◆ slideInIdx()

◆ updateRibbonLayout()