omni::ui::mixin::Editor< WIDGET, EDITOR > Class Template Reference

Mixin for a widget that holds an editor widget. More...

#include <Editor.h>

Public Types
typedef WIDGET	widget_type
	Widget type. More...
typedef EDITOR	editor_type
	Editor widget type, e.g. QDoubleSpinBox. More...

Public Member Functions
	Editor (widget_type *_widget)
template<typename T = editor_type>
T *	createEditor ()
	Create editor with type. More...
editor_type const *	editor () const
	Return pointer editor (const version) More...
editor_type *	editor ()
	Return pointer editor. More...
template<typename T >
T *	editorAs ()
	Return editor as type T. More...
template<typename T >
T const *	editorAs () const
	Return editor as type T (const version) More...
virtual void	setEditorVisible (bool _visible)
	Set editor visibility and set focus. More...
void	showEditor ()
	Show editor and set focus. More...
void	hideEditor ()
	Hide editor. More...

Private Member Functions
virtual void	editorSetup ()=0

Private Attributes
editor_type *	editor_ = nullptr
widget_type *	widget_ = nullptr

Detailed Description

template<typename WIDGET, typename EDITOR>
class omni::ui::mixin::Editor< WIDGET, EDITOR >

Mixin for a widget that holds an editor widget.

Member Typedef Documentation

template<typename WIDGET, typename EDITOR>

typedef EDITOR omni::ui::mixin::Editor< WIDGET, EDITOR >::editor_type

Editor widget type, e.g. QDoubleSpinBox.

template<typename WIDGET, typename EDITOR>

typedef WIDGET omni::ui::mixin::Editor< WIDGET, EDITOR >::widget_type

Widget type.

Constructor & Destructor Documentation

template<typename WIDGET, typename EDITOR>

omni::ui::mixin::Editor< WIDGET, EDITOR >::Editor ( widget_type *  _widget )

inline

: widget_(_widget) {}

Member Function Documentation

template<typename WIDGET, typename EDITOR>

template<typename T = editor_type>

T* omni::ui::mixin::Editor< WIDGET, EDITOR >::createEditor ( )

inline

Create editor with type.

          {
            if (editor_) return nullptr;

            editor_ = new T(widget_);
            T *_e = editorAs<T>();
            _e->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Ignored);
            _e->setStyleSheet("background : transparent");

            if (widget_->layout()) widget_->layout()->addWidget(_e);
            editorSetup();
            hideEditor();
            return _e;
          }

template<typename WIDGET, typename EDITOR>

editor_type const* omni::ui::mixin::Editor< WIDGET, EDITOR >::editor ( ) const

inline

Return pointer editor (const version)

                                            {
            return editor_;
          }

template<typename WIDGET, typename EDITOR>

editor_type* omni::ui::mixin::Editor< WIDGET, EDITOR >::editor ( )

inline

Return pointer editor.

                                {
            return editor_;
          }

template<typename WIDGET, typename EDITOR>

template<typename T >

T* omni::ui::mixin::Editor< WIDGET, EDITOR >::editorAs ( )

inline

Return editor as type T.

          {
            return static_cast<T *>(editor_);
          }

template<typename WIDGET, typename EDITOR>

template<typename T >

T const* omni::ui::mixin::Editor< WIDGET, EDITOR >::editorAs ( ) const

inline

Return editor as type T (const version)

          {
            return static_cast<T const *>(editor_);
          }

template<typename WIDGET, typename EDITOR>

virtual void omni::ui::mixin::Editor< WIDGET, EDITOR >::editorSetup ( )

privatepure virtual

Implemented in omni::ui::RangedFloat, omni::ui::Dial, and omni::ui::RangedInt.

template<typename WIDGET, typename EDITOR>

void omni::ui::mixin::Editor< WIDGET, EDITOR >::hideEditor ( )

inline

Hide editor.

                            {
            setEditorVisible(false);
          }

template<typename WIDGET, typename EDITOR>

virtual void omni::ui::mixin::Editor< WIDGET, EDITOR >::setEditorVisible ( bool  _visible )

inlinevirtual

Set editor visibility and set focus.

                                                       {
            if (!editor_) return;

            editor_->setVisible(_visible);

            if (_visible) {
              editor_->setFocus();
            }
          }

template<typename WIDGET, typename EDITOR>

void omni::ui::mixin::Editor< WIDGET, EDITOR >::showEditor ( )

inline

Show editor and set focus.

                            {
            setEditorVisible(true);
          }

Field Documentation

template<typename WIDGET, typename EDITOR>

editor_type* omni::ui::mixin::Editor< WIDGET, EDITOR >::editor_ = nullptr

private

template<typename WIDGET, typename EDITOR>

widget_type* omni::ui::mixin::Editor< WIDGET, EDITOR >::widget_ = nullptr

private

---

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

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