uedit.hpp

/************************************************************************
 *
 *  uedit.cpp: Text Edition Attribute
 *  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 _uedit_hpp_
#define _uedit_hpp_ 1
#include <ubit/uattr.hpp>
namespace ubit {
  
  class UEdit : public UAttr {
  public:
    UCLASS(UEdit)
    
    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(UElem& container) const;
    UEdit& setCaretPos(long pos, UElem& 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, UElem& container);
    static UStr* getNextStr(UStr* from, UElem& container);
    static UStr* getParagraphFirstStr(UStr* from, int& pos, UElem& container);
    static UStr* getParagraphLastStr(UStr* from, int& pos, UElem& container);
    // - - - impl - - - - -- - - - - - - - - - - - - - - - - - - - - - - -
    
    USelection* getSelection(UInputEvent& e, UStr& sel_text);
    void deleteSelection(USelection* sel, UStr& sel_text, UElem& container);
    void deletePreviousChar(UElem& container, UView* view);
    void deleteChar(UElem& container, UView* view);
    bool nextChar(UElem& container, UView* view);
    bool previousChar(UElem& container, UView* view);
    
    void beginningOfLine(UElem& container, UView* view);
    void endOfLine(UElem& container, UView* view);
    void previousLine(UElem& container, UView* view);
    void nextLine(UElem& container, UView* view);
    
    virtual void update();
    
#ifndef NO_DOC
    virtual void putProp(UUpdateContext*, UElem&);
    virtual void addingTo(UChild&, UElem& parent);
    virtual void removingFrom(UChild&, UElem& parent);
    // NOTE: removingFrom() requires a destructor.
    
    void setCaretStr(UStr*, int pos_in_str, bool update, UView* view);
    
    // prototypes for non-warped text (UView)
    virtual float getXpos(UUpdateContext&, const URect& r) const;
    virtual void  paint(UGraph&, UUpdateContext&, const URect &r) const;
    
    // prototypes for warped text (UFlowview)
    virtual float getXpos(UUpdateContext&, const URect&, int offset, int cellen) const;
    virtual void  paint(UGraph&, UUpdateContext&, const URect&, 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 inputCB(UInputEvent&);
    virtual void kpressed(UKeyEvent&);
    virtual void mpressed(UMouseEvent&);
    virtual void mreleased(UMouseEvent&);
    virtual void callbacks2(UMouseEvent&);
#endif
  };
  
  inline UEdit& uedit() {return *new UEdit();}
  
}
#endif
/* ==================================================== [TheEnd] ======= */