CMake/Source/CursesDialog/cmCursesWidget.h

82 lines
2.2 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2002-01-21 23:30:43 +03:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#ifndef cmCursesWidget_h
#define cmCursesWidget_h
2001-11-05 02:05:21 +03:00
2016-09-01 22:55:09 +03:00
#include <cmConfigure.h> // IWYU pragma: keep
2001-11-05 21:24:44 +03:00
#include "cmCursesStandardIncludes.h"
2016-09-01 22:55:09 +03:00
#include "cmState.h"
2001-11-05 02:05:21 +03:00
2016-09-01 22:55:09 +03:00
#include <string>
2001-12-13 21:28:41 +03:00
class cmCursesMainForm;
2001-11-05 02:05:21 +03:00
class cmCursesWidget
{
public:
cmCursesWidget(int width, int height, int left, int top);
virtual ~cmCursesWidget();
2001-12-13 21:28:41 +03:00
/**
* 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.
*/
2001-11-05 02:05:21 +03:00
virtual void Move(int x, int y, bool isNewPage);
2001-12-13 21:28:41 +03:00
/**
* Set/Get the value (setting the value also changes the contents
* of the field buffer).
*/
virtual void SetValue(const std::string& value);
2001-11-05 02:05:21 +03:00
virtual const char* GetValue();
2001-12-13 21:28:41 +03:00
/**
* Get the type of the widget (STRING, PATH etc...)
*/
cmState::CacheEntryType GetType() { return this->Type; }
2001-11-05 02:05:21 +03:00
2001-12-13 21:28:41 +03:00
/**
* 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; }
2001-12-13 21:28:41 +03:00
/**
* Set/Get the page this widget is in.
*/
void SetPage(int page) { this->Page = page; }
int GetPage() { return this->Page; }
2001-12-13 21:28:41 +03:00
2001-11-05 02:05:21 +03:00
friend class cmCursesMainForm;
protected:
cmCursesWidget(const cmCursesWidget& from);
void operator=(const cmCursesWidget&);
cmState::CacheEntryType Type;
2006-03-16 18:44:55 +03:00
std::string Value;
FIELD* Field;
2001-12-13 21:28:41 +03:00
// The page in the main form this widget is in
2006-03-16 18:44:55 +03:00
int Page;
2001-11-05 02:05:21 +03:00
};
#endif // cmCursesWidget_h