MultiViewWidget Class Reference

#include <MultiViewWidget.h>

Inherits QWidget.

Public Slots
void	updateView ()
void	addWidget (const QString &name, QWidget *widget, const QIcon &icon=QIcon(), bool useOnlyIcon=false, int position=0)
QWidget *	getWidget (const QString &name)
void	deleteWidget (const QString &name)
void	widgetClicked ()
void	setThumbnailSize (int width=150, int height=150)
WidgetButton *	getButtonForWidget (QWidget *widget)
QList< WidgetButton * >	getAllWidgetButtons ()
void	setDesignerMode (bool designerMode)

Signals
void	widgetButtonAdded (QWidget *widget)

Public Member Functions
	MultiViewWidget (QWidget *parent)
virtual	~MultiViewWidget ()
void	childEvent (QChildEvent *event)
bool	event (QEvent *event)
bool	isDesignerMode ()
void	fixStatus ()

Protected Attributes
QHash< QString, WidgetButton * >	widgets
QGridLayout	layout
QHBoxLayout *	top
QHBoxLayout *	bottom
QVBoxLayout *	left
QVBoxLayout *	mid
QVBoxLayout *	right
WidgetButton *	currentWidget
int	thumbnailWidth
int	thumbnailHeight
QWidget *	pseudoWidget
bool	initialized
int	currentWidgetIndex
bool	clicking
bool	designerMode
QTimer	timer

Detailed Description

Widget which displays other widgets. All added widgets will be displayed as thumbnails either left, right, on top or below one widget. Thumbnail Widgets can be clicked to show in the main potion of the screen. S one widget will be the "active" widget which takes most of the sapce within the widget all other widgets will be displayed as small widget in one of the positions as mentioned above.
If there are any changes to an added widget, the thumnail will blink in red. This only works if the added widget has a notifyUpdate(int) signal. The signal will automatically be taken into account via the qt meta object infrastructure. The currently selected widget will be displayed with a name and is colorized in green to indicate selection.
The size and orientation of the thumbnails can be configurede via the methods setThumbnailPosition(int) and setThumnailSize(int, int).
If the widget is too time consuming or can not be properly displayed when being small one can either only show the widgets name or alternatively an icon.
The widget will try to resize teh viewable center widget as large as it can. If this is not the desired behaviour setting a fixed or maximum size will work properly, so the widget will not stretch to more than the given sizes.

Author

Bjoern Lueck bluec.nosp@m.k@df.nosp@m.ki.de

Version

0.1

Definition at line 45 of file MultiViewWidget.h.

Constructor & Destructor Documentation

MultiViewWidget()

MultiViewWidget::MultiViewWidget

(

QWidget *

parent

)

Constructor

Parameters

parent

parentWidget will be given to QWidgets constructor

Definition at line 24 of file MultiViewWidget.cc.

                                                : QWidget(parent)
{
    initialized = false;
    currentWidget = NULL;
    pseudoWidget = NULL;
    designerMode = false;
    clicking = false;
    currentWidgetIndex = 0;
    thumbnailWidth = 150;
    thumbnailHeight = 150;
    

    top = new QHBoxLayout();
    bottom = new QHBoxLayout();
    left = new QVBoxLayout();
    mid = new QVBoxLayout();
    right = new QVBoxLayout();
    setLayout(&layout);
    initialized=true;       
        
        
    layout.update();
    layout.activate();

}

~MultiViewWidget()

MultiViewWidget::~MultiViewWidget ( )

virtual

Destructor

Todo:

implement correctly

Definition at line 50 of file MultiViewWidget.cc.

{
}

Member Function Documentation

addWidget

void MultiViewWidget::addWidget ( const QString &  name, QWidget *  widget, const QIcon &  icon = QIcon(), bool  useOnlyIcon = false, int  position = 0  )

slot

Adds a widget and a thumbnail to the widget

Parameters

name	the name given to the widget, must be unique.
widget	teh widget to add
icon	an icon as alternative for text or the wisget itself
useOnlyIcon	if only the icon and or text shall be displayed as thumbnail and NOT the widget

Definition at line 116 of file MultiViewWidget.cc.

{
        QWidget *widget = widget_;
   
#if 0 //Not possible because ruby qt don't initialize all components as QWidget so we have no chance to get the right obect at this point
        //Try cast the QT way
        MultiWidget *w = qobject_cast<MultiWidget*>(widget_);
        if(w){
            widget= w;
            printf("Cast sucsessful\n");
        }else{
            //MultiWidget *bla = (MultiWidget*) widget_;
            printf("ARGHHHH: %s Name: %s \n",typeid(widget).name(),widget->objectName().toStdString().c_str());
            
            printf("QT Means: %s\n",widget->metaObject()->className());
            const QMetaObject *o = widget->metaObject();
            for(int i=0; i<o->methodCount(); i++){
                printf("Method found: %s\n",o->method(i).signature());
            }
            printf("\n\n");
            //printf("Got one: %s \n",bla->getMinimizedLabel().toStdString().c_str());
            //printf("Cast failed\n");
        }
#endif

        
    if(widgets.contains(name))
    {
       std::cerr << "A Widget with the name: [" << name.toStdString() << "] already exists!" << std::endl;
       return;
    }
    WidgetButton* widgetButton=0;

    switch(position){
        case WidgetButton::Left:
        case WidgetButton::Right:
            widgetButton = new WidgetButton(0,Qt::Vertical,thumbnailWidth, thumbnailHeight);
            break;
        case WidgetButton::Top:
        case WidgetButton::Bottom:
        default:
            widgetButton = new WidgetButton(0,Qt::Horizontal,thumbnailWidth, thumbnailHeight);
            break;
    }

    //widgetButton->setFixedSize(thumbnailWidth, thumbnailHeight);
    widgetButton->setIconAlternative(icon, useOnlyIcon);

    
    // show the widget if its the only one
    if(widgets.size() == 0)
    {
        widgetButton->setWidget(name, widget, false);
        widgets.insert(name, widgetButton);
        mid->addWidget(widget);
        currentWidget = widgetButton;
    }
    else
    {
        widgetButton->setWidget(name, widget);
    }

    widgets.insert(name, widgetButton);
    //left->addWidget(widgetButton);

        
    if(position != WidgetButton::Default){
        switch(position){
        case WidgetButton::Left:
                left->addWidget(widgetButton);
                break;
        case WidgetButton::Right:
                right->addWidget(widgetButton);
                break;
        case WidgetButton::Top:
                top->addWidget(widgetButton);
                break;
        case WidgetButton::Bottom:
                bottom->addWidget(widgetButton);
                break;
        }
    }else{
        switch(currentWidget->getPosition())
        {
            case WidgetButton::Left:
                left->addWidget(widgetButton);
                break;
            case WidgetButton::Right:
                right->addWidget(widgetButton);
                break;
            case WidgetButton::Bottom:
                bottom->addWidget(widgetButton);
                break;
            case WidgetButton::Top:
                top->addWidget(widgetButton);
                break;
        }
    }
                
    connect(widgetButton, SIGNAL(clicked()), this, SLOT(widgetClicked()));
    emit widgetButtonAdded(widgetButton);
    updateView();

    timer.setSingleShot(true);
    timer.start(500);
    connect(&timer,SIGNAL(timeout()),this,SLOT(fixStatus()));
}

childEvent()

void MultiViewWidget::childEvent

(

QChildEvent *

event

)

Handles the events when a widget is added to or removed from the widget. This will not do anything when used in standalone mode, but will be used heavily when used in the qt designer.
When adding a widget to or removing a widget from the MultiViewWidget from within QTDesigner the childEvent method will map them to the corresponding methods within the MultiViewWidget. Thus enabling the widget to perform within the qt designer as container with teh desired functionality.
Note the only thing which does not work is the thumbnail widgets. Widgets will not be displayed as thumbnails within the designer, as the designer needs ownership of those. In Designer's preview everything will act asexpected

Definition at line 271 of file MultiViewWidget.cc.

{
    //QWidget::childEvent(event);
    if(initialized)
    {
        
        if(event->type() == QChildEvent::ChildAdded)
        {
            if(!clicking)
            {
                if(event->child()->isWidgetType())
                {
                    // we never need to watch adding of widgetbuttons, then everything went well already
                    WidgetButton* testButton = dynamic_cast<WidgetButton*> (event->child());
                    if(testButton != NULL)
                    {
                        return;
                    }
                    // we never want to add a widget which is already added
                    QWidget* child = (QWidget*)event->child();
                if(child->windowTitle().isEmpty())
                        addWidget(QString::number(currentWidgetIndex), child);
            else
                        addWidget(child->windowTitle(), child);
            currentWidgetIndex++;
                }
            }
        }
        else if(event->type() == QChildEvent::ChildRemoved)
        {
            if(!clicking)
            {
                if(event->child()->isWidgetType())
                {
                    // look which widget was removed and remove the button also
                    QWidget* child = (QWidget*)event->child();
                    QList<QString> keys = widgets.keys();
                    for(int i=0;i<keys.size();i++)
                    {
                        WidgetButton* button = widgets[keys[i]];
                        if(button->getWidget() == child)
                        {
                            widgets.remove(keys[i]);
                            QWidget* widget = button->getWidget();
                            layout.removeWidget(widget);
                            mid->removeWidget(button);
                            left->removeWidget(button);
                            right->removeWidget(button);
                            bottom->removeWidget(button);
                            top->removeWidget(button);
                            widget = NULL;
                            return;
                        }
                    }
                }
            }
        }
    }
}

deleteWidget

void MultiViewWidget::deleteWidget ( const QString &  name )

slot

Removes the widget with the given name. This will DELETE the widget that was added with that name!!

Parameters

name	the anme of the widget to remove

Definition at line 242 of file MultiViewWidget.cc.

{
    if(widgets.contains(name))
    {
        WidgetButton* button = widgets[name];
        widgets.remove(name);
        QWidget* widget = button->getWidget();
        layout.removeWidget(widget);
        mid->removeWidget(button);
        top->removeWidget(button);
        left->removeWidget(button);
        right->removeWidget(button);
        bottom->removeWidget(button);
        delete button;
    }
        updateView();
}

event()

bool MultiViewWidget::event

(

QEvent *

event

)

Definition at line 260 of file MultiViewWidget.cc.

{
    if(event->type() == QEvent::ToolTip)
    {
        QToolTip::hideText();
        event->ignore();
        return true;
    }
    return QWidget::event(event);
}

fixStatus()

void MultiViewWidget::fixStatus

(

)

Fix the Status (names and view Style of all Widgets, this cannot be done during adding because rubyqt says all widets are QWidget

Definition at line 224 of file MultiViewWidget.cc.

                               {
    QList<WidgetButton*> list = getAllWidgetButtons(); 
    for(int i=0;i<list.size();i++){
        if(list[i] == currentWidget){
            list[i]->setActive(true);
        }else{
            list[i]->setActive(false);
        }
        list[i]->corrcetName();
    }
}

getAllWidgetButtons

QList< WidgetButton * > MultiViewWidget::getAllWidgetButtons ( )

slot

Returns all Buttons

Returns

all Buttons as QList

Definition at line 331 of file MultiViewWidget.cc.

{
    return widgets.values();
}

getButtonForWidget

WidgetButton * MultiViewWidget::getButtonForWidget ( QWidget *  widget )

slot

Returns the widget which is shown on the Button

Parameters

widget

the widget for which the button shall be returned

Returns

the button for the given widget

Definition at line 102 of file MultiViewWidget.cc.

{
    QList<QString> keys = widgets.keys();
    for(int i=0;i<keys.size();i++)
    {
        WidgetButton* button = widgets[keys[i]];
        if(button->getWidget() == widget)
        {
            return button;
        }
    }
    return NULL;
}

getWidget

QWidget * MultiViewWidget::getWidget ( const QString &  name )

slot

Return sthe widget for the given name

Parameters

name	the name of the widget to return given when added via addWidget

Returns

the widget which was added with the given name

Todo:

implement correctly

Definition at line 237 of file MultiViewWidget.cc.

{
    return widgets.value(name)->getWidget();
}

isDesignerMode()

bool MultiViewWidget::isDesignerMode ( )

inline

Returns whether designer mode is enabled

Returns

if designer mode is enabled

Definition at line 146 of file MultiViewWidget.h.

{ return designerMode; };

setDesignerMode

void MultiViewWidget::setDesignerMode ( bool  designerMode )

inlineslot

Sets whether designer mode is enabled (no small widgets) NOTE: You should normally never have to call this manually

Parameters

designerMode

true if the designer is shown, false otherwise

Definition at line 140 of file MultiViewWidget.h.

{ this->designerMode = designerMode; };

setThumbnailSize

void MultiViewWidget::setThumbnailSize ( int  width = 150, int  height = 150  )

slot

Sets the size of teh thumbnail widgets. Defaults the thumbnails to 150x150.

Parameters

width	teh width of the thumbnails, defaults to 150
height	the height of the thumbnails defaults to 150

Definition at line 96 of file MultiViewWidget.cc.

{
    thumbnailWidth = width;
    thumbnailHeight = height;
}

updateView

void MultiViewWidget::updateView ( )

slot

Definition at line 55 of file MultiViewWidget.cc.

                                {
        int midStart = 1;
        int centerWidth = 3;

        if(top->count() == 0){
            layout.removeItem(top);
            midStart-=1;
        }else{
            centerWidth++;
            layout.addLayout(top,0,0,1,3);
        }

        
        if(right->count() > 0){
            centerWidth--;
            layout.removeItem(right);
            layout.addLayout(right,midStart,2,1,1);
        }else{
            layout.removeItem(right);
        }

        if(left->count() > 0){
            layout.removeItem(mid);
            centerWidth--;
            layout.addLayout(left,midStart,0,1,1);
            layout.addLayout(mid,midStart,1,1,centerWidth);
        }else{
            layout.removeItem(left);
            layout.removeItem(mid);
            layout.addLayout(mid,midStart,0,1,centerWidth);
        }


        if(bottom->count() > 0){
            layout.addLayout(bottom,midStart+1,0,1,3);
        }else{
            layout.removeItem(bottom);
        }
                layout.update();
}

widgetButtonAdded

void MultiViewWidget::widgetButtonAdded ( QWidget *  widget )

signal

Emitted when a new widget is added

Parameters

widget

the widget which was added to the MultiWidget

widgetClicked

void MultiViewWidget::widgetClicked ( )

slot

Called when a thumbnail was clicked

Definition at line 336 of file MultiViewWidget.cc.

{
    clicking = true;

    WidgetButton *sender = dynamic_cast<WidgetButton*>(QObject::sender());
    if(sender <= 0){
        fprintf(stderr,"FATAL: Cannot Handle unknown Widget %s:%i\n",__FILE__,__LINE__);
        return;
    }

    //sender->printStatus();
    sender->showWidget(false);
    QWidget* widget = sender->getWidget();
/*
    if(designerMode)
    {
        QList<WidgetButton*> buttons = getAllWidgetButtons();
        for(int i=0;i<buttons.size();i++)
        {
            if(sender != buttons[i])
            {
                buttons[i]->getWidget()->setMaximumSize(0, 0);
            }
            else
            {
                buttons[i]->getWidget()->setMaximumSize(1000000, 1000000);
            }

        }
    }
        */
    widget->setEnabled(true);

    currentWidget->setActive(false);
    sender->setActive(true);

    mid->removeWidget(currentWidget->getWidget());
    mid->addWidget(widget);
    
    currentWidget = sender;
    QList<QString> keys = widgets.keys();
    for(int i=0;i<keys.size();i++)
    {
        WidgetButton* button = widgets.value(keys[i]);
        if(button != sender)
        {
            button->showWidget(true);
        }
    }

    /*  
    // try to be stupid and use an arbitary large number
    // this is NOT a good solution, if you've got a better one....
    if(currentWidget->getWidget()->maximumHeight() < 1000000 || currentWidget->getWidget()->maximumWidth() < 1000000)
    {
        // no breaks in left and right are ON PURPOSE
        switch(currentWidget->getPosition())
        {
            case WidgetButton::Left:
            {
                center.setColumnStretch(3, 10);
            }
            case WidgetButton::Right:
            {
                layout.setColumnStretch(0, 10);
            }
            case WidgetButton::Top:
            {
                layout.setRowStretch(3, 10);
                break;
            }
            case WidgetButton::Bottom:
            {
                layout.setRowStretch(0, 10);
                break;
            }
        }
    }
    else
    {
        switch(currentWidget->getPosition())
        {
            case WidgetButton::Left:
            {
                layout.setColumnStretch(3, 0);
            }
            case WidgetButton::Right:
            {
                layout.setColumnStretch(0, 0);
            }
            case WidgetButton::Top:
            {
                layout.setRowStretch(3, 0);
                break;
            }
            case WidgetButton::Bottom:
            {
                layout.setRowStretch(0, 0);
                break;
            }
        }
    }
    */  
    clicking = false;
//    repaint();
}

Member Data Documentation

bottom

QHBoxLayout * MultiViewWidget::bottom

protected

Definition at line 176 of file MultiViewWidget.h.

clicking

bool MultiViewWidget::clicking

protected

if a widget was clicked and the widgetClicked method is currently processing

Definition at line 194 of file MultiViewWidget.h.

currentWidget

WidgetButton* MultiViewWidget::currentWidget

protected

The widget currently displayed in the center part of the widget

Definition at line 180 of file MultiViewWidget.h.

currentWidgetIndex

int MultiViewWidget::currentWidgetIndex

protected

The current index for use with qt designer. automatically gives numbers instead of names

Definition at line 192 of file MultiViewWidget.h.

designerMode

bool MultiViewWidget::designerMode

protected

Whether the designer mode is enabled

Definition at line 196 of file MultiViewWidget.h.

initialized

bool MultiViewWidget::initialized

protected

Whether the view is already initialized

Definition at line 190 of file MultiViewWidget.h.

layout

QGridLayout MultiViewWidget::layout

protected

Main layout

Definition at line 174 of file MultiViewWidget.h.

left

QVBoxLayout* MultiViewWidget::left

protected

Definition at line 177 of file MultiViewWidget.h.

mid

QVBoxLayout * MultiViewWidget::mid

protected

Definition at line 177 of file MultiViewWidget.h.

pseudoWidget

QWidget* MultiViewWidget::pseudoWidget

protected

Widget for Layouting purposes

Definition at line 187 of file MultiViewWidget.h.

right

QVBoxLayout * MultiViewWidget::right

protected

Definition at line 177 of file MultiViewWidget.h.

thumbnailHeight

int MultiViewWidget::thumbnailHeight

protected

The height of thumbnails

Definition at line 185 of file MultiViewWidget.h.

thumbnailWidth

int MultiViewWidget::thumbnailWidth

protected

The width of thumbnails

Definition at line 183 of file MultiViewWidget.h.

timer

QTimer MultiViewWidget::timer

protected

Workaround to fix Ruby initialization, the widgets are not recognized well

Definition at line 199 of file MultiViewWidget.h.

top

QHBoxLayout* MultiViewWidget::top

protected

Definition at line 176 of file MultiViewWidget.h.

widgets

QHash<QString, WidgetButton*> MultiViewWidget::widgets

protected

Adds the menu to the widget, currently its only use is to have a testing environmentAll thumbnails and widgets added

Definition at line 172 of file MultiViewWidget.h.

---

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

• /build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/multi_view/MultiViewWidget.h
• /build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/multi_view/MultiViewWidget.cc