add doxygen via opencode
This commit is contained in:
@@ -1,9 +1,11 @@
|
||||
/*! \file piscreen.h
|
||||
* \ingroup Console
|
||||
* \~\brief
|
||||
* \~english Console tiling manager
|
||||
* \~russian Консольный тайловый менеджер
|
||||
*/
|
||||
//! \file piscreen.h
|
||||
//! \ingroup Console
|
||||
//! \brief
|
||||
//! \~english Console tiling manager
|
||||
//! \~russian Консольный тайловый менеджер
|
||||
//! \details
|
||||
//! \~english Main console screen manager providing tile-based UI rendering and keyboard input.
|
||||
//! \~russian Основной менеджер консольного экрана, обеспечивающий отрисовку UI на основе тайлов и ввод с клавиатуры.
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Console GUI
|
||||
@@ -38,46 +40,126 @@ class PIP_CONSOLE_EXPORT PIScreen
|
||||
class SystemConsole;
|
||||
|
||||
public:
|
||||
//! Constructs %PIScreen with key handler "slot" and if "startNow" start it
|
||||
//! \brief
|
||||
//! \~english Constructs PIScreen
|
||||
//! \~russian Создает PIScreen
|
||||
//! \param startNow Start immediately / Запустить немедленно
|
||||
//! \param slot Keyboard handler function / Обработчик клавиатуры
|
||||
PIScreen(bool startNow = true, PIKbdListener::KBFunc slot = 0);
|
||||
|
||||
//! \brief
|
||||
//! \~english Destructor
|
||||
//! \~russian Деструктор
|
||||
~PIScreen();
|
||||
|
||||
//! Directly call function from \a PIKbdListener
|
||||
//! \brief
|
||||
//! \~english Enables exit capture with key
|
||||
//! \~russian Включает захват выхода по клавише
|
||||
void enableExitCapture(int key = 'Q') { listener->enableExitCapture(key); }
|
||||
|
||||
//! Directly call function from \a PIKbdListener
|
||||
//! \brief
|
||||
//! \~english Disables exit capture
|
||||
//! \~russian Отключает захват выхода
|
||||
void disableExitCapture() { listener->disableExitCapture(); }
|
||||
|
||||
//! Directly call function from \a PIKbdListener
|
||||
//! \brief
|
||||
//! \~english Checks if exit is captured
|
||||
//! \~russian Проверяет, захвачен ли выход
|
||||
bool exitCaptured() const { return listener->exitCaptured(); }
|
||||
|
||||
//! Directly call function from \a PIKbdListener
|
||||
//! \brief
|
||||
//! \~english Returns exit key
|
||||
//! \~russian Возвращает клавишу выхода
|
||||
int exitKey() const { return listener->exitKey(); }
|
||||
|
||||
//! \brief
|
||||
//! \~english Returns window width
|
||||
//! \~russian Возвращает ширину окна
|
||||
int windowWidth() const { return console.width; }
|
||||
|
||||
//! \brief
|
||||
//! \~english Returns window height
|
||||
//! \~russian Возвращает высоту окна
|
||||
int windowHeight() const { return console.height; }
|
||||
|
||||
//! \brief
|
||||
//! \~english Checks if mouse is enabled
|
||||
//! \~russian Проверяет, включена ли мышь
|
||||
bool isMouseEnabled() const { return mouse_; }
|
||||
|
||||
//! \brief
|
||||
//! \~english Sets mouse enabled state
|
||||
//! \~russian Устанавливает состояние мыши
|
||||
void setMouseEnabled(bool on);
|
||||
|
||||
//! \brief
|
||||
//! \~english Returns root tile
|
||||
//! \~russian Возвращает корневой тайл
|
||||
PIScreenTile * rootTile() { return &root; }
|
||||
|
||||
//! \brief
|
||||
//! \~english Finds tile by name
|
||||
//! \~russian Находит тайл по имени
|
||||
PIScreenTile * tileByName(const PIString & name);
|
||||
|
||||
//! \brief
|
||||
//! \~english Sets dialog tile
|
||||
//! \~russian Устанавливает диалоговый тайл
|
||||
void setDialogTile(PIScreenTile * t);
|
||||
|
||||
//! \brief
|
||||
//! \~english Returns current dialog tile
|
||||
//! \~russian Возвращает текущий диалоговый тайл
|
||||
PIScreenTile * dialogTile() const { return tile_dialog; }
|
||||
|
||||
//! \brief
|
||||
//! \~english Returns screen drawer
|
||||
//! \~russian Возвращает отрисовщик экрана
|
||||
PIScreenDrawer * drawer() { return &drawer_; }
|
||||
|
||||
//! \brief
|
||||
//! \~english Clears the screen
|
||||
//! \~russian Очищает экран
|
||||
void clear() { drawer_.clear(); }
|
||||
|
||||
//! \brief
|
||||
//! \~english Resizes screen
|
||||
//! \~russian Изменяет размер экрана
|
||||
void resize(int w, int h) { console.resize(w, h); }
|
||||
|
||||
//! \brief
|
||||
//! \~english Waits for finish
|
||||
//! \~russian Ожидает завершения
|
||||
EVENT_HANDLER0(void, waitForFinish);
|
||||
|
||||
//! \brief
|
||||
//! \~english Starts screen
|
||||
//! \~russian Запускает экран
|
||||
EVENT_HANDLER0(void, start) { start(false); }
|
||||
|
||||
//! \brief
|
||||
//! \~english Starts screen
|
||||
//! \~russian Запускает экран
|
||||
EVENT_HANDLER1(void, start, bool, wait);
|
||||
|
||||
//! \brief
|
||||
//! \~english Stops screen
|
||||
//! \~russian Останавливает экран
|
||||
EVENT_HANDLER0(void, stop) { stop(false); }
|
||||
|
||||
//! \brief
|
||||
//! \~english Stops screen
|
||||
//! \~russian Останавливает экран
|
||||
EVENT_HANDLER1(void, stop, bool, clear);
|
||||
|
||||
//! \brief
|
||||
//! \~english Raised on key pressed
|
||||
//! \~russian Вызывается при нажатии клавиши
|
||||
EVENT2(keyPressed, PIKbdListener::KeyEvent, key, void *, data);
|
||||
|
||||
//! \brief
|
||||
//! \~english Raised on tile event
|
||||
//! \~russian Вызывается при событии тайла
|
||||
EVENT2(tileEvent, PIScreenTile *, tile, PIScreenTypes::TileEvent, e);
|
||||
|
||||
//! \handlers
|
||||
|
||||
Reference in New Issue
Block a user