uchoice.hpp

/* ==================================================== ======== ======= *
 *
 *  uchoice.hpp
 *  Ubit Project
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 / Eric Lecolinet / ENST Paris
 *
 * ***********************************************************************
 * 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.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _uchoice_hpp_
#define _uchoice_hpp_
//pragma ident  "@(#)uchoice.hpp        ubit:05.05.00"
#include <ubit/uprop.hpp>
namespace ubit {

/* ==================================================== ===== ======= */
class UChoice : public UProp {
public:
  UBIT_ATTR_CLASS(UChoice, UProp)

  UChoice();  

  friend UChoice& uchoice() {return *new UChoice;}
  
  virtual ~UChoice();
      
  virtual void clearSelection();
  
  virtual UBox* getSelectedItem() const;
  
  virtual UBox* setSelectedItem(UBox& obj);
  
  virtual int getSelectedIndex() const;
  virtual UBox* setSelectedIndex(int N);
  virtual UBox* getSelectableItem(int N) const;
  virtual UBox* getSelectableItem(const UStr& s, bool ignore_case = true) const;
  enum {
    NO_SELECTION, SINGLE_SELECTION, 
    SINGLE_INTERVAL_SELECTION, MULTIPLE_INTERVAL_SELECTION
  };
  virtual int getSelectionMode() const {return sel_mode;}
  virtual void setSelectionMode(int);
  enum {SELECT_ON_ARM = 1<<0, SELECT_ON_DISARM = 1<<1, SELECT_ON_DRAG = 1<<2};
  virtual int getSelectionStyle() const {return sel_style;}
  virtual void setSelectionStyle(int);
  struct IsSelectable {
    virtual bool operator()(const UBox*) const;
    virtual ~IsSelectable() {}
  };
  
  virtual void setSelectionRule(IsSelectable&);
  virtual void update();  

  // - - - impl - -  - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC

  virtual void putProp(UContext*, UControl*);
  virtual void addingTo(UChild*, UGroup *parent);
  // NB: removingFrom() requires a destructor to be defined
  virtual void removingFrom(UChild*, UGroup *parent);

protected:
  uptr<UCall>  callbacks;
  uptr<UBox>   container;
  uptr<UGroup> last_browsing_group;
  uptr<UGroup> sel_items;
  IsSelectable*is_selectable;
  short sel_mode, sel_style;
  
  virtual void mouseCB(UEvent&);
  virtual void actionCB(UEvent*);
  virtual void changeCB(UEvent*);
  virtual void changed(bool update = true);
  virtual UBox* setSelectedItemImpl(UBox* item, UEvent*);
  virtual UBox* getSelectedItemImpl() const;
#endif
};

/* ==================================================== [Elc] ======= */
/* ==================================================== ===== ======= */
class URadioSelect : public UProp {
public:
  UBIT_ATTR_CLASS(URadioSelect,UProp)

  URadioSelect();
  URadioSelect(UInteger& index);
  friend URadioSelect& uradioSelect() {return *new URadioSelect;}

  virtual ~URadioSelect();
  
  virtual void setCanUnselectMode(bool);
  virtual bool isCanUnselectMode() const;

  virtual void clearSelection();

  virtual UGroup* getSelectedItem() const;

  virtual void setSelectedItem(UGroup&);

  UInteger& index() const {return *pindex;}
  virtual int getSelectedIndex() const;

  virtual void setSelectedIndex(int n);
  virtual void setSelectedIndex(const UInteger& n);

  virtual void update();

  // - - impl  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC

  virtual void changed(bool update = true);
  virtual void changed(UGroup* target);
  virtual void putProp(UContext*, UControl*);
  virtual void addingTo(UChild*, UGroup *parent);
  // NB: removingFrom() requires a destructor to be defined
  virtual void removingFrom(UChild*, UGroup *parent);
  
protected:
  bool can_unselect_mode;
  uptr<UInteger> pindex;
  uptr<UCall> pselect_callback;
  void itemChanged(UEvent&);
  void setIndexImpl();
  void _selectItem(UGroup*);
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---