93 lines
2.1 KiB
C++
93 lines
2.1 KiB
C++
/**
|
|
* @file include/ActivMiddleware/ActivFramework/DatabaseUiOptions.h
|
|
*
|
|
* @brief Header file for the database user interface options.
|
|
*/
|
|
|
|
#if (!defined ACTIV_FRAMEWORK_DATABASE_UI_OPTIONS_H)
|
|
#define ACTIV_FRAMEWORK_DATABASE_UI_OPTIONS_H
|
|
|
|
#include "ActivMiddleware/ActivFramework/External.h"
|
|
|
|
#include "ActivMiddleware/ActivDatabase/Database.h"
|
|
|
|
#include "ActivMiddleware/ActivFramework/UiMenu.h"
|
|
#include "ActivMiddleware/ActivFramework/UiIo.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
//! Database namespace.
|
|
namespace Database
|
|
{
|
|
|
|
/**
|
|
* @brief Database user interface options class.
|
|
*/
|
|
class DatabaseUiOptions
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Constructor.
|
|
*
|
|
* @param database the database.
|
|
*/
|
|
ACTIV_FRAMEWORK_API DatabaseUiOptions(Database &database);
|
|
|
|
/**
|
|
* @brief Add all options.
|
|
*
|
|
* @param uiMenu the user interface menu to add the options to.
|
|
*/
|
|
ACTIV_FRAMEWORK_API void AddAllOptions(UiMenu &uiMenu);
|
|
|
|
/**
|
|
* @brief Display table statistics.
|
|
*
|
|
* @param uiIo the user interface i/o object.
|
|
*/
|
|
ACTIV_FRAMEWORK_API void DisplayTableStatistics(const UiIo &uiIo);
|
|
|
|
/**
|
|
* @brief Display table menu.
|
|
*
|
|
* @param uiIo the user interface i/o object.
|
|
*/
|
|
ACTIV_FRAMEWORK_API void DisplayTableMenu(const UiIo &uiIo);
|
|
|
|
/**
|
|
* @brief Display table statistics.
|
|
*
|
|
* @param uiIo the user interface i/o object.
|
|
* @param database the database.
|
|
*/
|
|
ACTIV_FRAMEWORK_API static void DisplayTableStatistics(const UiIo &uiIo, const Database &database);
|
|
|
|
/**
|
|
* @brief Display table menu.
|
|
*
|
|
* @param uiIo the user interface i/o object.
|
|
* @param database the database.
|
|
*/
|
|
ACTIV_FRAMEWORK_API static void DisplayTableMenu(const UiIo &uiIo, Database &database);
|
|
|
|
/**
|
|
* @brief Get table id.
|
|
*
|
|
* @param uiIo the user interface i/o object.
|
|
* @param database the database.
|
|
* @param tableId set equal to the table id.
|
|
*/
|
|
ACTIV_FRAMEWORK_API static StatusCode GetTableId(const UiIo &uiIo, const Database &database, DatabaseSpecification::TableId &tableId);
|
|
|
|
private:
|
|
Database & m_database; ///< A reference to the database.
|
|
};
|
|
|
|
} // namespace Database
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_FRAMEWORK_DATABASE_UI_OPTIONS_H)
|