menu_base.h

Go to the documentation of this file.

//note: in progress.
 
#ifndef MENU_BASE_CLASS
#define MENU_BASE_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : menu_base                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2003-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
 
 
#include <basis/contracts.h>
 
// forward.
class menu_common_amorph;
 
 
 
class menu_common_base : public virtual root_object
{
public:
  virtual ~menu_common_base();
 
  bool enabled() const { return _enabled; }
  void enable(bool enable = true) { _enabled = enable; }
 
private:
  bool _enabled;  
};
 
 
 
class menu_item
: public menu_common_base
{
public:
  menu_item(const string_array &triggers, const astring &text,
          const astring &description);
 
  menu_item(const menu_item &to_copy);
 
  virtual ~menu_item();
 
  menu_item &operator =(const menu_item &to_copy);
 
  DEFINE_CLASS_NAME("menu_item");
 
  const string_array &triggers() const;
  const astring &text() const;
  const astring &description() const;
 
  virtual void menu_activation(char trigger);
 
private:
  string_array *_triggers;  
  astring *_text;  
  astring *_description;  
};
 
 
 
class menu_base : public menu_common_base
{
public:
  menu_base(const astring &title, const menu_item &parameters);
    //<! constructs a menu where the "title" is the name for this menu.
  virtual ~menu_base();
 
  DEFINE_CLASS_NAME("menu_base");
 
  bool validate(bool recursive = true);
 
  astring text_form() const;
 
  astring recursive_text_form() const;
 
  menu_common_base *evaluate_trigger(char trigger);
 
  virtual void activate();
 
  // note about the methods here: the menu_base takes over responsibility for
  // pointers it is handed.  do not delete the items after adding them or
  // get an item and then delete it.
  // also, the indices for menu items are separate from the indices for the
  // sub-menus.
 
  // menu item manipulators.  the indexes here range from 0 to items() - 1.
  int items() const;  
  void add_item(menu_item *to_invoke);
  menu_item *get_item(int index);
  bool zap_item(int index);
  bool enable_item(int index, bool enable = true);
 
  // submenu manipulation support.  these range from 0 to submenus() - 1.
  int submenus() const;  
  void add_submenu(menu_base *sub);  
  menu_base *get_submenu(int index);
  bool zap_submenu(int index);
  bool enable_submenu(int index, bool enable = true);
 
private:
  astring *_title;  
  menu_item *_parameters;  
  menu_common_amorph *_items;  
  menu_common_amorph *_menus;  
};
 
#endif