TGTextEntry.h

Go to the documentation of this file.

// @(#)root/gui:$Id$
// Author: Fons Rademakers   08/01/98
 
/*************************************************************************
 * Copyright (C) 1995-2021, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_TGTextEntry
#define ROOT_TGTextEntry
 
 
#include "TGFrame.h"
#include "TGWidget.h"
#include "TGTextBuffer.h"
 
class TBlinkTimer;
class TGToolTip;
class TColor;
 
class TGTextEntry : public TGFrame, public TGWidget {
 
public:
   enum   EEchoMode { kNormal, kNoEcho, kPassword };
   enum   EInsertMode { kInsert, kReplace };
 
protected:
   TGTextBuffer     *fText;              ///< text buffer
   Int_t             fStartX;            ///< selection begin in pixels
   Int_t             fEndX;              ///< selection end in pixels
   Int_t             fStartIX;           ///< selection begin in characters
   Int_t             fEndIX;             ///< selection end in characters
   Bool_t            fSelectionOn;       ///< selection status (on/off)
   Int_t             fOffset;            ///< start position of text (in pixels)
   Int_t             fCursorX;           ///< cursor position in pixels
   Int_t             fCursorIX;          ///< cursor position in characters
   Bool_t            fCursorOn;          ///< cursor status (on/off)
   FontStruct_t      fFontStruct;        ///< text font
   TGGC              fNormGC;            ///< normal drawing context
   TGGC              fSelGC;             ///< selected text drawing context
   GContext_t        fSelbackGC;         ///< selected background drawing context
   Atom_t            fClipboard;         ///< clipboard property
   TBlinkTimer      *fCurBlink;          ///< cursor blink timer
   TGToolTip        *fTip;               ///< associated tooltip
   Int_t             fMaxLen;            ///< maximum length of text
   Bool_t            fEdited;            ///< kFALSE, if the line edit's contents have not been changed since the construction
   Bool_t            fFrameDrawn;        ///< kTRUE draw itself inside a two-pixel frame, kFALSE draw without any frame
   EEchoMode         fEchoMode;          ///< *OPTION={GetMethod="GetEchoMode";SetMethod="SetEchoMode";Items=(kNormal="Normal",kNoEcho="No Echo",kPassword="Password")}*
   EInsertMode       fInsertMode;        ///< *OPTION={GetMethod="GetInsertMode";SetMethod="SetInsertMode";Items=(kInsert="Insert",kReplace="Replace")}*
   ETextJustification fAlignment;        ///< *OPTION={GetMethod="GetAlignment";SetMethod="SetAlignment";Items=(kTextLeft="Left",kTextCenterX="Center",kTextRight="Right")}*
   Bool_t            fHasOwnFont;        ///< kTRUE - font defined locally,  kFALSE - globally
   UInt_t            fDefWidth;          ///< default width
   UInt_t            fDefHeight;         ///< default height
 
            void        CopyText() const;
            void        DoRedraw() override;
            Int_t       GetCharacterIndex(Int_t xcoord);
   virtual  void        Init();
   virtual  Bool_t      IsCursorOutOfFrame();
            void        Paste();
   virtual  void        PastePrimary(Window_t wid, Atom_t property, Bool_t del);
   virtual  void        ScrollByChar();
   virtual  void        UpdateOffset();
 
   static TString      *fgClipboardText; ///< application clipboard text
   static const TGFont *fgDefaultFont;
   static const TGGC   *fgDefaultSelectedGC;
   static const TGGC   *fgDefaultSelectedBackgroundGC;
   static const TGGC   *fgDefaultGC;
 
   static const TGGC   &GetDefaultSelectedGC();
   static const TGGC   &GetDefaultSelectedBackgroundGC();
 
private:
   TGTextEntry(const TGTextEntry&) = delete;
   TGTextEntry& operator=(const TGTextEntry&) = delete;
 
public:
   static FontStruct_t  GetDefaultFontStruct();
   static const TGGC   &GetDefaultGC();
 
   TGTextEntry(const TGWindow *p, TGTextBuffer *text, Int_t id = -1,
               GContext_t norm = GetDefaultGC()(),
               FontStruct_t font = GetDefaultFontStruct(),
               UInt_t option = kSunkenFrame | kDoubleBorder,
               Pixel_t back = GetWhitePixel());
 
   TGTextEntry(const TGWindow *parent = nullptr, const char *text = nullptr, Int_t id = -1);
   TGTextEntry(const TString &contents, const TGWindow *parent, Int_t id = -1);
 
   ~TGTextEntry() override;
 
            TGDimension GetDefaultSize() const override;
   virtual  void        SetDefaultSize(UInt_t w, UInt_t h);
 
   virtual  void        AppendText(const char *text);
            void        Backspace();
            void        Clear(Option_t *option="") override;
            void        CursorLeft(Bool_t mark = kFALSE , Int_t steps = 1);
            void        CursorRight(Bool_t mark = kFALSE , Int_t steps = 1);
            void        CursorWordForward(Bool_t mark = kFALSE);
            void        CursorWordBackward(Bool_t mark = kFALSE);
            void        Cut();
            void        Del();
            void        Deselect();
            void        DrawBorder() override;
            void        End(Bool_t mark = kFALSE);
   ETextJustification   GetAlignment() const       { return fAlignment; }
   TGTextBuffer        *GetBuffer() const { return fText; }
            Int_t       GetCursorPosition() const  { return fCursorIX; }
            TString     GetDisplayText() const;
   EEchoMode            GetEchoMode() const        { return fEchoMode; }
   EInsertMode          GetInsertMode() const      { return fInsertMode; }
            TString     GetMarkedText() const;
            Int_t       GetMaxLength() const    { return fMaxLen; }
   const    char       *GetText() const { return fText->GetString(); }
   virtual TGToolTip   *GetToolTip() const { return fTip; }
           const char  *GetTitle() const override { return GetText(); }
            Bool_t      HasMarkedText() const  { return fSelectionOn && (fStartIX != fEndIX); }
            Pixel_t     GetTextColor() const { return fNormGC.GetForeground(); }
           FontStruct_t GetFontStruct() const { return fFontStruct; }
            void        Home(Bool_t mark = kFALSE);
   virtual  void        Insert(const char *);
   virtual  void        InsertText(const char *text, Int_t pos);
            Bool_t      IsFrameDrawn() const { return fFrameDrawn; }
            Bool_t      IsEdited() const { return fEdited; }
            void        Layout() override { UpdateOffset(); }
            void        MarkWord(Int_t pos);
            Int_t       MaxMark() const { return fStartIX > fEndIX ? fStartIX : fEndIX; }
            Int_t       MinMark() const { return fStartIX < fEndIX ? fStartIX : fEndIX; }
            void        NewMark(Int_t pos);
            void        Remove();
   virtual  void        RemoveText(Int_t start, Int_t end);
   virtual  void        SetFont(TGFont *font, Bool_t local = kTRUE);
   virtual  void        SetFont(FontStruct_t font, Bool_t local = kTRUE);
   virtual  void        SetFont(const char *fontName, Bool_t local = kTRUE);
   virtual  void        SetTextColor(Pixel_t color, Bool_t local = kTRUE);
   virtual  void        SetTextColor(TColor *color, Bool_t local = kTRUE);
   virtual  void        SetText(const char *text, Bool_t emit = kTRUE);          //*MENU*
   virtual  void        SetToolTipText(const char *text, Long_t delayms = 500);  //*MENU*
   virtual  void        SetMaxLength(Int_t maxlen);                              //*MENU*
   virtual  void        SelectAll();
   virtual  void        SetAlignment(ETextJustification mode = kTextLeft);       //*SUBMENU*
   virtual  void        SetInsertMode(EInsertMode mode = kInsert);               //*SUBMENU*
   virtual  void        SetEchoMode(EEchoMode mode = kNormal);                   //*SUBMENU*
            void        SetEnabled(Bool_t flag = kTRUE) { SetState( flag ); }    //*TOGGLE* *GETTER=IsEnabled
   virtual  void        SetCursorPosition(Int_t pos);
            void        SetEdited(Bool_t flag = kTRUE) { fEdited = flag; }
   virtual  void        SetFocus();
   virtual  void        SetFrameDrawn(Bool_t flag = kTRUE);
   virtual  void        SetState(Bool_t state);
   virtual  void        SetTitle(const char *label) { SetText(label); }
            void        SetForegroundColor(Pixel_t fore) override { SetTextColor(fore, kFALSE); }
            Pixel_t     GetForeground() const override { return fNormGC.GetForeground(); }
            Bool_t      HasOwnFont() const { return fHasOwnFont; }
 
            void        SavePrimitive(std::ostream &out, Option_t *option = "") override;
 
            Bool_t      HandleButton(Event_t *event) override;
            Bool_t      HandleDoubleClick(Event_t *event) override;
            Bool_t      HandleCrossing(Event_t *event) override;
            Bool_t      HandleMotion(Event_t *event) override;
            Bool_t      HandleKey(Event_t *event) override;
            Bool_t      HandleFocusChange(Event_t *event) override;
            Bool_t      HandleSelection(Event_t *event) override;
            Bool_t      HandleSelectionClear(Event_t *event) override;
            Bool_t      HandleSelectionRequest(Event_t *event) override;
            Bool_t      HandleTimer(TTimer *t) override;
            Bool_t      HandleConfigureNotify(Event_t *event) override;
 
   virtual  void        TextChanged(const char *text = nullptr);//*SIGNAL*
   virtual  void        ReturnPressed();                        //*SIGNAL*
   virtual  void        TabPressed();                           //*SIGNAL*
   virtual  void        ShiftTabPressed();                      //*SIGNAL*
   virtual  void        CursorOutLeft();                        //*SIGNAL*
   virtual  void        CursorOutRight();                       //*SIGNAL*
   virtual  void        CursorOutUp();                          //*SIGNAL*
   virtual  void        CursorOutDown();                        //*SIGNAL*
   virtual  void        DoubleClicked();                        //*SIGNAL*
 
   ClassDefOverride(TGTextEntry,0) // The TGTextEntry widget is a simple line editor for inputting text
};
 
#endif