ucontrol.hpp

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

#ifndef _ucontrol_hpp_
#define _ucontrol_hpp_
//pragma ident  "@(#)ucontrol.hpp       ubit:05.05.00"
#include <ubit/ubrick.hpp>
#include <ubit/umode.hpp>
#include <ubit/update.hpp>
namespace ubit {

class UControl: public UBrick { // abstract class
public:
  UControl();

  virtual void update(const UUpdate&) = 0;

  virtual void update() {update(UUpdate::layoutAndPaint);}
  
  virtual void updatePaint() {update(UUpdate::paint);}
  
  virtual void updateView(UEvent&, UView*, const UUpdate&) = 0;
  virtual bool isShown() const;
  bool isShowable() const {return (cmodes & UMode::CAN_SHOW) != 0;}
  bool isEnabled() const;
  virtual void setEnabled(bool state, bool call_callbacks = true);
  void enable(bool state = true) {setEnabled(state);} 
  void disable() {setEnabled(false);} 

  bool isSelected() const {return (cmodes & UMode::SELECTED) != 0;}
  virtual void setSelected(bool state, bool call_callbacks = true);
  void select(bool state, bool call_cb = true) {setSelected(state,call_cb);}
  
  bool isArmed() const;
  
  bool isArmable() const {return (cmodes & UMode::CAN_ARM) != 0;}
  bool isEntered() const;
  bool isActionPerformed() const;
  bool isDragged() const;
  
  // - - - Impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  // inherited from UBrick: hasBmode(), getBmodes(), etc.
  
  UMask getCModes() const {return cmodes;}

  bool hasCMode(UMask modes) const {return (cmodes & modes) != 0;}
    
  void addCModes(UMask modes) {cmodes |= modes;}
  
  void removeCModes(UMask modes) {cmodes &= ~modes;}

  short getInterState() const {return istate;}
  
  void setInterState(short);
  
  // - - - Impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
protected:
  friend class UMode;
  friend class UOn;
  friend class UAppli;
  friend class UEventFlow;
  UMask cmodes;
  short istate;
  
public:
  enum InputType {NORMAL=0, BROWSE=1, TYPE=2};
  
  virtual void enterBehavior(UEventFlow&, UEvent&, int input_type = 0);
  virtual void leaveBehavior(UEventFlow&, UEvent&);
  virtual void keyPressBehavior(UEventFlow&, UEvent&);
  virtual void keyReleaseBehavior(UEventFlow&, UEvent&);
  virtual void armBehavior(UEventFlow&, UEvent&, int input_type = 0);
  virtual bool disarmBehavior(UEventFlow&, UEvent&, int input_type = 0);
  virtual void actionBehavior(UEventFlow&, UEvent&);
  virtual void changeBehavior(UEventFlow&, UEvent&);
};

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

---