omni::ui::mixin::ParameterWidget< WIDGET > Class Template Reference

Setup and remove a parameter widget for a certain plugin interface. More...

#include <ParameterWidget.h>

Public Types
typedef WIDGET	widget_type

Public Member Functions
template<typename PARENT_WIDGET >
void	removeParameterWidget (PARENT_WIDGET *_widget)
	Remove parameter widget from given widget. More...
template<typename PARENT_WIDGET , typename INTERFACE >
bool	setupParameterWidget (PARENT_WIDGET *_widget, INTERFACE *_interface)
	Setup widget for interface and place it onto widget. More...
widget_type *	parameterWidget ()
	Return pointer to parameterWidget. More...

Private Member Functions
virtual void	parameterWidgetSetupOptions (widget_type *_paramWidget) const
	Additional options. Is called during setup process. More...

Private Attributes
widget_type *	parameterWidget_ = nullptr

Detailed Description

template<typename WIDGET = QWidget>
class omni::ui::mixin::ParameterWidget< WIDGET >

Setup and remove a parameter widget for a certain plugin interface.

Template Parameters

Base	class of parameter widget Interface can be a mapping, canvas or input interface

Member Typedef Documentation

template<typename WIDGET = QWidget>

typedef WIDGET omni::ui::mixin::ParameterWidget< WIDGET >::widget_type

Member Function Documentation

template<typename WIDGET = QWidget>

widget_type* omni::ui::mixin::ParameterWidget< WIDGET >::parameterWidget ( )

inline

Return pointer to parameterWidget.

                                                {
            return parameterWidget_;
          }

template<typename WIDGET = QWidget>

virtual void omni::ui::mixin::ParameterWidget< WIDGET >::parameterWidgetSetupOptions ( widget_type *  _paramWidget ) const

inlineprivatevirtual

Additional options. Is called during setup process.

Reimplemented in omni::ui::Input.

                {}

template<typename WIDGET = QWidget>

template<typename PARENT_WIDGET >

void omni::ui::mixin::ParameterWidget< WIDGET >::removeParameterWidget ( PARENT_WIDGET *  _widget )

inline

Remove parameter widget from given widget.

                                                                    {
            if (parameterWidget_) {
              _widget->layout()->removeWidget(parameterWidget_);
              parameterWidget_->hide();
              parameterWidget_->deleteLater();
              parameterWidget_ = nullptr;
            }
          }

template<typename WIDGET = QWidget>

template<typename PARENT_WIDGET , typename INTERFACE >

bool omni::ui::mixin::ParameterWidget< WIDGET >::setupParameterWidget ( PARENT_WIDGET *  _widget, INTERFACE *  _interface  )

inline

Setup widget for interface and place it onto widget.

Make a new parameter widget

                                                                                   {
            if (!_widget) return false;
            if (!_widget->layout()) return false;

            removeParameterWidget(_widget);

            if (!_interface) return false;

            /// Make a new parameter widget
            parameterWidget_ = _interface->widget();

            if (parameterWidget_) {
              parameterWidgetSetupOptions(parameterWidget_);

              _widget->layout()->addWidget(parameterWidget_);
              parameterWidget_->show();
              return true;
            }
            return false;
          }

Field Documentation

template<typename WIDGET = QWidget>

widget_type* omni::ui::mixin::ParameterWidget< WIDGET >::parameterWidget_ = nullptr

private

---

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

• include/omni/ui/mixin/ParameterWidget.h