Add a version of ArmarXGuiPlugin::addWidget not instantiating GuiPlugins (if...

Add a version of ArmarXGuiPlugin::addWidget not instantiating GuiPlugins (if they implement GetWidgetName)

source/ArmarXGui/libraries/ArmarXGuiBase/ArmarXGuiPlugin.h

@@ -28,6 +28,7 @@
 #include "ArmarXComponentWidgetController.h"
 
 #include <ArmarXCore/core/exceptions/Exception.h>
+#include <ArmarXCore/core/util/TemplateMetaProgramming.h>
 
 #include <boost/type_traits/is_base_of.hpp>
 
@@ -51,8 +52,11 @@ namespace armarx
         Q_INTERFACES(ArmarXGuiInterface)
 
     public:
-        template<typename ArmarXWidgetType>
-        void addWidget()
+
+        ARMARX_META_MAKE_HAS_MEMBER_FNC_CHECK(HasGetWidgetName,  GetWidgetName, QString(*)());
+
+        template < typename ArmarXWidgetType>
+        typename std::enable_if < !HasGetWidgetName<ArmarXWidgetType>::value >::type addWidget()
         {
             BOOST_STATIC_ASSERT_MSG((boost::is_base_of<ArmarXWidgetController, ArmarXWidgetType>::value), "The template parameter of addWidget, must be a class that derives from ArmarXWidget");
 
@@ -90,6 +94,40 @@ namespace armarx
             //            ARMARX_VERBOSE_S << "Added new widget named " + creatorInstance->getWidgetName().toStdString() << std::endl;
         }
 
+        template <typename ArmarXWidgetType>
+        typename std::enable_if<HasGetWidgetName<ArmarXWidgetType>::value>::type addWidget()
+        {
+            BOOST_STATIC_ASSERT_MSG((boost::is_base_of<ArmarXWidgetController, ArmarXWidgetType>::value), "The template parameter of addWidget, must be a class that derives from ArmarXWidget");
+
+            try
+            {
+                if (__availableWidgets.find(ArmarXWidgetType::GetWidgetName()) != __availableWidgets.end())
+                {
+                    throw LocalException(QString("A widget with the name '"
+                                                 + ArmarXWidgetType::GetWidgetName()
+                                                 + "' already exists in a loaded plugin!").toStdString());
+                }
+
+                if (boost::is_base_of<ArmarXComponentWidgetController, ArmarXWidgetType>::value)
+                {
+                    ArmarXWidgetInfoPtr widgetInfo(new ArmarXWidgetInfo(ArmarXComponentWidgetController::createInstance<ArmarXWidgetType>,
+                                                   ArmarXWidgetType::GetWidgetIcon(),
+                                                   ArmarXWidgetType::GetWidgetCategoryIcon()));
+                    __availableWidgets[ArmarXWidgetType::GetWidgetName()] = widgetInfo;
+                }
+                else
+                {
+                    ArmarXWidgetInfoPtr widgetInfo(new ArmarXWidgetInfo(ArmarXWidgetController::createInstance<ArmarXWidgetType>,
+                                                   ArmarXWidgetType::GetWidgetIcon(),
+                                                   ArmarXWidgetType::GetWidgetCategoryIcon()));
+                    __availableWidgets[ArmarXWidgetType::GetWidgetName()] = widgetInfo;
+                }
+            }
+            catch (...)
+            {
+                ARMARX_ERROR_S << "Could not add widget!\n" << GetHandledExceptionString();
+            }
+        }
         //        template<typename ArmarXWidgetType>
         //        typename boost::enable_if<boost::is_base_of<ArmarXComponentWidgetController, ArmarXWidgetType>, void >::type
         //        addWidget(const QString & widgetName)

source/ArmarXGui/libraries/ArmarXGuiBase/ArmarXWidgetController.h

@@ -118,6 +118,21 @@ namespace armarx
 
         /**
          * @brief Implement this function to specify the default name of your Widget.
+         *
+         * Implement the function as:
+         * \code{.cpp}
+         * static QString GetWidgetName()
+         * {
+         *      return "my_widget_category.my_widget_name"
+         * }
+         * virtual QString getWidgetName() const override
+         * {
+         *      return GetWidgetName();
+         * }
+         * \endcode
+         * If you implement the static GetWidgetName() function, the armarx gui does not need to instantiate
+         * this widget only to get the name.
+         *
          * Dot-Notation can be used to insert the widget in categories and subcategories
          * (e.g.: "Statecharts.StatechartEditor"). Categories must not collide with Widget names.
          * @return Default name of the implemented Widget.
@@ -132,6 +147,25 @@ namespace armarx
         {
             return QIcon();
         }
+        /**
+         * @brief Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()).
+         *
+         * The implementation should look like this:
+         * \code{.cpp}
+         * static QIcon GetWidgetIcon()
+         * {
+         *      return QIcon{"my_resource_path"};
+         * }
+         * virtual QIcon getWidgetIcon() const override
+         * {
+         *      return GetWidgetIcon();
+         * }
+         * \endcode
+         */
+        static QIcon GetWidgetIcon()
+        {
+            return QIcon();
+        }
 
         /**
          * @brief Implement this function to supply an icon for the category.
@@ -141,6 +175,25 @@ namespace armarx
         {
             return QIcon();
         }
+        /**
+         * @brief Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()).
+         *
+         * The implementation should look like this:
+         * \code{.cpp}
+         * static QIcon GetWidgetCategoryIcon()
+         * {
+         *      return QIcon{"my_resource_path"};
+         * }
+         * virtual QIcon getWidgetCategoryIcon() const override
+         * {
+         *      return GetWidgetCategoryIcon();
+         * }
+         * \endcode
+         */
+        static QIcon GetWidgetCategoryIcon()
+        {
+            return QIcon();
+        }
 
         /**
          * @brief Implement to load the settings that are part of the GUI configuration.