add doxygen via opencode
This commit is contained in:
@@ -1,9 +1,11 @@
|
||||
/*! \file piscreenconsole.h
|
||||
* \ingroup Console
|
||||
* \~\brief
|
||||
* \~english Tile for PIScreen with PIConsole API
|
||||
* \~russian Тайл для PIScreen с API PIConsole
|
||||
*/
|
||||
//! \file piscreenconsole.h
|
||||
//! \ingroup Console
|
||||
//! \brief
|
||||
//! \~english Tile for PIScreen with PIConsole API
|
||||
//! \~russian Тайл для PIScreen с API PIConsole
|
||||
//! \details
|
||||
//! \~english Provides tiles for displaying variable data and console-like content.
|
||||
//! \~russian Обеспечивает тайлы для отображения данных переменных и консольного контента.
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Tile for PIScreen with PIConsole API
|
||||
@@ -32,17 +34,30 @@
|
||||
/// NOTE: incomplete class
|
||||
/// TODO: write TileVars
|
||||
|
||||
//! \brief
|
||||
//! \~english Tile for displaying variable data
|
||||
//! \~russian Тайл для отображения данных переменных
|
||||
|
||||
class PIP_CONSOLE_EXPORT TileVars: public PIScreenTile {
|
||||
public:
|
||||
//! \brief
|
||||
//! \~english Constructs TileVars
|
||||
//! \~russian Создает TileVars
|
||||
//! \param n Tile name / Имя тайла
|
||||
TileVars(const PIString & n = PIString());
|
||||
|
||||
protected:
|
||||
//! \brief Variable data structure
|
||||
struct PIP_CONSOLE_EXPORT Variable {
|
||||
Variable() {
|
||||
nx = ny = type = offset = bitFrom = bitCount = size = 0;
|
||||
format = PIScreenTypes::CellFormat();
|
||||
ptr = 0;
|
||||
}
|
||||
|
||||
//! \brief
|
||||
//! \~english Checks if variable is empty
|
||||
//! \~russian Проверяет, пустая ли переменная
|
||||
bool isEmpty() const { return (ptr == 0); }
|
||||
PIString name;
|
||||
PIScreenTypes::CellFormat format;
|
||||
@@ -67,15 +82,34 @@ protected:
|
||||
ptr = src.ptr;
|
||||
}*/
|
||||
};
|
||||
|
||||
//! \brief
|
||||
//! \~english Returns variables
|
||||
//! \~russian Возвращает переменные
|
||||
PIVector<Variable> variables;
|
||||
PIScreenTypes::Alignment alignment;
|
||||
|
||||
//! \brief
|
||||
//! \~english Calculates tile size hint
|
||||
//! \~russian Вычисляет рекомендуемый размер тайла
|
||||
void sizeHint(int & w, int & h) const override;
|
||||
|
||||
//! \brief
|
||||
//! \~english Draws tile content
|
||||
//! \~russian Рисует содержимое тайла
|
||||
void drawEvent(PIScreenDrawer * d) override;
|
||||
};
|
||||
|
||||
|
||||
//! \brief
|
||||
//! \~english Console-style tile for PIScreen
|
||||
//! \~russian Консольный тайл для PIScreen
|
||||
|
||||
class PIP_CONSOLE_EXPORT PIScreenConsoleTile: public PIScreenTile {
|
||||
public:
|
||||
//! \brief
|
||||
//! \~english Constructs PIScreenConsoleTile
|
||||
//! \~russian Создает PIScreenConsoleTile
|
||||
PIScreenConsoleTile();
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user