summaryrefslogtreecommitdiffstats
path: root/lib/kofficeui/KoContextCelp.h
blob: 51ea6539d44da94c39ceffb47dac67409f3c629f (plain)
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
/* This file is part of the KDE project
   Copyright (C) 2002, Benoit Vautrin <benoit.vautrin@free.fr>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef __KOCONTEXTHELPACTION_H__
#define __KOCONTEXTHELPACTION_H__

#include <tqwidget.h>
#include <tqbitmap.h>
#include <tqdockwindow.h>

#include <tdeaction.h>
#include <koffice_export.h>
class TQPixmap;
class TQLabel;
class TQSimpleRichText;

class KoVerticalLabel : public TQWidget
{
	Q_OBJECT
  
	
	public:
		KoVerticalLabel( TQWidget* parent = 0, const char* name = 0 );
		~KoVerticalLabel();
		
	public slots:
		void setText( const TQString& text );
		
	protected:
		void paintEvent( TQPaintEvent* );
		
	private:
		TQString m_text;
}; // KoVerticalLabel

class KoHelpNavButton : public TQWidget
{
	Q_OBJECT
  
	
	public:
		enum NavDirection {
			Up,
			Down
		};

		KoHelpNavButton( NavDirection d, TQWidget* parent );

	signals:
		void pressed();
		void released();

	protected:
		void paintEvent( TQPaintEvent* );
		void enterEvent( TQEvent* );
		void leaveEvent( TQEvent* );

	private:
		TQBitmap      m_bitmap;
		bool         m_pressed;
}; // KoHelpNavButton

class KoTinyButton : public TQWidget
{
	Q_OBJECT
  
	
	public:
		enum Action {
			Close,
			Sticky
		};

		KoTinyButton( Action a, TQWidget* parent );

	signals:
		void clicked();
		void toggled( bool );

	protected:
		void paintEvent( TQPaintEvent* );
		void mousePressEvent( TQMouseEvent* );
		void mouseReleaseEvent( TQMouseEvent* );

	private:
		TQBitmap      m_bitmap;
		bool         m_pressed;
		Action       m_action;
		bool         m_toggled;
}; // KoTinyButton

class KoHelpView : public TQWidget
{
	Q_OBJECT
  

	public:
		KoHelpView( TQWidget* parent );
		~KoHelpView();

		void setText( const TQString& text );
		bool eventFilter( TQObject* watched, TQEvent* e );

	signals:
		void linkClicked( const TQString& link );

	protected:
		virtual void mousePressEvent( TQMouseEvent* e );
		virtual void mouseReleaseEvent( TQMouseEvent* e );
		virtual void mouseMoveEvent( TQMouseEvent* e );
		virtual void paintEvent( TQPaintEvent* e );

	private:
		TQSimpleRichText* currentText;
		TQString currentAnchor;
}; // KoHelpView

class KoHelpWidget : public TQWidget
{
	Q_OBJECT
  

	public:
		KoHelpWidget( TQString help, TQWidget* parent );

		void setText( TQString text );
		void timerEvent( TQTimerEvent* );
		void updateButtons();

	signals:
		void linkClicked( const TQString& link );

	public slots:
		void scrollUp();
		void scrollDown();
		void startScrollingUp();
		void startScrollingDown();
		void stopScrolling();

	protected:
		void resizeEvent( TQResizeEvent* );

	private:
		int              m_ypos;
		bool             m_scrollDown;
		TQWidget*         m_helpViewport;
		KoHelpView*      m_helpView;
		KoHelpNavButton* m_upButton;
		KoHelpNavButton* m_downButton;
}; // KoHelpWidget

/**
 * KoContextHelpPopup is the popup displayed by ContextHelpAction.
 */
class KoContextHelpPopup : public TQWidget
{
	Q_OBJECT
  

	public:
		KoContextHelpPopup( TQWidget* parent = 0 );
		~KoContextHelpPopup();

	public slots:
		void setContextHelp( const TQString& title, const TQString& text, const TQPixmap* icon = 0 );
		void setSticky( bool sticky ) { m_isSticky = sticky; }

	protected:
		virtual void mousePressEvent( TQMouseEvent* );
		virtual void mouseMoveEvent( TQMouseEvent* );
		virtual void resizeEvent( TQResizeEvent* );
		virtual void paintEvent( TQPaintEvent* );
		virtual void windowActivationChange( bool );
		virtual void keyPressEvent ( TQKeyEvent* );
		virtual void keyReleaseEvent ( TQKeyEvent* );

	signals:
		void wantsToBeClosed();
		/**
		 * Connect to this signal to receive the href value of the links clicked.
		 */
		void linkClicked( const TQString& link );

	private:
		KoHelpWidget*    m_helpViewer;
		KoVerticalLabel* m_helpTitle;
		TQLabel*          m_helpIcon;
		KoTinyButton*    m_close;
		KoTinyButton*    m_sticky;

		TQPoint           m_mousePos;
		bool             m_isSticky;
}; // KoContextHelpPopup

/**
 * KoContextHelpAction provides a easy to use context help system.
 *
 * This action displays on demand a context help in a popup.
 * The context help is set by the updateHelp slot.
 */
class KOFFICEUI_EXPORT KoContextHelpAction : public TDEToggleAction
{
	Q_OBJECT
  

	public:
		KoContextHelpAction( TDEActionCollection* parentCollection, TQWidget* parent = 0 );
		virtual ~KoContextHelpAction();

	public slots:
		void updateHelp( const TQString& title, const TQString& text, const TQPixmap* icon = 0 );
		void closePopup();

	signals:
		/**
		 * Connect to this signal to receive the href value of the links clicked.
		 */
		void linkClicked( const TQString& link );

	private:
		KoContextHelpPopup* m_popup;
}; // KoContextHelpAction

class KoContextHelpWidget : public TQWidget
{
	Q_OBJECT
  

	public:
		KoContextHelpWidget( TQWidget* parent = 0, const char* name = 0 );
		~KoContextHelpWidget();

	public slots:
		void setContextHelp( const TQString& title, const TQString& text, const TQPixmap* icon = 0 );

	signals:
		/**
		 * Connect to this signal to receive the href value of the links clicked.
		 */
		void linkClicked( const TQString& link );

	private:
		KoHelpWidget*    m_helpViewer;
		KoVerticalLabel* m_helpTitle;
		TQLabel*          m_helpIcon;
}; // KoContextHelpWidget

class KoContextHelpDocker : public TQDockWindow
{
	Q_OBJECT
  

	public:
		KoContextHelpDocker( TQWidget* parent = 0, const char* name = 0 );
		~KoContextHelpDocker();

	public slots:
		void setContextHelp( const TQString& title, const TQString& text, const TQPixmap* icon = 0 );

	signals:
		/**
		 * Connect to this signal to receive the href value of the links clicked.
		 */
		void linkClicked( const TQString& link );

	private:
		KoHelpWidget*    m_helpViewer;
		KoVerticalLabel* m_helpTitle;
		TQLabel*          m_helpIcon;
}; // KoContextHelpDocker

#endif /* __KOCONTEXTHELPACTION_H__ */