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

manages a series of SectionContent that can share the same space or lay out in various patterns including as floating windows used within NDEVR API Widget Docking system. While the NDEVR API Widget Docking system allows widgets to be floating, they must still subrscribe to a ContainerWidgetBase which acts as a parent window and, if necessary, causes the widget to rejoin the Container. When asked for being displayed full-screen, the widget will take over the complete space of the ContainerWidgetBase. A ContainerWidgetBase inherits from QCustomStackedWidgetBase which which is only used when a widget wants to go fullscreen. Othewise it is always on index 0 which contains the section content in the specified layout. More...

#include <ContainerWidget.h>

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

Public Member Functions

void clearAllSectionContent () override
 
 ContainerWidget (QWidget *parent=nullptr)
 
void setShouldAnimateAdd (bool animate) 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 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< sint04default_stack_animation_speed
 
- Protected Slots inherited from QCustomStackedWidgetBase
void animationDoneSlot ()
 
void childDestroyedSlot (QObject *widget)
 
- Protected Member Functions inherited from ContainerWidgetBase
virtual FloatingWidgetaddSectionContent (SectionContent *sc)
 
virtual SectionWidgetaddSectionContent (SectionContent *sc, SectionWidget *sw, DropArea area=e_drop_center)
 
void beginResetAll ()
 
void bringFloatingWidgetsForward ()
 
virtual void clearAllNonFloatingContent ()
 
Buffer< SectionContent * > contents () const
 
DropOverlaydropOverlay ()
 
void endResetAll ()
 
bool event (QEvent *event) override
 
bool hasSectionContent (SectionContent *sc)
 
bool hideSectionContent (SectionContent *sc, PopupInfo end=PopupInfo())
 
bool isSectionContentVisible (SectionContent *sc)
 
FloatingWidgetmakeFloating (SectionContent *sc, bool show, PopupInfo start=PopupInfo(), PopupInfo end=PopupInfo())
 
FloatingWidgetmakeFullScreen (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
 
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, enum StackAnimationDirection direction)
 
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
 
DropOverlaym_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< UUIDm_reset_visible_sections
 
Dictionary< UUID, SectionContent * > m_section_content
 
Dictionary< UUID, SectionWidget * > m_sections
 
Buffer< SharedSectionContentArea * > m_shared_content
 
SectionWidgetm_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

manages a series of SectionContent that can share the same space or lay out in various patterns including as floating windows used within NDEVR API Widget Docking system. While the NDEVR API Widget Docking system allows widgets to be floating, they must still subrscribe to a ContainerWidgetBase which acts as a parent window and, if necessary, causes the widget to rejoin the Container. When asked for being displayed full-screen, the widget will take over the complete space of the ContainerWidgetBase. A ContainerWidgetBase inherits from QCustomStackedWidgetBase which which is only used when a widget wants to go fullscreen. Othewise it is always on index 0 which contains the section content in the specified layout.


Constructor & Destructor Documentation

◆ ContainerWidget()

ContainerWidget ( QWidget * parent = nullptr)
inline

Member Function Documentation

◆ clearAllSectionContent()

void clearAllSectionContent ( )
inlineoverridevirtual

Reimplemented from ContainerWidgetBase.

◆ setShouldAnimateAdd()

void setShouldAnimateAdd ( bool animate)
inlineoverridevirtual

Reimplemented from ContainerWidgetBase.

◆ setTabLock()

void setTabLock ( bool tab_lock)
inline

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