1 /*-*- c++ -*-********************************************************
2 * wxFTCanvas: a canvas for editing formatted text *
4 * (C) 1998 by Karsten Ballüder (Ballueder@usa.net) *
7 *******************************************************************/
10 - each Object knows its size and how to draw itself
11 - the list is responsible for calculating positions
12 - the draw coordinates for each object are the top left corner
13 - coordinates only get calculated when things get redrawn
14 - during redraw each line gets iterated over twice, first just
15 calculating baselines and positions, second to actually draw it
16 - the cursor position is the position before an object, i.e. if the
17 buffer starts with a text-object, cursor 0,0 is just before the
22 #pragma implementation "wxllist.h"
29 #include <wx/postscrp.h>
32 #define BASELINESTRETCH 12
34 #define VAR(x) cerr << #x"=" << x << endl;
35 #define DBG_POINT(p) cerr << #p << ": " << p.x << ',' << p.y << endl
36 #define TRACE(f) cerr << #f":" << endl;
39 static const char *_t
[] = { "invalid", "text", "cmd", "icon",
43 wxLayoutObjectBase::Debug(void)
46 cerr
<< _t
[GetType()] << ": size=" << GetSize(&bl
).x
<< ","
47 << GetSize(&bl
).y
<< " bl=" << bl
;
51 //-------------------------- wxLayoutObjectText
53 wxLayoutObjectText::wxLayoutObjectText(const String
&txt
)
62 wxLayoutObjectText::GetSize(CoordType
*baseLine
) const
64 if(baseLine
) *baseLine
= m_BaseLine
;
65 return wxPoint(m_Width
, m_Height
);
69 wxLayoutObjectText::Draw(wxDC
&dc
, wxPoint position
, CoordType baseLine
,
73 dc
.GetTextExtent(Str(m_Text
),&m_Width
, &m_Height
, &descent
);
74 //FIXME: wxGTK does not set descent to a descent value yet.
76 descent
= (2*m_Height
)/10; // crude fix
77 m_BaseLine
= m_Height
- descent
;
78 position
.y
+= baseLine
-m_BaseLine
;
80 dc
.DrawText(Str(m_Text
),position
.x
,position
.y
);
81 # ifdef WXLAYOUT_DEBUG
82 // dc.DrawRectangle(position.x, position.y, m_Width, m_Height);
88 wxLayoutObjectText::Debug(void)
90 wxLayoutObjectBase::Debug();
91 cerr
<< " `" << m_Text
<< '\'';
95 //-------------------------- wxLayoutObjectIcon
97 wxLayoutObjectIcon::wxLayoutObjectIcon(wxIcon
*icon
)
103 wxLayoutObjectIcon::Draw(wxDC
&dc
, wxPoint position
, CoordType baseLine
,
106 position
.y
+= baseLine
- m_Icon
->GetHeight();
108 dc
.DrawIcon(m_Icon
,position
.x
,position
.y
);
112 wxLayoutObjectIcon::GetSize(CoordType
*baseLine
) const
115 *baseLine
= m_Icon
->GetHeight();
116 return wxPoint(m_Icon
->GetWidth(), m_Icon
->GetHeight());
119 //-------------------------- wxLayoutObjectCmd
122 wxLayoutObjectCmd::wxLayoutObjectCmd(int size
, int family
, int style
, int
123 weight
, bool underline
,
124 wxColour
const *fg
, wxColour
const *bg
)
127 m_font
= new wxFont(size
,family
,style
,weight
,underline
);
132 wxLayoutObjectCmd::~wxLayoutObjectCmd()
138 wxLayoutObjectCmd::GetStyle(void) const
140 wxLayoutStyleInfo
*si
= new wxLayoutStyleInfo();
143 si
->size
= m_font
->GetPointSize();
144 si
->family
= m_font
->GetFamily();
145 si
->style
= m_font
->GetStyle();
146 si
->underline
= m_font
->GetUnderlined();
147 si
->weight
= m_font
->GetWeight();
149 si
->fg_red
= m_ColourFG
->Red();
150 si
->fg_green
= m_ColourFG
->Green();
151 si
->fg_blue
= m_ColourFG
->Blue();
152 si
->bg_red
= m_ColourBG
->Red();
153 si
->bg_green
= m_ColourBG
->Green();
154 si
->bg_blue
= m_ColourBG
->Blue();
160 wxLayoutObjectCmd::Draw(wxDC
&dc
, wxPoint position
, CoordType lineHeight
,
164 // this get called even when draw==false, so that recalculation
165 // uses right font sizes
168 dc
.SetTextForeground(*m_ColourFG
);
170 dc
.SetTextBackground(*m_ColourBG
);
173 //-------------------------- wxwxLayoutList
175 wxLayoutList::wxLayoutList()
177 m_DefaultSetting
= NULL
;
181 wxLayoutList::~wxLayoutList()
184 delete m_DefaultSetting
;
189 wxLayoutList::LineBreak(void)
191 Insert(new wxLayoutObjectLineBreak
);
192 m_CursorPosition
.x
= 0; m_CursorPosition
.y
++;
196 wxLayoutList::SetFont(int family
, int size
, int style
, int weight
,
197 int underline
, wxColour
const *fg
,
200 if(family
!= -1) m_FontFamily
= family
;
201 if(size
!= -1) m_FontPtSize
= size
;
202 if(style
!= -1) m_FontStyle
= style
;
203 if(weight
!= -1) m_FontWeight
= weight
;
204 if(underline
!= -1) m_FontUnderline
= underline
;
206 if(fg
!= NULL
) m_ColourFG
= fg
;
207 if(bg
!= NULL
) m_ColourBG
= bg
;
210 new wxLayoutObjectCmd(m_FontPtSize
,m_FontFamily
,m_FontStyle
,m_FontWeight
,m_FontUnderline
,
211 m_ColourFG
, m_ColourBG
));
215 wxLayoutList::SetFont(int family
, int size
, int style
, int weight
,
216 int underline
, char const *fg
, char const *bg
)
223 cfg
= wxTheColourDatabase
->FindColour(fg
);
225 cbg
= wxTheColourDatabase
->FindColour(bg
);
227 SetFont(family
,size
,style
,weight
,underline
,cfg
,cbg
);
231 /// for access by wxLayoutWindow:
233 wxLayoutList::GetSize(CoordType
*max_x
, CoordType
*max_y
,
234 CoordType
*lineHeight
)
236 wxASSERT(max_x
); wxASSERT(max_y
); wxASSERT(lineHeight
);
239 *lineHeight
= m_LineHeight
;
243 wxLayoutList::Draw(wxDC
&dc
, bool findObject
, wxPoint
const &findCoords
)
245 wxLayoutObjectList::iterator i
;
247 // in case we need to look for an object
248 wxLayoutObjectBase
*foundObject
= NULL
;
250 // first object in current line
251 wxLayoutObjectList::iterator headOfLine
;
253 // do we need to recalculate current line?
254 bool recalculate
= false;
256 // do we calculate or draw? Either true or false.
258 // drawing parameters:
259 wxPoint position
= wxPoint(0,0);
260 wxPoint position_HeadOfLine
;
261 CoordType baseLine
= m_FontPtSize
;
262 CoordType baseLineSkip
= (BASELINESTRETCH
* baseLine
)/10;
264 // we trace the objects' cursor positions so we can draw the cursor
265 wxPoint cursor
= wxPoint(0,0);
266 // the cursor position inside the object
267 CoordType cursorOffset
= 0;
268 // object under cursor
269 wxLayoutObjectList::iterator cursorObject
= FindCurrentObject(&cursorOffset
);
271 // queried from each object:
272 wxPoint size
= wxPoint(0,0);
273 CoordType objBaseLine
= baseLine
;
274 wxLayoutObjectType type
;
277 wxLayoutObjectText
*tobj
= NULL
;
280 // this is needed for printing to a printer:
281 // only interesting for printer/PS output
282 int pageWidth
, pageHeight
; //GetSize() still needs int at the moment
285 int top
, bottom
, left
, right
;
290 dc
.IsKindOf(CLASSINFO(wxPrinterDC
)) ||
292 dc
.IsKindOf(CLASSINFO(wxPostScriptDC
)))
294 VAR(wxThePrintSetupData
);
296 dc
.GetSize(&pageWidth
, &pageHeight
);
297 dc
.StartDoc(_("Printing..."));
299 margins
.top
= (1*pageHeight
)/10; // 10%
300 margins
.bottom
= (9*pageHeight
)/10; // 90%
301 margins
.left
= (1*pageWidth
)/10;
302 margins
.right
= (9*pageWidth
)/10;
306 margins
.top
= 0; margins
.left
= 0;
310 position
.y
= margins
.right
;
311 position
.x
= margins
.left
;
313 VAR(findObject
); VAR(findCoords
.x
); VAR(findCoords
.y
);
314 // if the cursorobject is a cmd, we need to find the first
316 while(cursorObject
!= end()
317 && (*cursorObject
)->GetType() == WXLO_TYPE_CMD
)
320 headOfLine
= begin();
321 position_HeadOfLine
= position
;
323 // setting up the default:
324 dc
.SetTextForeground( *wxBLACK
);
325 dc
.SetTextBackground( *wxWHITE
);
326 dc
.SetBackgroundMode( wxSOLID
); // to enable setting of text background
327 dc
.SetFont( *wxNORMAL_FONT
);
330 //FIXME: who frees the brush, how long does it need to exist?
333 m_DefaultSetting
->Draw(dc
,wxPoint(0,0),0,true);
334 dc
.SetBackground( wxBrush(* m_DefaultSetting
->GetBGColour(),wxSOLID
));
337 dc
.SetBackground( wxBrush(wxColour("White"), wxSOLID
) );
343 // we calculate everything for drawing a line, then rewind to the
344 // begin of line and actually draw it
352 type
= (*i
)->GetType();
354 // to initialise sizes of objects, we need to call Draw
355 (*i
)->Draw(dc
, position
, baseLine
, draw
);
357 // update coordinates for next object:
358 size
= (*i
)->GetSize(&objBaseLine
);
359 if(findObject
&& draw
) // we need to look for an object
361 if(findCoords
.y
>= position
.y
362 && findCoords
.y
<= position
.y
+size
.y
363 && findCoords
.x
>= position
.x
364 && findCoords
.x
<= position
.x
+size
.x
)
367 findObject
= false; // speeds things up
371 if(m_Editable
&& draw
&& i
== cursorObject
)
373 if(type
== WXLO_TYPE_TEXT
) // special treatment
375 long descent
= 0l; long width
, height
;
376 tobj
= (wxLayoutObjectText
*)*i
;
377 String str
= tobj
->GetText();
378 VAR(m_CursorPosition
.x
); VAR(cursor
.x
);
379 str
= str
.substr(0, cursorOffset
);
381 dc
.GetTextExtent(Str(str
), &width
,&height
, &descent
);
383 VAR(width
); VAR(descent
);
384 dc
.DrawLine(position
.x
+width
,
385 position
.y
+(baseLineSkip
-height
),
386 position
.x
+width
, position
.y
+baseLineSkip
);
390 if(type
== WXLO_TYPE_LINEBREAK
)
391 dc
.DrawLine(0, position
.y
+baseLineSkip
, 0, position
.y
+2*baseLineSkip
);
397 dc
.DrawLine(position
.x
, position
.y
, position
.x
, position
.y
+baseLineSkip
);
399 dc
.DrawLine(position
.x
, position
.y
, position
.x
, position
.y
+size
.y
);
402 dc
.DrawRectangle(position
.x
, position
.y
, size
.x
, size
.y
);
407 // calculate next object's position:
408 position
.x
+= size
.x
;
410 // do we need to increase the line's height?
411 if(size
.y
> baseLineSkip
)
413 baseLineSkip
= size
.y
;
416 if(objBaseLine
> baseLine
)
418 baseLine
= objBaseLine
;
422 // now check whether we have finished handling this line:
423 if(type
== WXLO_TYPE_LINEBREAK
|| i
== tail())
425 if(recalculate
) // do this line again
427 position
.x
= position_HeadOfLine
.x
;
432 if(! draw
) // finished calculating sizes
434 // if the this line needs to go onto a new page, we need
435 // to change pages before drawing it:
436 if(margins
.bottom
!= -1 && position
.y
> margins
.bottom
)
439 position_HeadOfLine
.y
= margins
.top
;
442 // do this line again, this time drawing it
443 position
= position_HeadOfLine
;
448 else // we have drawn a line, so continue calculating next one
452 if(position
.x
+size
.x
> m_MaxX
)
453 m_MaxX
= position
.x
+size
.x
;
454 // is it a linebreak?
455 if(type
== WXLO_TYPE_LINEBREAK
|| i
== tail())
457 position
.x
= margins
.left
;
458 position
.y
+= baseLineSkip
;
459 baseLine
= m_FontPtSize
;
460 objBaseLine
= baseLine
; // not all objects set it
461 baseLineSkip
= (BASELINESTRETCH
* baseLine
)/10;
464 position_HeadOfLine
= position
;
473 #ifdef WXLAYOUT_DEBUG
475 wxLayoutList::Debug(void)
478 wxLayoutObjectList::iterator i
;
481 "------------------------debug start-------------------------" << endl
;
482 for(i
= begin(); i
!= end(); i
++)
488 "-----------------------debug end----------------------------"
490 // show current object:
492 << m_CursorPosition
.x
<< ','
493 << m_CursorPosition
.y
;
495 i
= FindCurrentObject(&offs
);
496 cerr
<< " line length: " << GetLineLength(i
) << " ";
499 cerr
<< "<<no object found>>" << endl
;
500 return; // FIXME we should set cursor position to maximum allowed
503 if((*i
)->GetType() == WXLO_TYPE_TEXT
)
505 cerr
<< " \"" << ((wxLayoutObjectText
*)(*i
))->GetText() << "\", offs: "
509 cerr
<< ' ' << _t
[(*i
)->GetType()] << endl
;
514 /******************** editing stuff ********************/
516 wxLayoutObjectList::iterator
517 wxLayoutList::FindObjectCursor(wxPoint
const &cpos
, CoordType
*offset
)
519 wxPoint cursor
= wxPoint(0,0); // runs along the objects
521 wxLayoutObjectList::iterator i
;
523 #ifdef WXLAYOUT_DEBUG
524 cerr
<< "Looking for object at " << cpos
.x
<< ',' << cpos
.y
<<
527 for(i
= begin(); i
!= end() && cursor
.y
<= cpos
.y
; i
++)
530 if((*i
)->GetType() == WXLO_TYPE_LINEBREAK
)
532 if(cpos
.y
== cursor
.y
)
536 *offset
= (*i
)->CountPositions();
539 cursor
.x
= 0; cursor
.y
++;
542 cursor
.x
+= (width
= (*i
)->CountPositions());
543 if(cursor
.y
== cpos
.y
&& (cursor
.x
> cpos
.x
||
544 ((*i
)->GetType() != WXLO_TYPE_CMD
&& cursor
.x
== cpos
.x
))
548 *offset
= cpos
.x
-(cursor
.x
-width
); // 0==cursor before
550 #ifdef WXLAYOUT_DEBUG
551 cerr
<< " found object at " << cursor
.x
-width
<< ',' <<
552 cursor
.y
<< ", type:" << _t
[(*i
)->GetType()] <<endl
;
557 #ifdef WXLAYOUT_DEBUG
558 cerr
<< " not found" << endl
;
560 return end(); // not found
563 wxLayoutObjectList::iterator
564 wxLayoutList::FindCurrentObject(CoordType
*offset
)
566 wxLayoutObjectList::iterator obj
= end();
568 obj
= FindObjectCursor(m_CursorPosition
, offset
);
569 if(obj
== end()) // not ideal yet
572 if(obj
!= end()) // tail really exists
573 *offset
= (*obj
)->CountPositions(); // at the end of it
579 wxLayoutList::MoveCursor(int dx
, int dy
)
581 CoordType offs
, lineLength
;
582 wxLayoutObjectList::iterator i
;
585 if(dy
> 0 && m_CursorPosition
.y
< m_MaxLine
)
586 m_CursorPosition
.y
+= dy
;
587 else if(dy
< 0 && m_CursorPosition
.y
> 0)
588 m_CursorPosition
.y
+= dy
; // dy is negative
589 if(m_CursorPosition
.y
< 0)
590 m_CursorPosition
.y
= 0;
591 else if (m_CursorPosition
.y
> m_MaxLine
)
592 m_CursorPosition
.y
= m_MaxLine
;
596 i
= FindCurrentObject(&offs
);
597 lineLength
= GetLineLength(i
);
598 if(m_CursorPosition
.x
< lineLength
)
600 m_CursorPosition
.x
++;
606 if(m_CursorPosition
.y
< m_MaxLine
)
608 m_CursorPosition
.y
++;
609 m_CursorPosition
.x
= 0;
613 break; // cannot move there
618 if(m_CursorPosition
.x
> 0)
620 m_CursorPosition
.x
--;
625 if(m_CursorPosition
.y
> 0)
627 m_CursorPosition
.y
--;
628 m_CursorPosition
.x
= 0;
629 i
= FindCurrentObject(&offs
);
630 lineLength
= GetLineLength(i
);
631 m_CursorPosition
.x
= lineLength
;
636 break; // cannot move left any more
640 i
= FindCurrentObject(&offs
);
641 lineLength
= GetLineLength(i
);
642 if(m_CursorPosition
.x
> lineLength
)
643 m_CursorPosition
.x
= lineLength
;
645 #ifdef WXLAYOUT_DEBUG
646 i
= FindCurrentObject(&offs
);
648 << m_CursorPosition
.x
<< ','
649 << m_CursorPosition
.y
;
653 cerr
<< "<<no object found>>" << endl
;
654 return; // FIXME we should set cursor position to maximum allowed
657 if((*i
)->GetType() == WXLO_TYPE_TEXT
)
659 cerr
<< " \"" << ((wxLayoutObjectText
*)(*i
))->GetText() << "\", offs: "
663 cerr
<< ' ' << _t
[(*i
)->GetType()] << endl
;
668 wxLayoutList::Delete(CoordType count
)
678 wxLayoutObjectList::iterator i
;
682 i
= FindCurrentObject(&offs
);
685 #ifdef WXLAYOUT_DEBUG
686 cerr
<< "trying to delete: " << _t
[(*i
)->GetType()] << endl
;
688 if((*i
)->GetType() == WXLO_TYPE_LINEBREAK
)
690 if((*i
)->GetType() == WXLO_TYPE_TEXT
)
692 wxLayoutObjectText
*tobj
= (wxLayoutObjectText
*)*i
;
693 len
= tobj
->CountPositions();
694 // If we find the end of a text object, this means that we
695 // have to delete from the object following it.
699 if((*i
)->GetType() == WXLO_TYPE_TEXT
)
701 offs
= 0; // delete from begin of next string
702 tobj
= (wxLayoutObjectText
*)*i
;
703 len
= tobj
->CountPositions();
711 if(len
<= count
) // delete this object
720 tobj
->GetText().erase(offs
,len
);
721 return; // we are done
724 else // delete the object
726 len
= (*i
)->CountPositions();
727 erase(i
); // after this, i is the iterator for the following object
734 while(count
&& i
!= end());
738 wxLayoutList::Insert(wxLayoutObjectBase
*obj
)
742 wxLayoutObjectList::iterator i
= FindCurrentObject(&offs
);
750 // do we have to split a text object?
751 if((*i
)->GetType() == WXLO_TYPE_TEXT
&& offs
!= 0 && offs
!= (*i
)->CountPositions())
753 wxLayoutObjectText
*tobj
= (wxLayoutObjectText
*) *i
;
754 #ifdef WXLAYOUT_DEBUG
755 cerr
<< "text: '" << tobj
->GetText() << "'" << endl
;
758 String left
= tobj
->GetText().substr(0,offs
); // get part before cursor
760 tobj
->GetText() = tobj
->GetText().substr(offs
,(*i
)->CountPositions()-offs
); // keeps the right half
761 VAR(tobj
->GetText());
763 insert(i
,new wxLayoutObjectText(left
)); // inserts before
767 wxLayoutObjectList::iterator j
= i
; // we want to apend after this object
775 m_CursorPosition
.x
+= obj
->CountPositions();
776 if(obj
->GetType() == WXLO_TYPE_LINEBREAK
)
781 wxLayoutList::Insert(String
const &text
)
783 wxLayoutObjectText
*tobj
= NULL
;
790 wxLayoutObjectList::iterator i
= FindCurrentObject(&offs
);
792 if(i
!= end() && (*i
)->GetType() == WXLO_TYPE_TEXT
)
793 { // insert into an existing text object:
794 TRACE(inserting into existing object
);
795 tobj
= (wxLayoutObjectText
*)*i
;
797 tobj
->GetText().insert(offs
,text
);
799 else // check whether the previous object is text:
801 wxLayoutObjectList::iterator j
= i
;
803 TRACE(checking previous object
);
804 if(0 && j
!= end() && (*j
)->GetType() == WXLO_TYPE_TEXT
)
806 tobj
= (wxLayoutObjectText
*)*i
;
808 tobj
->GetText()+=text
;
810 else // insert a new text object
812 TRACE(creating
new object
);
813 Insert(new wxLayoutObjectText(text
)); //FIXME not too optimal, slow
814 return; // position gets incremented in Insert(obj)
817 m_CursorPosition
.x
+= strlen(text
.c_str());
821 wxLayoutList::GetLineLength(wxLayoutObjectList::iterator i
)
828 // search backwards for beginning of line:
829 while(i
!= begin() && (*i
)->GetType() != WXLO_TYPE_LINEBREAK
)
831 if((*i
)->GetType() == WXLO_TYPE_LINEBREAK
)
833 // now we can start counting:
834 while(i
!= end() && (*i
)->GetType() != WXLO_TYPE_LINEBREAK
)
836 len
+= (*i
)->CountPositions();
843 wxLayoutList::Clear(int family
, int size
, int style
, int weight
,
844 int underline
, char const *fg
, char const *bg
)
846 wxLayoutObjectList::iterator i
= begin();
848 while(i
!= end()) // == while valid
853 m_FontUnderline
= false;
854 m_FontFamily
= family
;
856 m_FontWeight
= weight
;
857 m_ColourFG
= wxTheColourDatabase
->FindColour(fg
);
858 m_ColourBG
= wxTheColourDatabase
->FindColour(bg
);
860 m_Position
= wxPoint(0,0);
861 m_CursorPosition
= wxPoint(0,0);
863 m_LineHeight
= (BASELINESTRETCH
*m_FontPtSize
)/10;
864 m_MaxX
= 0; m_MaxY
= 0;
868 delete m_DefaultSetting
;
869 m_DefaultSetting
= new
870 wxLayoutObjectCmd(m_FontPtSize
,m_FontFamily
,m_FontStyle
,
871 m_FontWeight
,m_FontUnderline
,
872 m_ColourFG
, m_ColourBG
);