API Documentation
Loading...
Searching...
No Matches
Ribbon Class Reference

#include <Ribbon.h>

Inheritance diagram for Ribbon:
[legend]
Collaboration diagram for Ribbon:
[legend]

Public Member Functions

 Ribbon (QWidget *parent=nullptr)
 
 ~Ribbon ()
 
bool isVertical ()
 
const RibbonGroupgroup (const TranslatedString &group_name) const
 
void setGroupName (uint04 index, const TranslatedString &group_name)
 
void setInverseRibbonArea (bool inverse_ribbon_area)
 
RibbonGroupgroup (const TranslatedString &group_name)
 
DockWidget< RibbonGroup > * groupDock (const RibbonGroup *group)
 
DockWidget< RibbonGroup > * groupDock (const TranslatedString &group_name)
 
RibbonGroupgroup (uint04 index)
 
DockWidget< RibbonGroup > * groupDock (uint04 index)
 
void updateRibbonLayout ()
 
virtual RibbonGroupaddGroup (const TranslatedString &label)
 Handle window drag events.
 
virtual void addGroup (RibbonGroup *group)
 
virtual void removeGroup (const TranslatedString &label)
 
virtual void removeGroup (uint04 index)
 
virtual void removeAllGroups ()
 
virtual bool hasGroup (const TranslatedString &group) const
 
SectionWidgetsection () const
 
RibbonGroupoperator[] (const TranslatedString &location)
 
void setLayoutMode (RibbonLayoutMode mode)
 
void resizeEvent (QResizeEvent *resize_event) override
 
void setFixedNumOfRows (uint01 fixed_num_of_rows)
 
QSize sizeHint () const override
 
QSize minimumSizeHint () const override
 
Dictionary< TranslatedString, DockWidget< RibbonGroup > * > & groups ()
 
void addTopLeftWidget (QWidget *widget)
 
void addBottomRightWidget (QWidget *widget)
 
void slideInIdx (uint04 idx, enum t_direction direction=t_direction::AUTOMATIC) override
 
void setTabLock (bool tab_lock)
 
- Public Member Functions inherited from ContainerWidgetBase
 ContainerWidgetBase (QWidget *parent=nullptr)
 
virtual ~ContainerWidgetBase ()
 
- Public Member Functions inherited from QCustomStackedWidgetBase
void setSpeed (int speed)
 
void setAnimation (enum QEasingCurve::Type animationtype)
 
void setVerticalMode (bool vertical=true)
 
void setWrap (bool wrap)
 
void setCustomPixmap (QPixmap *pixmap)
 

Protected Member Functions

virtual void _setVertical (bool is_vertical)
 
- Protected Member Functions inherited from ContainerWidgetBase
virtual SectionWidgetaddSectionContent (SectionContent *sc, SectionWidget *sw, DropArea area=e_drop_center)
 
virtual FloatingWidgetaddSectionContent (SectionContent *sc)
 
FloatingWidgetmakeFloating (SectionContent *sc, bool show, PopupInfo start=PopupInfo(), PopupInfo end=PopupInfo())
 
FloatingWidgetmakeFullScreen (SectionContent *sc, PopupInfo start=PopupInfo())
 
bool popWindowStack ()
 
bool hasSectionContent (SectionContent *sc)
 
bool removeSectionContent (SectionContent *sc)
 
void resizeEvent (QResizeEvent *event) override
 
bool showSectionContent (SectionContent *sc, PopupInfo start=PopupInfo(), PopupInfo end=PopupInfo())
 
bool hideSectionContent (SectionContent *sc, PopupInfo end=PopupInfo())
 
bool raiseSectionContent (SectionContent *sc)
 
void bringFloatingWidgetsForward ()
 
void setTabLock (bool tab_lock)
 
void beginResetAll ()
 
void removeFromResetShow (UUID id)
 
void endResetAll ()
 
bool isSectionContentVisible (SectionContent *sc)
 
void swapSectionContent (SectionContent *section_a, SectionContent *section_b)
 
Buffer< SectionContent * > contents () const
 
QRect outerTopDropRect () const
 
QRect outerRightDropRect () const
 
QRect outerBottomDropRect () const
 
QRect outerLeftDropRect () const
 
QSize sizeHint () const override
 
QSize minimumSizeHint () const override
 
DropOverlaydropOverlay ()
 
virtual void setShouldAnimateAdd (bool animate)
 
virtual void clearAllSectionContent ()
 
virtual void clearAllNonFloatingContent ()
 
bool event (QEvent *event) override
 
- Protected Member Functions inherited from QCustomStackedWidgetBase
 QCustomStackedWidgetBase (QWidget *parent=nullptr)
 
virtual ~QCustomStackedWidgetBase ()
 
void resizeEvent (QResizeEvent *event) override
 
void showEvent (QShowEvent *event) override
 
void setAnimationPercent (double animation_percent)
 
double animationPercent () const
 
void paintEvent (QPaintEvent *) override
 
virtual void swapIndices (uint04 a, uint04 b)
 
virtual void moveContent (uint04 from, uint04 to)
 
virtual uint04 addWidget (QWidget *w)
 
void insertWidget (uint04 index, QWidget *w)
 
void removeWidget (QWidget *widget)
 
void removeWidget (QWidget *widget, QWidget *slide_to_if_active)
 
bool eventFilter (QObject *object, QEvent *event) override
 
uint04 activeIndex () const
 
QWidget * activeWidget () const
 
QWidget * currentWidget () const
 
QSize sizeHint () const override
 
QSize minimumSizeHint () const override
 
QWidget * widget (uint04 index) const
 
uint04 indexOf (QWidget *widget) const
 
uint04 currentIndex () const
 
uint04 count () const
 
virtual void setCurrentIdx (uint04 current_index)
 
virtual void slideInNext ()
 
virtual void slideInPrev ()
 
virtual void slideInIdx (uint04 idx, PopupInfo origin_rect, int delay_time=0, enum t_direction direction=AUTOMATIC)
 
virtual void slideInIdx (uint04 idx, int delay_time=0, enum t_direction direction=AUTOMATIC)
 
virtual void slideInAnimation (PopupInfo origin_rect, enum t_direction direction=AUTOMATIC, bool cache_in_image=false)
 
virtual void slideInAnimation (enum t_direction direction=AUTOMATIC, bool cache_in_image=false)
 
virtual void slideInWgt (QWidget *widget, enum t_direction direction=AUTOMATIC, bool force_slide=false)
 

Protected Attributes

bool m_is_vertical
 
bool m_inverse_ribbon_area
 
RibbonLayoutMode m_layout_mode
 
uint01 m_fixed_num_of_rows
 
Dictionary< TranslatedString, DockWidget< RibbonGroup > * > m_groups
 
Buffer< DockWidget< RibbonGroup > * > m_index_groups
 
Buffer< QPointer< QWidget > > m_top_left_widgets
 
Buffer< QPointer< QWidget > > m_bottom_right_widgets
 
Buffer< TranslatedStringm_index_names
 
- Protected Attributes inherited from ContainerWidgetBase
Dictionary< UUID, SectionWidget * > m_sections
 
Dictionary< UUID, SectionContent * > m_section_content
 
SharedSectionContentAream_top_splitter = nullptr
 
DropOverlaym_drop_overlay
 
SectionWidgetm_top_section_widget = nullptr
 
Buffer< SharedSectionContentArea * > m_shared_content
 
Buffer< std::pair< QPointer< QWidget >, Buffer< QPointer< FloatingWidget > > > > m_fullscreen_stack
 
Buffer< std::pair< QPointer< QWidget >, Buffer< QPointer< FloatingWidget > > > > m_reset_fullscreen_stack
 
Buffer< UUIDm_reset_visible_sections
 
bool m_animate_add = true
 
bool m_reset_is_on_home = false
 
- Protected Attributes inherited from QCustomStackedWidgetBase
int m_speed
 
enum QEasingCurve::Type m_animationtype
 
uint04 m_now
 
uint04 m_next
 
uint04 m_last
 
int m_last_animation_time
 
QPoint m_offset
 
PopupInfo m_popup_info
 
double m_animation_percent
 
uint04 m_current_index
 
Buffer< QWidget * > m_child_widgets
 
QPointer< QPropertyAnimation > m_move_animation
 
bool m_is_animating
 
bool m_vertical
 
bool m_wrap = false
 

Additional Inherited Members

- Public Types inherited from QCustomStackedWidgetBase
enum  t_direction {
  LEFT2RIGHT , RIGHT2LEFT , TOP2BOTTOM , BOTTOM2TOP ,
  AUTOMATIC
}
 
- Signals inherited from QCustomStackedWidgetBase
void animationFinished ()
 
- Static Public Attributes inherited from QCustomStackedWidgetBase
static ApplicationOption< sint04default_stack_animation_speed
 
- Protected Slots inherited from QCustomStackedWidgetBase
void childDestroyedSlot (QObject *widget)
 
void animationDoneSlot ()
 
- Properties inherited from QCustomStackedWidgetBase
double animation_percent
 

Constructor & Destructor Documentation

◆ Ribbon()

Ribbon ( QWidget * parent = nullptr)
explicit

◆ ~Ribbon()

~Ribbon ( )

Member Function Documentation

◆ _setVertical()

void _setVertical ( bool is_vertical)
protectedvirtual

◆ addBottomRightWidget()

void addBottomRightWidget ( QWidget * widget)

◆ addGroup() [1/2]

RibbonGroup * addGroup ( const TranslatedString & label)
virtual

Handle window drag events.

◆ addGroup() [2/2]

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()

bool hasGroup ( const TranslatedString & group) const
virtual

◆ isVertical()

bool isVertical ( )
inline

◆ minimumSizeHint()

QSize minimumSizeHint ( ) const
override

◆ operator[]()

RibbonGroup & operator[] ( const TranslatedString & location)
inline

◆ removeAllGroups()

void removeAllGroups ( )
virtual

◆ removeGroup() [1/2]

void removeGroup ( const TranslatedString & label)
virtual

◆ removeGroup() [2/2]

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 t_direction direction = t_direction::AUTOMATIC )
inlineoverridevirtual

Reimplemented from QCustomStackedWidgetBase.

◆ updateRibbonLayout()

void updateRibbonLayout ( )

Member Data Documentation

◆ m_bottom_right_widgets

Buffer<QPointer<QWidget> > m_bottom_right_widgets
protected

◆ m_fixed_num_of_rows

uint01 m_fixed_num_of_rows
protected

◆ m_groups

◆ m_index_groups

Buffer<DockWidget<RibbonGroup>*> m_index_groups
protected

◆ m_index_names

Buffer<TranslatedString> m_index_names
protected

◆ m_inverse_ribbon_area

bool m_inverse_ribbon_area
protected

◆ m_is_vertical

bool m_is_vertical
protected

◆ m_layout_mode

RibbonLayoutMode m_layout_mode
protected

◆ m_top_left_widgets

Buffer<QPointer<QWidget> > m_top_left_widgets
protected

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