Logo ROOT  
Reference Guide
TGTextView.h
Go to the documentation of this file.
1// @(#)root/gui:$Id$
2// Author: Fons Rademakers 1/7/2000
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TGTextView
13#define ROOT_TGTextView
14
15
16//////////////////////////////////////////////////////////////////////////
17// //
18// TGTextView //
19// //
20// A TGTextView is a text viewer widget. It is a specialization of //
21// TGView. It uses the TGText class (which contains all text //
22// manipulation code, i.e. loading a file in memory, changing, //
23// removing lines, etc.). Use a TGTextView to view non-editable text. //
24// For supported messages see TGView. //
25// //
26//////////////////////////////////////////////////////////////////////////
27
28#include "TGView.h"
29#include "TGText.h"
30
31class TViewTimer;
32
33class TGTextView : public TGView {
34
35protected:
36 TGText *fText; // text buffer
37 TGText *fClipText; // clipboard text buffer
38 FontStruct_t fFont; // text font
39 Int_t fMaxAscent; // maximum ascent in font
40 Int_t fMaxDescent; // maximum descent in font
41 Int_t fMaxWidth; // maximum width of character in font
42 TGGC fNormGC; // graphics context for drawing text
43 TGGC fSelGC; // graphics context for drawing marked text
44 TGGC fSelbackGC; // graphics context for drawing marked background
45 Bool_t fMarkedFromX; // true if text is marked from x
46 Bool_t fMarkedFromY; // true if text is marker from y
47 Bool_t fIsMarked; // true if text is marked/selected
48 Bool_t fIsMarking; // true if in marking mode
49 Bool_t fIsSaved; // true is content is saved
50 Bool_t fReadOnly; // text cannot be editted
51 TGLongPosition fMarkedStart; // start position of marked text
52 TGLongPosition fMarkedEnd; // end position of marked text
53 TViewTimer *fScrollTimer; // scrollbar timer
54 Atom_t *fDNDTypeList; // handles DND types
55
56 static const TGFont *fgDefaultFont;
60
61 void Init(Pixel_t bg);
62 virtual void DrawRegion(Int_t x, Int_t y, UInt_t w, UInt_t h);
63 virtual void Mark(Long_t xPos, Long_t yPos);
64 virtual void UnMark();
65 virtual void Copy(TObject &) const { MayNotUse("Copy(TObject &)"); }
66 virtual void HLayout();
67 virtual void VLayout();
68
70 static const TGGC &GetDefaultGC();
71 static const TGGC &GetDefaultSelectedGC();
73
74private:
77
78public:
79 TGTextView(const TGWindow *parent = 0, UInt_t w = 1, UInt_t h = 1, Int_t id = -1,
80 UInt_t sboptions = 0, Pixel_t back = GetWhitePixel());
81 TGTextView(const TGWindow *parent, UInt_t w, UInt_t h, TGText *text,
82 Int_t id = -1, UInt_t sboptions = 0, Pixel_t back = GetWhitePixel());
83 TGTextView(const TGWindow *parent, UInt_t w, UInt_t h, const char *string,
84 Int_t id = -1, UInt_t sboptions = 0, Pixel_t back = GetWhitePixel());
85
86 virtual ~TGTextView();
87
88 virtual Bool_t IsSaved() { fIsSaved = fText->IsSaved(); return fIsSaved;}
89 virtual Long_t ToObjXCoord(Long_t xCoord, Long_t line);
90 virtual Long_t ToObjYCoord(Long_t yCoord);
91 virtual Long_t ToScrXCoord(Long_t xCoord, Long_t line);
92 virtual Long_t ToScrYCoord(Long_t yCoord);
93 virtual void AdjustWidth();
94 virtual Bool_t LoadFile(const char *fname, long startpos = 0, long length = -1);
95 virtual Bool_t LoadBuffer(const char *txtbuf);
96 virtual void Clear(Option_t * = "");
97 virtual Bool_t Copy();
98 virtual Bool_t SelectAll();
99 virtual Bool_t Search(const char *string, Bool_t direction, Bool_t caseSensitive);
100 virtual void SetFont(FontStruct_t font);
105 virtual Long_t ReturnLineCount() { return fText->RowCount(); }
106
107 virtual void SetSBRange(Int_t direction);
108 virtual void SetHsbPosition(Long_t newPos);
109 virtual void SetVsbPosition(Long_t newPos);
110 virtual void ShowBottom();
111 virtual void ShowTop();
112
113 virtual void SavePrimitive(std::ostream &out, Option_t * = "");
114 virtual void SetText(TGText *text);
115 virtual void AddText(TGText *text);
116 virtual void AddLine(const char *string);
117 virtual void AddLineFast(const char *string);
118 virtual void Update();
119 virtual void Layout();
120
121 virtual void SetBackground(Pixel_t p);
122 virtual void SetSelectBack(Pixel_t p);
123 virtual void SetSelectFore(Pixel_t p);
124 virtual void SetForegroundColor(Pixel_t);
125
126 TGText *GetText() const { return fText; }
127
128 virtual void SetReadOnly(Bool_t on = kTRUE) { fReadOnly = on; } //*TOGGLE* *GETTER=IsReadOnly
129 Bool_t IsReadOnly() const { return fReadOnly; }
130 Bool_t IsMarked() const { return fIsMarked; }
131
132 virtual Bool_t HandleDNDDrop(TDNDData *data);
133 virtual Atom_t HandleDNDPosition(Int_t x, Int_t y, Atom_t action,
134 Int_t xroot, Int_t yroot);
135 virtual Atom_t HandleDNDEnter(Atom_t * typelist);
136 virtual Bool_t HandleDNDLeave();
137
138 virtual Bool_t HandleButton(Event_t *event);
139 virtual Bool_t HandleDoubleClick(Event_t *event);
140 virtual Bool_t HandleSelectionClear(Event_t *event);
141 virtual Bool_t HandleSelectionRequest(Event_t *event);
142 virtual Bool_t HandleMotion(Event_t *event);
143 virtual Bool_t HandleTimer(TTimer *t);
144 virtual Bool_t HandleCrossing(Event_t *event);
145
146 virtual void DataChanged() { Emit("DataChanged()"); } //*SIGNAL*
147 virtual void DataDropped(const char *fname) { Emit("DataDropped(char *)", fname); } //*SIGNAL*
148 virtual void Marked(Bool_t mark) { Emit("Marked(Bool_t)", mark); } // *SIGNAL*
149 virtual void Clicked(const char *word) { Emit("Clicked(char *)", word); } //*SIGNAL*
150 virtual void DoubleClicked(const char *word) { Emit("DoubleClicked(char *)", word); } //*SIGNAL*
151
152 ClassDef(TGTextView,0) // Non-editable text viewer widget
153};
154
155
156class TViewTimer : public TTimer {
157private:
159
160 TViewTimer(const TViewTimer&); // not implemented
161 TViewTimer& operator=(const TViewTimer&); // not implemented
162
163public:
165 Bool_t Notify();
166};
167
168
169#endif
Handle_t Atom_t
Definition: GuiTypes.h:36
Handle_t FontStruct_t
Definition: GuiTypes.h:38
ULong_t Pixel_t
Definition: GuiTypes.h:39
#define h(i)
Definition: RSha256.hxx:106
int Int_t
Definition: RtypesCore.h:43
unsigned int UInt_t
Definition: RtypesCore.h:44
long Long_t
Definition: RtypesCore.h:52
bool Bool_t
Definition: RtypesCore.h:61
const Bool_t kTRUE
Definition: RtypesCore.h:89
const char Option_t
Definition: RtypesCore.h:64
#define ClassDef(name, id)
Definition: Rtypes.h:322
Definition: TGFont.h:149
static Pixel_t GetWhitePixel()
Get white pixel value.
Definition: TGFrame.cxx:693
Definition: TGGC.h:31
virtual Long_t ReturnLineLength(Long_t line)
Definition: TGTextView.h:103
virtual void AdjustWidth()
Adjust widget width to longest line.
virtual Bool_t Search(const char *string, Bool_t direction, Bool_t caseSensitive)
Search for string in text.
Definition: TGTextView.cxx:289
Int_t fMaxDescent
Definition: TGTextView.h:40
virtual void Update()
update the whole window of text view
Definition: TGTextView.cxx:261
TGGC fNormGC
Definition: TGTextView.h:42
Int_t fMaxAscent
Definition: TGTextView.h:39
Bool_t fReadOnly
Definition: TGTextView.h:50
TGText * fText
Definition: TGTextView.h:36
virtual void UnMark()
Clear marked region.
virtual Bool_t IsSaved()
Definition: TGTextView.h:88
virtual Long_t ToObjXCoord(Long_t xCoord, Long_t line)
Convert x screen coordinate to column in specified line.
Definition: TGTextView.cxx:391
virtual void SetHsbPosition(Long_t newPos)
Set position of horizontal scrollbar.
virtual Bool_t LoadFile(const char *fname, long startpos=0, long length=-1)
Load a file in the text view widget.
Definition: TGTextView.cxx:453
virtual void Mark(Long_t xPos, Long_t yPos)
Mark a text region from xPos to yPos.
virtual Long_t ReturnLongestLine()
Definition: TGTextView.h:104
virtual void Copy(TObject &) const
Copy this to obj.
Definition: TGTextView.h:65
static TGGC * fgDefaultSelectedGC
Definition: TGTextView.h:58
virtual Long_t ToScrYCoord(Long_t yCoord)
Convert line number to screen coordinate.
Definition: TGTextView.cxx:345
virtual Long_t ReturnLongestLineWidth()
Return width of longest line.
Definition: TGTextView.cxx:271
Int_t fMaxWidth
Definition: TGTextView.h:41
TGText * fClipText
Definition: TGTextView.h:37
virtual Bool_t HandleDoubleClick(Event_t *event)
handle double click
Definition: TGTextView.cxx:901
TGTextView & operator=(const TGTextView &)
virtual Bool_t LoadBuffer(const char *txtbuf)
Load text from a text buffer. Return false in case of failure.
Definition: TGTextView.cxx:470
FontStruct_t fFont
Definition: TGTextView.h:38
virtual void DataDropped(const char *fname)
Definition: TGTextView.h:147
void Init(Pixel_t bg)
Initialize a text view widget.
Definition: TGTextView.cxx:72
virtual Bool_t HandleSelectionRequest(Event_t *event)
Handle request to send current clipboard contents to requestor window.
Definition: TGTextView.cxx:966
Bool_t fIsSaved
Definition: TGTextView.h:49
static const TGGC & GetDefaultSelectedGC()
Return selection graphics context in use.
Bool_t IsMarked() const
Definition: TGTextView.h:130
virtual void SetReadOnly(Bool_t on=kTRUE)
Definition: TGTextView.h:128
virtual Bool_t HandleMotion(Event_t *event)
Handle mouse motion event in the text editor widget.
Definition: TGTextView.cxx:909
static const TGGC & GetDefaultGC()
Return default graphics context in use.
Bool_t fIsMarking
Definition: TGTextView.h:48
virtual void SavePrimitive(std::ostream &out, Option_t *="")
Save a text edit widget as a C++ statement(s) on output stream out.
virtual void AddLine(const char *string)
Add a line of text to the view widget.
Definition: TGTextView.cxx:228
Bool_t fIsMarked
Definition: TGTextView.h:47
virtual Bool_t HandleCrossing(Event_t *event)
Handle mouse crossing event.
Definition: TGTextView.cxx:673
virtual Bool_t HandleSelectionClear(Event_t *event)
Handle selection clear event.
Definition: TGTextView.cxx:955
virtual void Clicked(const char *word)
Definition: TGTextView.h:149
TGGC fSelbackGC
Definition: TGTextView.h:44
virtual void HLayout()
Horizontal layout of widgets (canvas, scrollbar).
virtual Atom_t HandleDNDPosition(Int_t x, Int_t y, Atom_t action, Int_t xroot, Int_t yroot)
Handle Drag position event.
TGGC fSelGC
Definition: TGTextView.h:43
TViewTimer * fScrollTimer
Definition: TGTextView.h:53
static const TGGC & GetDefaultSelectedBackgroundGC()
Return graphics context for highlighted frame background.
virtual Bool_t SelectAll()
Select all text in the viewer.
Definition: TGTextView.cxx:516
TGText * GetText() const
Definition: TGTextView.h:126
virtual void Layout()
Layout the components of view.
virtual void SetForegroundColor(Pixel_t)
Set text color.
Atom_t * fDNDTypeList
Definition: TGTextView.h:54
virtual void SetSelectBack(Pixel_t p)
set selected text background color
Definition: TGTextView.cxx:178
static TGGC * fgDefaultGC
Definition: TGTextView.h:57
virtual void SetVsbPosition(Long_t newPos)
Set position of vertical scrollbar.
TGLongPosition fMarkedEnd
Definition: TGTextView.h:52
virtual void DrawRegion(Int_t x, Int_t y, UInt_t w, UInt_t h)
Draw lines in exposed region.
Definition: TGTextView.cxx:538
virtual Long_t ToScrXCoord(Long_t xCoord, Long_t line)
Convert column number in specified line to screen coordinate.
Definition: TGTextView.cxx:359
virtual void Clear(Option_t *="")
Clear text view widget.
Definition: TGTextView.cxx:429
virtual void VLayout()
Vertical layout of widgets (canvas, scrollbar).
virtual Bool_t HandleDNDLeave()
Handle Drag Leave event.
virtual void Marked(Bool_t mark)
Definition: TGTextView.h:148
static const TGFont * fgDefaultFont
Definition: TGTextView.h:56
virtual void DataChanged()
Definition: TGTextView.h:146
Bool_t IsReadOnly() const
Definition: TGTextView.h:129
Bool_t fMarkedFromY
Definition: TGTextView.h:46
virtual Long_t ReturnLineCount()
Definition: TGTextView.h:105
virtual Bool_t Copy()
Copy selected text to clipboard.
Definition: TGTextView.cxx:485
virtual void DoubleClicked(const char *word)
Definition: TGTextView.h:150
static FontStruct_t GetDefaultFontStruct()
Return default font structure in use.
virtual Atom_t HandleDNDEnter(Atom_t *typelist)
Handle Drag Enter event.
TGTextView(const TGTextView &)
virtual Bool_t HandleTimer(TTimer *t)
Handle scroll timer.
Definition: TGTextView.cxx:718
virtual Long_t ReturnHeighestColHeight()
Definition: TGTextView.h:101
virtual void AddLineFast(const char *string)
Add a line of text to the view widget.
Definition: TGTextView.cxx:250
virtual Bool_t HandleButton(Event_t *event)
Handle mouse button event in text editor.
Definition: TGTextView.cxx:823
virtual ~TGTextView()
Cleanup text view widget.
Definition: TGTextView.cxx:157
virtual void SetFont(FontStruct_t font)
Changes text entry font.
Definition: TGTextView.cxx:332
virtual void SetBackground(Pixel_t p)
set background color
Definition: TGTextView.cxx:168
virtual void ShowBottom()
Show bottom of the page.
virtual void SetSBRange(Int_t direction)
Set the range for the kVertical or kHorizontal scrollbar.
virtual Bool_t HandleDNDDrop(TDNDData *data)
Handle Drop event.
TGLongPosition fMarkedStart
Definition: TGTextView.h:51
virtual void SetText(TGText *text)
Adopt a new text buffer. The text will be deleted by this object.
Definition: TGTextView.cxx:196
Bool_t fMarkedFromX
Definition: TGTextView.h:45
virtual void ShowTop()
Show top of the page.
virtual void AddText(TGText *text)
Add text to the view widget.
Definition: TGTextView.cxx:207
virtual void SetSelectFore(Pixel_t p)
set selected text color
Definition: TGTextView.cxx:187
virtual Long_t ToObjYCoord(Long_t yCoord)
Convert y screen coordinate to line number.
Definition: TGTextView.cxx:383
static const TGGC * fgDefaultSelectedBackgroundGC
Definition: TGTextView.h:59
Definition: TGText.h:67
Long_t RowCount() const
Definition: TGText.h:116
Long_t GetLongestLine() const
Definition: TGText.h:120
Bool_t IsSaved() const
Definition: TGText.h:97
Long_t GetLineLength(Long_t row)
Get length of specified line. Returns -1 if row does not exist.
Definition: TGText.cxx:1042
Definition: TGView.h:43
TGLongPosition fScrollVal
Definition: TGView.h:54
Mother of all ROOT objects.
Definition: TObject.h:37
void MayNotUse(const char *method) const
Use this method to signal that a method (defined in a base class) may not be called in a derived clas...
Definition: TObject.cxx:944
void Emit(const char *signal, const T &arg)
Activate signal with single parameter.
Definition: TQObject.h:164
Handles synchronous and a-synchronous timer events.
Definition: TTimer.h:51
TViewTimer & operator=(const TViewTimer &)
TGView * fView
Definition: TGTextView.h:158
TViewTimer(const TViewTimer &)
TViewTimer(TGView *t, Long_t ms)
Definition: TGTextView.h:164
Bool_t Notify()
Notify when timer times out and reset the timer.
Definition: TGTextView.cxx:59
TText * text
TLine * line
Double_t y[n]
Definition: legend1.C:17
Double_t x[n]
Definition: legend1.C:17
static constexpr double ms
#define mark(osub)
Definition: triangle.c:1206