omni::ui::proj::TuningLayout Class Reference

Tuning Layout Similar to VBoxLayout, except that widgets with a PREVIEW Role have a size with aspect ratio of associated tuning. More...

#include <TuningLayout.h>

Inheritance diagram for omni::ui::proj::TuningLayout:

Collaboration diagram for omni::ui::proj::TuningLayout:

Data Structures
struct	ItemWrapper

Public Types
enum	Role { Role::TITLE, Role::PARAMETER, Role::PREVIEW }
	Role of a widget defines resize behaviour. More...
typedef std::vector< std::pair < QWidget *, Role > >	widgetgroup_type

Public Member Functions
	TuningLayout (Tuning *parent)
	~TuningLayout ()
void	addItem (QLayoutItem *item)
	Add item, with PARAMETER Role. More...
void	addWidget (QWidget *widget)
	Add widget with PARAMETER Role. More...
void	addWidget (QWidget *widget, Role)
	Add widget with Role. More...
int	count () const
	Return number of widgets. More...
int	indexOf (QWidget *widget) const
	Get index of given widget. More...
QLayoutItem *	itemAt (int index) const
	Return item at index. More...
QLayoutItem *	takeAt (int index)
	Remove widget at index. More...
void	setGeometry (const QRect &rect)
	Set geometry of all widgets. More...
QRect	geometry () const
void	setWidgets (widgetgroup_type const &_widgets)
	Clears layout and inserts the given widgets. More...
void	clear ()
	Clear layout. More...
QSize	minimumSize () const
	Return minimum size. More...
QSize	sizeHint () const
	Return size hint, is equal to minimum size. More...

Private Types
enum	SizeType { MINIMUMSIZE, SIZEHINT }

Private Member Functions
omni::proj::Tuning *	tuning ()
omni::proj::Tuning const *	tuning () const
void	add (QLayoutItem *_item, Role _role)
	Add a layout item with Role. More...
QSize	calculateSize (SizeType sizeType) const

Private Attributes
std::vector< ItemWrapper >	items_

Detailed Description

Tuning Layout Similar to VBoxLayout, except that widgets with a PREVIEW Role have a size with aspect ratio of associated tuning.

Member Typedef Documentation

typedef std::vector<std::pair<QWidget *, Role> > omni::ui::proj::TuningLayout::widgetgroup_type

Member Enumeration Documentation

enum omni::ui::proj::TuningLayout::Role

strong

Role of a widget defines resize behaviour.

Enumerator
TITLE
PARAMETER
PREVIEW

                          {
            TITLE,     // Fixed size
            PARAMETER, // Fixed size
            PREVIEW    // Size with aspect ratio of tuning
          };

enum omni::ui::proj::TuningLayout::SizeType

private

Enumerator
MINIMUMSIZE
SIZEHINT

{ MINIMUMSIZE, SIZEHINT };

Constructor & Destructor Documentation

omni::ui::proj::TuningLayout::TuningLayout

(

Tuning *

parent

)

                                                :
        QLayout(_parent)
      {}

omni::ui::proj::TuningLayout::~TuningLayout

(

)

      {
        clear();
      }

Member Function Documentation

void omni::ui::proj::TuningLayout::add ( QLayoutItem *  _item, Role  _role  )

private

Add a layout item with Role.

      {
        items_.emplace_back(_item, _role);
        invalidate();
      }

void omni::ui::proj::TuningLayout::addItem

(

QLayoutItem *

item

)

Add item, with PARAMETER Role.

      {
        add(_item, Role::PARAMETER);
      }

void omni::ui::proj::TuningLayout::addWidget

(

QWidget *

widget

)

Add widget with PARAMETER Role.

      {
        add(new QWidgetItem(widget), Role::PARAMETER);
      }

void omni::ui::proj::TuningLayout::addWidget	(	QWidget *	widget,
		Role	_role
	)

Add widget with Role.

      {
        add(new QWidgetItem(widget), _role);
      }

QSize omni::ui::proj::TuningLayout::calculateSize ( SizeType  sizeType ) const

private

Increase height by aspect ratio

      {
        if (!tuning()) return QSize(0, 0);


        int _border = 2;
        int _width  = 0;
        int _height = _border;

        auto _parent = static_cast<Tuning *>(parent());

        for (auto& _item : items_)
        {
          switch (_item.role_)
          {
          case Role::PARAMETER:
          case Role::TITLE:
            _height += 36 / _parent->devicePixelRatio();
            break;

          case Role::PREVIEW:

            if (!tuning()) continue;

            /// Increase height by aspect ratio
            _height += _parent->width() /
                       float(tuning()->width()) * tuning()->height();
            break;
          }
        }
        _height += _border;

        return QSize(_width, _height);
      }

void omni::ui::proj::TuningLayout::clear

(

)

Clear layout.

      {
        QLayoutItem *l;

        while ((l = takeAt(0))) delete l;
      }

int omni::ui::proj::TuningLayout::count

(

)

const

Return number of widgets.

      {
        return items_.size();
      }

QRect omni::ui::proj::TuningLayout::geometry

(

)

const

                                         {
        auto _rect = QLayout::geometry();

        _rect.setWidth(_rect.width() - 16);
        return _rect;
      }

int omni::ui::proj::TuningLayout::indexOf

(

QWidget *

widget

)

const

Get index of given widget.

      {
        int _index = -1;

        for (auto& _item : items_)
        {
          if (_item.widget() == widget) return _index;

          ++_index;
        }
        return _index;
      }

QLayoutItem * omni::ui::proj::TuningLayout::itemAt

(

int

index

)

const

Return item at index.

      {
        return (index >= 0 &&
                index < items_.size()) ? items_[index].item_ : nullptr;
      }

QSize omni::ui::proj::TuningLayout::minimumSize

(

)

const

Return minimum size.

      {
        return calculateSize(MINIMUMSIZE);
      }

void omni::ui::proj::TuningLayout::setGeometry

(

const QRect &

rect

)

Set geometry of all widgets.

Adjust geometry for each widget

Widget height is constant except for preview

Increase height

      {
        if (!tuning()) return;

        const int _border = 2;
        int _height       = _border;

        auto _parent = static_cast<Tuning *>(parent());

        /// Adjust geometry for each widget
        for (auto& _item : items_)
        {
          auto _widget = _item.widget();

          /// Widget height is constant except for preview
          int _widgetHeight = _item.role_ == Role::PREVIEW ? _parent->width() /
                              float(tuning()->width()) * tuning()->height() :
                              36 / _parent->devicePixelRatio();
          _widget->setGeometry(_border, _height,
                               _parent->width() - _border * 2, _widgetHeight);
          _widget->show();

          /// Increase height
          _height += _widgetHeight;
        }
      }

void omni::ui::proj::TuningLayout::setWidgets

(

widgetgroup_type const &

_widgets

)

Clears layout and inserts the given widgets.

      {
        clear();

        for (auto& _widgetRole : _widgets)
        {
          auto& _widget = _widgetRole.first;
          auto& _role   = _widgetRole.second;
          addWidget(_widget, _role);
        }
        update();
      }

QSize omni::ui::proj::TuningLayout::sizeHint

(

)

const

Return size hint, is equal to minimum size.

      {
        return calculateSize(SIZEHINT);
      }

QLayoutItem * omni::ui::proj::TuningLayout::takeAt

(

int

index

)

Remove widget at index.

      {
        QLayoutItem *_item = itemAt(index);

        if (_item)
        {
          items_.erase(items_.begin() + index);
          return _item;
        }
        return nullptr;
      }

omni::proj::Tuning * omni::ui::proj::TuningLayout::tuning ( )

private

      {
        return static_cast<Tuning *>(parent())->tuning();
      }

omni::proj::Tuning const * omni::ui::proj::TuningLayout::tuning ( ) const

private

      {
        return static_cast<Tuning const *>(parent())->tuning();
      }

Field Documentation

std::vector<ItemWrapper> omni::ui::proj::TuningLayout::items_

private

---

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

• src/app/proj/TuningLayout.h
• src/app/proj/TuningLayout.cpp