Updated toolbar.

1 files changed, 55 insertions, 22 deletions

diff --git a/Source/CursesDialog/cmCursesMainForm.h b/Source/CursesDialog/cmCursesMainForm.h
index aa6c0ed..d6a616d 100644
--- a/Source/CursesDialog/cmCursesMainForm.h
+++ b/Source/CursesDialog/cmCursesMainForm.h
@@ -7,28 +7,37 @@
 
 class cmCursesCacheEntryComposite;
 
+/** \class cmCursesMainForm
+ * \brief The main page of ccmake
+ *
+ * cmCursesMainForm is the main page of ccmake.
+ */
 class cmCursesMainForm : public cmCursesForm
 {
 public:
   cmCursesMainForm(std::vector<std::string> const& args);
   virtual ~cmCursesMainForm();
   
-  // Description:
-  // Set the widgets which represent the cache entries.
+  /**
+   * Set the widgets which represent the cache entries.
+   */
   void InitializeUI();
   
-  // Description:
-  // Handle user input.
+  /**
+   * Handle user input.
+   */
   virtual void HandleInput();
 
-  // Description:
-  // Display form. Use a window of size width x height, starting
-  // at top, left.
+  /**
+   * Display form. Use a window of size width x height, starting
+   * at top, left.
+   */
   virtual void Render(int left, int top, int width, int height);
 
-  // Description:
-  // Returns true if an entry with the given key is in the
-  // list of current composites.
+  /**
+   * Returns true if an entry with the given key is in the
+   * list of current composites.
+   */
   bool LookForCacheEntry(const char* key);
 
   enum {
@@ -38,47 +47,71 @@ public:
     MAX_WIDTH = 512
   };
 
-  // Description:
-  // This method should normally  called only by the form.
-  // The only exception is during a resize.
+  /**
+   * This method should normally  called only by the form.
+   * The only exception is during a resize.
+   */
   virtual void UpdateStatusBar();
 
-  // Description:
-  // This method should normally  called only by the form.
-  // The only exception is during a resize.
+  /**
+   * Display current commands and their keys on the toolbar.
+   * This method should normally  called only by the form.
+   * The only exception is during a resize.
+   */
   void PrintKeys();
 
-  // Description:
-  // During a CMake run, an error handle should add errors
-  // to be displayed afterwards.
+  /**
+   * During a CMake run, an error handle should add errors
+   * to be displayed afterwards.
+   */
   virtual void AddError(const char* message, const char* title);
 
-  // Description:
-  // Used to run cmake.
+  /**
+   * Used to run cmake.
+   */
   void RunCMake(bool generateMakefiles);
 
 protected:
   cmCursesMainForm(const cmCursesMainForm& from);
   void operator=(const cmCursesMainForm&);
 
+  // Copy the cache values from the user interface to the actual
+  // cache.
   void FillCacheManagerFromUI();
+  // Re-post the existing fields. Used to toggle between
+  // normal and advanced modes. Render() should be called
+  // afterwards.
   void RePost();
+  // Remove an entry from the interface and the cache.
   void RemoveEntry(const char* value);
 
+  // Copies of cache entries stored in the user interface
   std::vector<cmCursesCacheEntryComposite*>* m_Entries;
+  // Errors produced during last run of cmake
   std::vector<std::string> m_Errors;
+  // Command line argumens to be passed to cmake each time
+  // it is run
   std::vector<std::string> m_Args;
+  // Message displayed when user presses 'h'
+  // It is: Welcome + info about current entry + common help
   std::vector<std::string> m_HelpMessage;
 
+  // Common help
   static const char* s_ConstHelpMessage;
 
+  // Fields displayed. Includes labels, new entry markers, entries
   FIELD** m_Fields;
+  // Where is source of current project
   std::string m_WhereSource;
+  // Where is cmake executable
   std::string m_WhereCMake;
-  int m_Height;
+  // Number of entries shown (depends on mode -normal or advanced-)
   int m_NumberOfVisibleEntries;
   bool m_AdvancedMode;
+  // Did the iteration converge (no new entries) ?
   bool m_OkToGenerate;
+  // Number of pages displayed
+  int m_NumberOfPages;
 
 };