1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/***************************************************************************
* ktouchslideline.h *
* ----------------- *
* Copyright (C) 2000 by Håvard Frøiland, 2006 by Andreas Nicolai *
* ghorwin@users.sourceforge.net *
* *
* This program is free software; 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. *
***************************************************************************/
#ifndef KTOUCHSLIDELINE_H
#define KTOUCHSLIDELINE_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <tqwidget.h>
#include <tqtimer.h>
class TQPixmap;
class TQPainter;
/// This widget just displays the sliding text.
///
/// KTouchSlideLine is a fire-and-forget widget, so you don't have to care about any
/// drawing details. After the initial setup (setting the font, colours etc.) you simple
/// need to call setNewText() when the teacher text changes or setStudentText() when
/// only the student line has changed. Everything else (including the
/// choice of the background colour) is done by the widget.
///
/// Please refer to the documentation 'sliding_line_widget.pdf' in the doc folder.
class KTouchSlideLine : public TQWidget {
Q_OBJECT
public:
/// Constructor
KTouchSlideLine(TQWidget *parent);
/// Destructor, free memory allocated for the line pixmap.
~KTouchSlideLine();
/// Applies the preferences (font and colours).
/// This function calls setFont() which in turn results in a complete update
/// of the widget and its sliding lines.
/// @see setFont()
void applyPreferences();
/// Sets the teacher and student text (usually called when a new line is started).
/// This function calls updateSlidingLines().
/// @see updateSlidingLines()
void setNewText(const TQString& teacher_text, const TQString& student_text);
/// Sets the student text (called whenever the student string changes).
/// This function calls updateStudentLine().
/// @see updateStudentLine()
void setStudentText(const TQString& text);
/// Changes the font of the slide line widget and updates everything else.
/// This function is called when the font is changed. It updates the size
/// of the sliding lines and the font size accordingly. Then it updates
/// the widget.
/// This function calls resizeFont().
/// @see resizeFont()
void setFont(const TQFont& font);
/// Returns true when the character can be added without problems.
/// This function checks if the new possibly wrong student line
/// would still fit into the student line pixmap and returns
/// false if not.
bool canAddCharacter(const TQString& new_student_text);
public slots:
/// Starts or stops the cursor blinking timer.
void setCursorTimerEnabled(bool on);
private slots:
/// Turns the cursor on or off (this function triggered by the cursor timer).
void toggleCursor();
/// Slides the lines into position (this function is triggered by the sliding timer).
void slide();
protected:
/// Simply updates the widget.
/// This function calls updateSlidingLines() if necessary, otherwise just slide().
/// @see updateSlidingLines()
/// @see slide()
void paintEvent( TQPaintEvent * );
/// Will be called when the widget is resized.
/// This event will first recalculate the geometry of the sliding lines.
/// Then the font size will be updated and through that, the sliding lines will be
/// updated.
void resizeEvent ( TQResizeEvent * );
private:
/// Calculates the correct text length (in pixels) taking trailing spaces into account
int textLen(const TQFontMetrics& fontMetrics, const TQString& text);
/// Will recalculate the font size and related variables depending on the height of the widget.
/// This function calls updateSlidingLines().
/// @see updateSlidingLines()
void resizeFont();
/// Just draws the cursor (if visible)
void drawCursor();
/// Draws the "enter" character at the given position (y is the y-position of the arrow).
void drawEnterChar(TQPainter *painter, int cursorPos, int y, int enterWidth);
/// Recreates the student and teacher pixmaps and updates all related variables.
/// In this function the teacher pixmap is drawn it will not be modified until the next
/// call of updateSlidingLines(). This function also calls updateStudentLine().
/// @see updateStudentLine()
void updateSlidingLines();
/// Redraws the student line alone and updates all related variables.
void updateStudentLine();
TQFont m_font; ///< The font for the sliding lines.
TQString m_teacherText; ///< The teachers text.
TQString m_studentText; ///< The students text.
TQPixmap *m_teacherPixmap; ///< Pixmap used to draw the teacher sliding line, created in updateSlidingLines().
TQPixmap *m_studentPixmap; ///< Pixmap used to draw the student sliding line, created in updateSlidingLines().
TQTimer m_slideTimer; ///< This is the timer for the sliding of the lines.
bool m_cursorVisible; ///< Flag which indicates the current state of the cursor.
TQTimer m_cursorTimer; ///< This is the cursor on/off timer.
TQColor m_cursorColor; ///< Defines the colour of the cursor (when turned on).
TQColor m_cursorBackground; ///< Defines the background colour of the cursor (when turned off).
// variables depending on size of widget, will be updated in resizeEvent()
int m_marginVerWidget; ///< Vertical margin between widget boundary and sliding line in pixels.
int m_slideLineDist; ///< Vertical distance between sliding lines in pixels.
int m_slideLineHeight; ///< Height of a sliding line in pixels.
int m_marginCursor; ///< The margin for cursor movement (minimum distance from left and right ends of slide line boundaries).
// variables depending on font face and size, will be updated in the resizeFont() function
int m_xCharWidth; ///< The width (in pixel) of a small x (used to calculate space width and other stuff).
int m_spaceCharWidth; ///< The width of a space character (in pixel).
int m_cursorHeight; ///< Height of the cursor.
int m_yCursorStudent; ///< Cursor top y coordinate (from top of visible area) in the student line.
// newly defined variables, will be updated on the setNewText() and partially in setStudentText()
int m_marginHorWidget; ///< Horizontal margin between widget boundary and sliding line in pixels.
int m_slideLineWidth; ///< The length of the sliding line in pixels.
int m_cursorRangeLen; ///< Length (in pixel) that the cursor can move between left and right margin.
int m_teacherTextLen; ///< The total length of the teacher line (in pixel) WITHOUT enter character.
int m_correctTextLen; ///< The length of correctly typed text so far (in pixel).
int m_studentTextLen; ///< The total length of text typed (potentially wrong) in the student line (in pixel).
int m_xCursorTeacher; ///< Cursor position (from left side of visible area) in the teacher line.
int m_xCursorTPixmap; ///< Current cursor position in the teacher pixmap (from left in pixels).
int m_xCursorStudent; ///< Cursor position (from left side of visible area) in the student line.
int m_xCursorSPixmap; ///< Current cursor position in the student pixmap (from left in pixels).
int m_xFrameTeacher; ///< The final X-position (position after slide is done) for the copy-frame in the teachers pixmap.
double m_xFrameTeacherCurrent; ///< The current X-position (position after slide is done) for the copy-frame in the teachers pixmap.
int m_xFrameStudent; ///< The final X-position (position after slide is done) for the copy-frame in the students pixmap.
double m_xFrameStudentCurrent; ///< The current X-position (position after slide is done) for the copy-frame in the students pixmap.
};
#endif // KTOUCHSLIDELINE_H
|
