Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Signals | Public Member Functions | List of all members
ToolboxInterface Class Reference

Plugins can add its own toolbox to the main widget's toolbox area by using this interface. More...

#include <OpenFlipper/BasePlugin/ToolboxInterface.hh>

Inheritance diagram for ToolboxInterface:
DataControlPlugin DecimaterPlugin HoleFillerPlugin IsotropicRemesherPlugin MaterialPicker MeshComparePlugin MeshRepairPlugin MouseAndKeyPlugin MovePlugin PluginAlignMeshes PolyLinePlugin PropertyVisPlugin RemesherPlugin SelectionBasePlugin SkeletalAnimationPlugin SkeletonEditingPlugin SlicePlugin SmootherPlugin SmootherPlugin SmootherPlugin SplatCloudRenderingControlPlugin SubdividerPlugin

Signals

virtual void addToolbox (QString _name, QWidget *_widget)
 Add a toolbox widget to the gui with the given name. More...
 

Public Member Functions

virtual ~ToolboxInterface ()
 Destructor.
 
virtual void addToolbox (QString _name, QWidget *_widget, QIcon *_icon)
 Add a toolbox widget to the gui with the given name and an icon. More...
 
virtual void addToolbox (QString _name, QWidget *_widget, QIcon *_icon, QWidget *_headerAreaWidget)
 Add a toolbox widget to the gui with the given name, icon and header area widget. More...
 

Detailed Description

Plugins can add its own toolbox to the main widget's toolbox area by using this interface.

Detailed description
This Interface can be used by plugins which will provide a toolbox widget. Each Plugin can create own Widgets in the toolbox area. Just create your widget and then add it with
emit addToolbox( QString _name , QWidget* _widget )
to the user interface. You can create extra signals and slots in your Plugin. These can be connected between your toolbox and your plugin.
See our tutorials Implementing a mesh smoother plugin and Implementing mouse and keyboard interaction for an example of to add custom toolboxes to OpenFlipper.

Definition at line 85 of file ToolboxInterface.hh.

Member Function Documentation

virtual void ToolboxInterface::addToolbox ( QString  _name,
QWidget *  _widget 
)
inlinevirtualsignal

Add a toolbox widget to the gui with the given name.

This signal adds a toolbox widget to the toolbox area on the right.

Parameters
_nameVisible name of the toolbox
_widgetPointer to the toolbox widget

Definition at line 103 of file ToolboxInterface.hh.

virtual void ToolboxInterface::addToolbox ( QString  _name,
QWidget *  _widget,
QIcon *  _icon 
)
inlinevirtual

Add a toolbox widget to the gui with the given name and an icon.

This signal adds a toolbox widget to the toolbox area on the right. And sets an icon for it

Parameters
_nameVisible name of the toolbox
_widgetPointer to the toolbox widget
_iconIcon for the toolbox

Definition at line 113 of file ToolboxInterface.hh.

virtual void ToolboxInterface::addToolbox ( QString  _name,
QWidget *  _widget,
QIcon *  _icon,
QWidget *  _headerAreaWidget 
)
inlinevirtual

Add a toolbox widget to the gui with the given name, icon and header area widget.

This signal adds a toolbox widget to the toolbox area on the right. And sets an icon for it

Parameters
_nameVisible name of the toolbox
_widgetPointer to the toolbox widget
_iconIcon for the toolbox
_headerAreaWidgetWidget displayed in the toolbox header between the title and the detach button.

Definition at line 125 of file ToolboxInterface.hh.

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