CMakeLua/Source/CursesDialog/cmCursesWidget.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCursesWidget.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/03/16 15:44:55 $
   7   Version:   $Revision: 1.8 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef __cmCursesWidget_h
  18 #define __cmCursesWidget_h
  19
  20 #include "../cmCacheManager.h"
  21 #include "cmCursesStandardIncludes.h"
  22
  23 class cmCursesMainForm;
  24
  25 class cmCursesWidget
  26 {
  27 public:
  28   cmCursesWidget(int width, int height, int left, int top);
  29   virtual ~cmCursesWidget();
  30
  31   /**
  32    * Handle user input. Called by the container of this widget
  33    * when this widget has focus. Returns true if the input was
  34    * handled
  35    */
  36   virtual bool HandleInput(int& key, cmCursesMainForm* fm, WINDOW* w) = 0;
  37
  38   /**
  39    * Change the position of the widget. Set isNewPage to true
  40    * if this widget marks the beginning of a new page.
  41    */
  42   virtual void Move(int x, int y, bool isNewPage);
  43
  44   /**
  45    * Set/Get the value (setting the value also changes the contents
  46    * of the field buffer).
  47    */
  48   virtual void SetValue(const char* value);
  49   virtual const char* GetValue();
  50
  51   /**
  52    * Get the type of the widget (STRING, PATH etc...)
  53    */
  54   cmCacheManager::CacheEntryType GetType()
  55     { return this->Type; }
  56
  57   /**
  58    * If there are any, print the widget specific commands
  59    * in the toolbar and return true. Otherwise, return false
  60    * and the parent widget will print.
  61    */
  62   virtual bool PrintKeys()
  63     {
  64       return false;
  65     }
  66
  67   /**
  68    * Set/Get the page this widget is in.
  69    */
  70   void SetPage(int page)
  71     {
  72       this->Page = page;
  73     }
  74   int GetPage()
  75     {
  76       return this->Page;
  77     }
  78
  79   friend class cmCursesMainForm;
  80
  81 protected:
  82   cmCursesWidget(const cmCursesWidget& from);
  83   void operator=(const cmCursesWidget&);
  84
  85   cmCacheManager::CacheEntryType Type;
  86   std::string Value;
  87   FIELD* Field;
  88   // The page in the main form this widget is in
  89   int Page;
  90 };
  91
  92 #endif // __cmCursesWidget_h