1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-06-12 00:40:45 +08:00
CMake/Source/CursesDialog/cmCursesWidget.h
Kitware Robot bdca8b01d2 Modernize: Use #pragma once in all header files
#pragma once is a widely supported compiler pragma, even though it is
not part of the C++ standard. Many of the issues keeping #pragma once
from being standardized (distributed filesystems, build farms, hard
links, etc.) do not apply to CMake - it is easy to build CMake on a
single machine. CMake also does not install any header files which can
be consumed by other projects (though cmCPluginAPI.h has been
deliberately omitted from this conversion in case anyone is still using
it.) Finally, #pragma once has been required to build CMake since at
least August 2017 (7f29bbe6 enabled server mode unconditionally, which
had been using #pragma once since September 2016 (b13d3e0d)). The fact
that we now require C++11 filters out old compilers, and it is unlikely
that there is a compiler which supports C++11 but does not support
#pragma once.
2020-09-03 09:30:21 -04:00

70 lines
1.8 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <string>
#include "cmCursesStandardIncludes.h"
#include "cmStateTypes.h"
class cmCursesMainForm;
class cmCursesWidget
{
public:
cmCursesWidget(int width, int height, int left, int top);
virtual ~cmCursesWidget();
cmCursesWidget(cmCursesWidget const&) = delete;
cmCursesWidget& operator=(cmCursesWidget const&) = delete;
/**
* Handle user input. Called by the container of this widget
* when this widget has focus. Returns true if the input was
* handled
*/
virtual bool HandleInput(int& key, cmCursesMainForm* fm, WINDOW* w) = 0;
/**
* Change the position of the widget. Set isNewPage to true
* if this widget marks the beginning of a new page.
*/
virtual void Move(int x, int y, bool isNewPage);
/**
* Set/Get the value (setting the value also changes the contents
* of the field buffer).
*/
virtual void SetValue(const std::string& value);
virtual const char* GetValue();
/**
* Get the type of the widget (STRING, PATH etc...)
*/
cmStateEnums::CacheEntryType GetType() { return this->Type; }
/**
* If there are any, print the widget specific commands
* in the toolbar and return true. Otherwise, return false
* and the parent widget will print.
*/
virtual bool PrintKeys() { return false; }
/**
* Set/Get the page this widget is in.
*/
void SetPage(int page) { this->Page = page; }
int GetPage() { return this->Page; }
friend class cmCursesMainForm;
protected:
cmStateEnums::CacheEntryType Type;
std::string Value;
FIELD* Field;
// The page in the main form this widget is in
int Page;
};