uchoice.hpp

/************************************************************************
 *
 *  uchoice.hpp: item chooser in a list
 *  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 _uchoice_hpp_
#define _uchoice_hpp_ 1
#include <ubit/uattr.hpp>
namespace ubit {
  
  class UChoice : public UAttr {
  public:
    UCLASS(UChoice)
    
    UChoice();  
    
    virtual ~UChoice();
    
    virtual void clearSelection();
    
    virtual UBox* getSelectedItem() const;
    
    virtual UBox* setSelectedItem(UBox&);
    
    virtual UBox* setSelectedItem(UBox*);

    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;
    struct IsSelectable {
      virtual bool operator()(const UBox*) const;
      virtual ~IsSelectable() {}
    };
    
    virtual void setSelectionRule(IsSelectable&);
    virtual void update();
    
    // - - - impl - -  - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
    virtual void putProp(UUpdateContext*, UElem&);
    virtual void addingTo(UChild&, UElem& parent);
    virtual void removingFrom(UChild&, UElem& parent);
    // NB: removingFrom() requires a destructor to be defined
    
    /*
    enum {
      NO_SELECTION, SINGLE_SELECTION, 
      SINGLE_INTERVAL_SELECTION, MULTIPLE_INTERVAL_SELECTION
    };
    
    virtual int getSelectionMode() const {return sel_mode;}
    virtual void setSelectionMode(int m) {sel_mode = v;}
     **< gets/sets the current selection mode.
     * no effect with the current version: always in SINGLE_SELECTION mode.
    
    enum {SELECT_ON_DISARM = 1<<0, SELECT_ON_ARM = 1<<1,  SELECT_ON_DRAG = 1<<2};
    
    virtual int getSelectionStyle() const {return sel_style;}
    
     virtual void setSelectionStyle(int);{sel_style = v;}
     **< gets/sets the current selection style.
     * the selection style is an ORed combination of 
     * SELECT_ON_DISARM, SELECT_ON_ARM, SELECT_ON_DRAG
     */
  protected:
    uptr<UCall>  callbacks;
    uptr<UBox>   container;
    uptr<UElem> last_browsing_group;
    uptr<UElem> sel_items;
    IsSelectable*is_selectable;
    //short sel_mode, sel_style;
    virtual void mouseCB(UInputEvent&);
    virtual void actionCB(UInputEvent*);
    virtual void changeCB(UInputEvent*);
    virtual void changed(bool update = true);
    virtual UBox* setSelectedItemImpl(UBox* item, UInputEvent*);
    virtual UBox* getSelectedItemImpl() const;
#endif
  };
  
  inline UChoice& uchoice() {return *new UChoice;}
  
  /* ==================================================== [Elc] ======= */
  class URadioSelect : public UAttr {
  public:
    UCLASS(URadioSelect)
    
    URadioSelect();
    
    URadioSelect(UInt& index);
    
    virtual ~URadioSelect();
    
    virtual void setCanUnselectMode(bool);
    virtual bool isCanUnselectMode() const;
    
    virtual void clearSelection();
    
    virtual UElem* getSelectedItem() const;
    
    virtual void setSelectedItem(UElem&);
    
    UInt& index() const {return *pindex;}
    virtual int getSelectedIndex() const;
    
    virtual void setSelectedIndex(int n);
    virtual void setSelectedIndex(const UInt& n);
    
    virtual void update();
    
    // - - impl  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
    virtual void changed(bool update = true);
    virtual void changed(UElem* target);
    virtual void putProp(UUpdateContext*, UElem&);
    virtual void addingTo(UChild&, UElem& parent);
    virtual void removingFrom(UChild&, UElem& parent);
    // NB: removingFrom() requires a destructor to be defined
    
  protected:
    bool can_unselect_mode;
    uptr<UInt> pindex;
    uptr<UCall> pselect_callback;
    void itemChanged(UInputEvent&);
    void setIndexImpl();
    void _selectItem(UElem*);
#endif
  };
  
  inline URadioSelect& uradioSelect() {return *new URadioSelect();}
  
}
#endif