upiemenu.hpp

/************************************************************************
 *
 *  upiemenu.hpp : Pie and Control menus
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE :
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 * 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.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************/

#ifndef _upiemenu_hpp_
#define _upiemenu_hpp_ 1
#include <ubit/uboxgeom.hpp>
#include <ubit/umenu.hpp>
namespace ubit {
  
class UPiemenu : public UPopmenu {
public:
  UCLASS(UPiemenu)

  UPiemenu();
  
  virtual ~UPiemenu();

  static UStyle* createStyle();

  virtual UBox& item(int n);
  virtual UBox* getItem(int n) const;
  virtual UBox* getSelectedItem() const;

  virtual int getSelectedIndex() const;

  virtual void addSubMenu(int N, UPiemenu* submenu);
  
  void addSubMenu(int N, UPiemenu& submenu) {addSubMenu(N, &submenu);}
  
  virtual void open(UMouseEvent&);
  virtual void show(bool state, UDisp*);
  
  virtual void show(bool state = true) {UPiemenu::show(state,null);}
   
  unsigned long getShowDelay() const {return show_delay;}

  void setShowDelay(unsigned long d) {show_delay = d;}

  const UPoint& getMouseMovement() const {return mousepos;}
  
  UWin* getContainingWin(UDisp* = null) const;  
  
  UPoint getCenterInContainingWin(UDisp* = null) const;
  
  bool isSpringMode() const {return spring_mode;}
  void setSpringMode(bool state = true) {spring_mode = state;}

  // properties 
  
  UColor& pieColor()       {return *ppie_color;}
  UColor& pieBorderColor() {return *ppie_border_color;}
  UColor& sliceColor()     {return *pslice_color;}
  UColor& centerColor()    {return *pcenter_color;}
  UColor& centerBorderColor() {return *pcenter_border_color;}

  ULength& pieRadius()     {return pie_radius;}
  ULength& centerRadius()  {return center_radius;}
  ULength& itemRadius()    {return item_radius;}
    
  // - - callbacks - - 

  virtual void pressCB(UMouseEvent&);
 
  virtual void releaseCB(UMouseEvent&);
  
  virtual void motionCB(UMouseEvent&);

  virtual void hideCB(UEvent&);

  virtual void paintCB(UPaintEvent&);
    
  virtual void resizeCB(UResizeEvent&);
    
  virtual void armItemCB(UMouseEvent& e, UPiemenu* submenu);

  virtual void disarmItemCB(UInputEvent& e, UPiemenu* submenu);

  // - - - impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
  
  enum MenuType {CONCENTRIC, COMPOUND, MULTISTROKE};
  
  void setMenuType(int);
  MenuType getMenuType(int) {return MenuType(menu_style);}
  
  UScale* getScale();
  float getScaleValue();
    
  virtual UBox* createItem();

  virtual void disarmItem(UInputEvent&, bool is_browsing);
 
  virtual float getCentredCoords(UMouseEvent&, UPoint& p, bool& must_forward);

  virtual short getItemFromPos(const UPoint&) const;

  virtual void reset(UMouseEvent*);

  virtual void startNoviceMode();
  
  virtual void forwardToMenu(UPiemenu* submenu);
 
   virtual void receiveFromMenu(UPiemenu* supermenu);
 
   virtual void unlinkFromAndToMenus();
 
protected:
  unsigned char menu_style;
  unsigned char spring_mode:1, ctlmenu_mode:1, novice_mode:1, in_show_function:1; 
  int curitem;
  unsigned long show_delay;
  UPoint armpos, mousepos;
  USize pie_size;
  uptr<UTimer> ptimer;
  //uptr<UBox> parmed; plantage: parmed n'appartient pas au menu!
  UBox* parmed;
  UPiemenu *from_menu, *to_menu;
  UElem gitems;
  ULength pie_radius, center_radius, item_radius;
  uptr<UColor> ppie_color, pcenter_color, pslice_color, ppie_border_color, pcenter_border_color;
#endif
};

inline UPiemenu& upiemenu() {return *new UPiemenu();}

}
#endif