uedit.hpp

/* ==================================================== ======== ======= *
*
*  uedit.hpp
*  Ubit Project
*  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 _uedit_hpp_
#define _uedit_hpp_
//pragma ident  "@(#)uedit.hpp  ubit:05.05.00"
#include <ubit/uprop.hpp>
namespace ubit {

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

  UEdit();

  friend UEdit& uedit() {return *new UEdit();}

  virtual ~UEdit(); // NOTE: removingFrom() requires a destructor.

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  bool   isEditable() const;
  UEdit& setEditable(bool = true);

  bool   isCaretVisible() const;
  UEdit& setCaretVisible(bool = true);

  UColor* getCaretColor() const;
  UEdit&  setCaretColor(UColor*);
  long getCaretPos() const;
  UEdit& setCaretPos(long pos);
  long getCaretPos(UGroup* container) const;
  UEdit& setCaretPos(long pos, UGroup* container);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  UStr* getCaretStr() const;
  UStr* getCaretStr(int& pos_in_str) const;
  UEdit& setCaretStr(UStr* str);
  UEdit& setCaretStr(UStr* str, int pos_in_str);
  static UStr* getPreviousStr(UStr* from, UGroup* container);
  static UStr* getNextStr(UStr* from, UGroup* container);
  static UStr* getParagraphFirstStr(UStr* from, int& pos, UGroup* container);
  static UStr* getParagraphLastStr(UStr* from, int& pos, UGroup* container);
  // - - - impl - - - - -- - - - - - - - - - - - - - - - - - - - - - - -

  USelection* getSelection(UEvent& e, UStr& sel_text);
  void deleteSelection(USelection* sel, UStr& sel_text, UGroup* container);
  void deletePreviousChar(UGroup* container, UView* view);
  void deleteChar(UGroup* container, UView* view);
  bool nextChar(UGroup* container, UView* view);
  bool previousChar(UGroup* container, UView* view);
  
  void beginningOfLine(UGroup* container, UView* view);
  void endOfLine(UGroup* container, UView* view);
  void previousLine(UGroup* container, UView* view);
  void nextLine(UGroup* container, UView* view);

  virtual void update();

#ifndef NO_DOC
  virtual void putProp(UContext*, UControl*);
  virtual void addingTo(UChild*, UGroup* parent);
  virtual void removingFrom(UChild*, UGroup* parent);
  // NOTE: removingFrom() requires a destructor.
  
  void setCaretStr(UStr*, int pos_in_str, bool update, UView* view);

  // prototypes for non-warped text (UView)
  virtual int getXpos(UContext&, const URegion& r) const;
  virtual void paint(UGraph&, UContext&, const URegion &r) const;

  // prototypes for warped text (UFlowview)
  virtual int getXpos(UContext&, const URegion&, int offset, int cellen) const;
  virtual void paint(UGraph&, UContext&, const URegion&, 
                     int offset, int cellen) const;

private:
    uptr<UCall>  calls;        // callback object
  uptr<UCall>  calls2;        // callback object
  uptr<UColor> caret_color;  // specific color for displaying the caret (if any)
  uptr<UStr>   caret_str;    // the string that contains the caret (if any)
  long caret_pos;             // the position of the caret in 'caret_str'
  bool is_editable, is_visible;
  mutable bool repainted;
  virtual void callbacks(UEvent&);
  virtual void kpressed(UKeyEvent&);
  virtual void mpressed(UMouseEvent&);
  virtual void mreleased(UMouseEvent&);
  virtual void callbacks2(UMouseEvent&);
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */

---