builderext/BuilderExtensionSignature.hpp File Reference

Header of ... More...

#include <openfluid/ware/WareSignature.hpp>
#include <openfluid/config.hpp>
#include <openfluid/dllexport.hpp>
#include <QString>

Go to the source code of this file.

Classes
class	openfluid::builderext::BuilderExtensionSignature
Namespaces
namespace	openfluid
namespace	openfluid::builderext
Defines
#define	BEGIN_BUILDEREXT_SIGNATURE(id, exttype)
#define	END_BUILDEREXT_SIGNATURE
#define	DECLARE_CONFIGURATION_PARAM(name, description)   Signature->ConfigParameters[(name)] = (description);
#define	DECLARE_CATEGORY(category)   Signature->Category = (category);
#define	DECLARE_MENUTEXT(menutext)   Signature->MenuText = (menutext);
Enumerations
enum	openfluid::builderext::ExtensionCategory { openfluid::builderext::CAT_SPATIAL, openfluid::builderext::CAT_MODEL, openfluid::builderext::CAT_RESULTS, openfluid::builderext::CAT_OTHER }
enum	openfluid::builderext::ExtensionType { openfluid::builderext::TYPE_UNKNOWN, openfluid::builderext::TYPE_MODAL, openfluid::builderext::TYPE_MODELESS, openfluid::builderext::TYPE_WORKSPACE }

---

Detailed Description

Header of ...

Author:

Jean-Christophe FABRE <fabrejc@supagro.inra.fr>

---

Define Documentation

#define BEGIN_BUILDEREXT_SIGNATURE	(		id,
			exttype
	)

Value:

openfluid::builderext::BuilderExtensionSignature* WARESIGNATURE_PROC_DECL() \
  { \
    openfluid::builderext::BuilderExtensionSignature* Signature = new openfluid::builderext::BuilderExtensionSignature(); \
    Signature->setABIVersion(openfluid::config::FULL_VERSION); \
    Signature->ID = (id); \
    Signature->Type = (exttype);

Macro for the beginning of definition of signature hook

#define DECLARE_CATEGORY

(

category

)

Signature->Category = (category);

Macro for declaration of the Builder extension category

#define DECLARE_CONFIGURATION_PARAM	(		name,
			description
	)		Signature->ConfigParameters[(name)] = (description);

Macro for declaration of a Builder extension configuration parameter

Parameters:

[in]	name	name of the parameter
[in]	description	description of the parameter

#define DECLARE_MENUTEXT

(

menutext

)

Signature->MenuText = (menutext);

Macro for declaration of the Builder extension menu text

#define END_BUILDEREXT_SIGNATURE

Value:

return Signature; \
  }

Macro for the end of definition of signature hook