-/***************************************************************
- * Name: TFunctor
- * Purpose: Call_Back Functions
- * Author: Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified: 2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
+/************************************************************************************//*!
+ * Name: @file system.h
+ * Purpose: @brief contains a system typedefs used to reuse code.
+ * Author: @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * Modified: 2011-05-18
+ * Copyright:
* License:
- **************************************************************/
+ ***************************************************************************************/
#ifndef SYSTEM_H_
#define SYSTEM_H_
+//! @include <list>
#include <list>
+//! @include <map>
#include <map>
+//! @include <iostream>
#include <iostream>
+//! @include "functor.h"
#include "functor.h"
///@namespace <creaButtonContainer>
namespace creaButtonContainer
{
- typedef model::TFunctor* FunctionEventType;
- //First is the button description, Second FunctionEventType
- typedef std::pair< std::string, FunctionEventType > ActionButton;
- //First is the ButtonName and Second is the ImageIconPath
- typedef std::pair< std::string, std::string > ButtonInfo;
- typedef std::pair< ButtonInfo*, ActionButton* > ButtonPair;
- typedef std::list< std::string > KeyMapList;
- typedef std::list< ButtonPair* > ButtonList;
- typedef std::map< std::string, ButtonList > ButtonGroupMap;
+ /*! @typedef model::TFunctor* FunctionEventType;
+ * @brief Defines the FunctionEventType type.
+ *
+ */
+ typedef model::TFunctor* FunctionEventType;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::view::Button Button;
+ * @brief Defines the ActionButton type.
+ * First is the button description, Second FunctionEventType
+ */
+ typedef std::pair< std::string, FunctionEventType > ButtonAction;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::pair< std::string, std::string > ButtonInfo;
+ * @brief Defines the ButtonInfo type.
+ * First is the ButtonName and Second is the IconPath
+ */
+ typedef std::pair< std::string, std::string > ButtonInfo;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::pair< ButtonInfo*, ActionButton* > ButtonPair;
+ * @brief Defines the ButtonPair type.
+ */
+ typedef std::pair< ButtonInfo*, ButtonAction* > ButtonPair;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::list< std::string > KeyMapList;
+ * @brief Defines the KeyMapList type.
+ */
+ typedef std::list< std::string > KeyMapList;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::list< ButtonPair* > ButtonList;
+ * @brief Defines the ButtonList type.
+ */
+ typedef std::list< ButtonPair* > ButtonList;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::map< std::string, ButtonList > ButtonGroupMap;
+ * @brief Defines the ButtonGroupMap type.
+ */
+ typedef std::map< std::string, ButtonList > ButtonGroupMap;
+// ----------------------------------------------------------------------------------
}
#endif /* SYSTEM_H_ */