Code cleaning: wxID_ANY, wxDefaultSize, wxDefaultPosition, true, false, wxEmptyString...
[wxWidgets.git] / src / generic / statusbr.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: generic/statusbr.cpp
3 // Purpose: wxStatusBarGeneric class implementation
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
13 #pragma implementation "statusbr.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif
22
23 #if wxUSE_STATUSBAR
24
25 #ifndef WX_PRECOMP
26 #include "wx/setup.h"
27 #include "wx/frame.h"
28 #include "wx/settings.h"
29 #include "wx/dcclient.h"
30 #endif
31
32 #ifdef __WXGTK20__
33 #include "wx/gtk/private.h"
34 #include "wx/gtk/win_gtk.h"
35 #endif
36
37 #include "wx/statusbr.h"
38
39 // we only have to do it here when we use wxStatusBarGeneric in addition to the
40 // standard wxStatusBar class, if wxStatusBarGeneric is the same as
41 // wxStatusBar, then the corresponding IMPLEMENT_DYNAMIC_CLASS is already in
42 // common/statbar.cpp
43 #if defined(__WXMAC__) || \
44 (defined(wxUSE_NATIVE_STATUSBAR) && wxUSE_NATIVE_STATUSBAR)
45 #include "wx/generic/statusbr.h"
46
47 IMPLEMENT_DYNAMIC_CLASS(wxStatusBarGeneric, wxWindow)
48 #endif // wxUSE_NATIVE_STATUSBAR
49
50 BEGIN_EVENT_TABLE(wxStatusBarGeneric, wxWindow)
51 EVT_PAINT(wxStatusBarGeneric::OnPaint)
52 EVT_LEFT_DOWN(wxStatusBarGeneric::OnLeftDown)
53 EVT_RIGHT_DOWN(wxStatusBarGeneric::OnRightDown)
54 EVT_SYS_COLOUR_CHANGED(wxStatusBarGeneric::OnSysColourChanged)
55 END_EVENT_TABLE()
56
57 // Default status border dimensions
58 #define wxTHICK_LINE_BORDER 2
59 #define wxTHICK_LINE_WIDTH 1
60
61 void wxStatusBarGeneric::Init()
62 {
63 m_borderX = wxTHICK_LINE_BORDER;
64 m_borderY = wxTHICK_LINE_BORDER;
65 }
66
67 wxStatusBarGeneric::~wxStatusBarGeneric()
68 {
69 // VZ: what is this for? please comment...
70 #ifdef __WXMSW__
71 SetFont(wxNullFont);
72 #endif // MSW
73 }
74
75 bool wxStatusBarGeneric::Create(wxWindow *parent,
76 wxWindowID id,
77 long style,
78 const wxString& name)
79 {
80 if ( !wxWindow::Create(parent, id,
81 wxDefaultPosition, wxDefaultSize,
82 style | wxTAB_TRAVERSAL, name) )
83 return false;
84
85 // The status bar should have a themed background
86 SetThemeEnabled( true );
87
88 // Don't wish this to be found as a child
89 #ifndef __WXMAC__
90 parent->GetChildren().DeleteObject(this);
91 #endif
92 InitColours();
93
94 SetFont(m_defaultStatusBarFont);
95
96 // Set the height according to the font and the border size
97 wxClientDC dc(this);
98 dc.SetFont(GetFont());
99
100 wxCoord y;
101 dc.GetTextExtent(_T("X"), NULL, &y );
102
103 int height = (int)( (11*y)/10 + 2*GetBorderY());
104
105 SetSize(wxDefaultPosition.x, wxDefaultPosition.y, wxDefaultSize.x, height);
106
107 SetFieldsCount(1);
108
109 return true;
110 }
111
112
113 wxSize wxStatusBarGeneric::DoGetBestSize() const
114 {
115 int width, height;
116
117 // best width is the width of the parent
118 GetParent()->GetClientSize(&width, NULL);
119
120 // best height is as calculated above in Create
121 wxClientDC dc((wxWindow*)this);
122 dc.SetFont(GetFont());
123 wxCoord y;
124 dc.GetTextExtent(_T("X"), NULL, &y );
125 height = (int)( (11*y)/10 + 2*GetBorderY());
126
127 return wxSize(width, height);
128 }
129
130 void wxStatusBarGeneric::SetFieldsCount(int number, const int *widths)
131 {
132 wxASSERT_MSG( number >= 0, _T("negative number of fields in wxStatusBar?") );
133
134 int i;
135 for(i = m_nFields; i < number; ++i)
136 m_statusStrings.Add( wxEmptyString );
137
138 for (i = m_nFields - 1; i >= number; --i)
139 m_statusStrings.RemoveAt(i);
140
141 m_nFields = number;
142
143 wxASSERT_MSG( m_nFields == (int)m_statusStrings.GetCount(),
144 _T("This really should never happen, can we do away with m_nFields here?") );
145
146 SetStatusWidths(number, widths);
147 }
148
149 void wxStatusBarGeneric::SetStatusText(const wxString& text, int number)
150 {
151 wxCHECK_RET( (number >= 0) && (number < m_nFields),
152 _T("invalid status bar field index") );
153
154 wxString oldText = m_statusStrings[number];
155 if (oldText != text)
156 {
157 m_statusStrings[number] = text;
158
159 wxRect rect;
160 GetFieldRect(number, rect);
161
162 Refresh( true, &rect );
163 }
164 }
165
166 wxString wxStatusBarGeneric::GetStatusText(int n) const
167 {
168 wxCHECK_MSG( (n >= 0) && (n < m_nFields), wxEmptyString,
169 _T("invalid status bar field index") );
170
171 return m_statusStrings[n];
172 }
173
174 void wxStatusBarGeneric::SetStatusWidths(int n, const int widths_field[])
175 {
176 // only set status widths, when n == number of statuswindows
177 wxCHECK_RET( n == m_nFields, _T("status bar field count mismatch") );
178
179 // delete the old widths in any case - this function may be used to reset
180 // the widths to the default (all equal)
181 // MBN: this is incompatible with at least wxMSW and wxMAC and not
182 // documented, but let's keep it for now
183 ReinitWidths();
184
185 // forget the old cached pixel widths
186 m_widthsAbs.Empty();
187
188 if ( !widths_field )
189 {
190 // not an error, see the comment above
191 Refresh();
192 return;
193 }
194
195 wxStatusBarBase::SetStatusWidths(n, widths_field);
196 }
197
198 void wxStatusBarGeneric::OnPaint(wxPaintEvent& WXUNUSED(event) )
199 {
200 wxPaintDC dc(this);
201
202 #ifdef __WXGTK20__
203 // Draw grip first
204 if (HasFlag( wxST_SIZEGRIP ))
205 {
206 int width, height;
207 GetClientSize(&width, &height);
208
209 gtk_paint_resize_grip( m_widget->style,
210 GTK_PIZZA(m_wxwindow)->bin_window,
211 (GtkStateType) GTK_WIDGET_STATE (m_widget),
212 NULL,
213 m_widget,
214 "statusbar",
215 GDK_WINDOW_EDGE_SOUTH_EAST,
216 width-height-2, 1, height-2, height-3 );
217
218 }
219 #endif
220
221 if (GetFont().Ok())
222 dc.SetFont(GetFont());
223
224 dc.SetBackgroundMode(wxTRANSPARENT);
225
226 #ifdef __WXPM__
227 wxColour vColor;
228
229 vColor = wxSystemSettings::GetColour(wxSYS_COLOUR_MENUBAR);
230 ::WinFillRect(dc.m_hPS, &dc.m_vRclPaint, vColor.GetPixel());
231 #endif
232
233 for (int i = 0; i < m_nFields; i ++)
234 DrawField(dc, i);
235 }
236
237 void wxStatusBarGeneric::DrawFieldText(wxDC& dc, int i)
238 {
239 int leftMargin = 2;
240
241 wxRect rect;
242 GetFieldRect(i, rect);
243
244 wxString text(GetStatusText(i));
245
246 long x, y;
247
248 dc.GetTextExtent(text, &x, &y);
249
250 int xpos = rect.x + leftMargin;
251 int ypos = (int) (((rect.height - y) / 2 ) + rect.y + 0.5) ;
252
253 #if defined( __WXGTK__ ) || defined(__WXMAC__)
254 xpos++;
255 ypos++;
256 #endif
257
258 dc.SetClippingRegion(rect.x, rect.y, rect.width, rect.height);
259
260 dc.DrawText(text, xpos, ypos);
261
262 dc.DestroyClippingRegion();
263 }
264
265 void wxStatusBarGeneric::DrawField(wxDC& dc, int i)
266 {
267 wxRect rect;
268 GetFieldRect(i, rect);
269
270 // Draw border
271 // Have grey background, plus 3-d border -
272 // One black rectangle.
273 // Inside this, left and top sides - dark grey. Bottom and right -
274 // white.
275
276 dc.SetPen(m_hilightPen);
277
278 #ifndef __WXPM__
279
280 // Right and bottom white lines
281 dc.DrawLine(rect.x + rect.width, rect.y,
282 rect.x + rect.width, rect.y + rect.height);
283 dc.DrawLine(rect.x + rect.width, rect.y + rect.height,
284 rect.x, rect.y + rect.height);
285
286 dc.SetPen(m_mediumShadowPen);
287
288 // Left and top grey lines
289 dc.DrawLine(rect.x, rect.y + rect.height,
290 rect.x, rect.y);
291 dc.DrawLine(rect.x, rect.y,
292 rect.x + rect.width, rect.y);
293 #else
294
295 dc.DrawLine(rect.x + rect.width, rect.height + 2,
296 rect.x, rect.height + 2);
297 dc.DrawLine(rect.x + rect.width, rect.y,
298 rect.x + rect.width, rect.y + rect.height);
299
300 dc.SetPen(m_mediumShadowPen);
301 dc.DrawLine(rect.x, rect.y,
302 rect.x + rect.width, rect.y);
303 dc.DrawLine(rect.x, rect.y + rect.height,
304 rect.x, rect.y);
305
306 #endif
307
308 DrawFieldText(dc, i);
309 }
310
311 // Get the position and size of the field's internal bounding rectangle
312 bool wxStatusBarGeneric::GetFieldRect(int n, wxRect& rect) const
313 {
314 wxCHECK_MSG( (n >= 0) && (n < m_nFields), false,
315 _T("invalid status bar field index") );
316
317 // FIXME: workarounds for OS/2 bugs have nothing to do here (VZ)
318 int width, height;
319 #ifdef __WXPM__
320 GetSize(&width, &height);
321 #else
322 GetClientSize(&width, &height);
323 #endif
324
325 // we cache m_widthsAbs between calls and recompute it if client
326 // width has changed (or when it is initially empty)
327 if ( m_widthsAbs.IsEmpty() || (m_lastClientWidth != width) )
328 {
329 wxConstCast(this, wxStatusBarGeneric)->
330 m_widthsAbs = CalculateAbsWidths(width);
331 // remember last width for which we have recomputed the widths in pixels
332 wxConstCast(this, wxStatusBarGeneric)->
333 m_lastClientWidth = width;
334 }
335
336 rect.x = 0;
337 for ( int i = 0; i < n; i++ )
338 {
339 rect.x += m_widthsAbs[i];
340 }
341
342 rect.x += m_borderX;
343 rect.y = m_borderY;
344
345 rect.width = m_widthsAbs[n] - 2*m_borderX;
346 rect.height = height - 2*m_borderY;
347
348 return true;
349 }
350
351 // Initialize colours
352 void wxStatusBarGeneric::InitColours()
353 {
354 // Shadow colours
355 #if defined(__WIN95__) || defined(__WXMAC__)
356 wxColour mediumShadowColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW));
357 m_mediumShadowPen = wxPen(mediumShadowColour, 1, wxSOLID);
358
359 wxColour hilightColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DHILIGHT));
360 m_hilightPen = wxPen(hilightColour, 1, wxSOLID);
361 #elif defined(__WXPM__)
362 m_mediumShadowPen = wxPen(wxColour(127, 127, 127), 1, wxSOLID);
363 m_hilightPen = wxPen("WHITE", 1, wxSOLID);
364
365 wxColour vColour;
366
367 vColour.Set(wxString("LIGHT GREY"));
368 SetBackgroundColour(vColour);
369 vColour.Set(wxString("BLACK"));
370 SetForegroundColour(vColour);
371 m_defaultStatusBarFont = *wxSMALL_FONT;
372 #else
373 m_mediumShadowPen = wxPen("GREY", 1, wxSOLID);
374 m_hilightPen = wxPen("WHITE", 1, wxSOLID);
375 #endif
376
377 #ifndef __WXPM__
378 m_defaultStatusBarFont = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
379 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
380 #endif
381 }
382
383 // Responds to colour changes, and passes event on to children.
384 void wxStatusBarGeneric::OnSysColourChanged(wxSysColourChangedEvent& event)
385 {
386 InitColours();
387 Refresh();
388
389 // Propagate the event to the non-top-level children
390 wxWindow::OnSysColourChanged(event);
391 }
392
393 void wxStatusBarGeneric::SetMinHeight(int height)
394 {
395 // check that this min height is not less than minimal height for the
396 // current font
397 wxClientDC dc(this);
398 wxCoord y;
399 dc.GetTextExtent( wxT("X"), NULL, &y );
400
401 if ( height > (11*y)/10 )
402 {
403 SetSize(wxDefaultPosition.x, wxDefaultPosition.y, wxDefaultSize.x, height + 2*m_borderY);
404 }
405 }
406
407 void wxStatusBarGeneric::OnLeftDown(wxMouseEvent& event)
408 {
409 #ifdef __WXGTK20__
410 int width, height;
411 GetClientSize(&width, &height);
412
413 if (HasFlag( wxST_SIZEGRIP ) && (event.GetX() > width-height))
414 {
415 GtkWidget *ancestor = gtk_widget_get_toplevel( m_widget );
416
417 if (!GTK_IS_WINDOW (ancestor))
418 return;
419
420 GdkWindow *source = GTK_PIZZA(m_wxwindow)->bin_window;
421
422 int org_x = 0;
423 int org_y = 0;
424 gdk_window_get_origin( source, &org_x, &org_y );
425
426 gtk_window_begin_resize_drag (GTK_WINDOW (ancestor),
427 GDK_WINDOW_EDGE_SOUTH_EAST,
428 1,
429 org_x + event.GetX(),
430 org_y + event.GetY(),
431 0);
432 }
433 else
434 {
435 event.Skip( true );
436 }
437 #else
438 event.Skip( true );
439 #endif
440 }
441
442 void wxStatusBarGeneric::OnRightDown(wxMouseEvent& event)
443 {
444 #ifdef __WXGTK20__
445 int width, height;
446 GetClientSize(&width, &height);
447
448 if (HasFlag( wxST_SIZEGRIP ) && (event.GetX() > width-height))
449 {
450 GtkWidget *ancestor = gtk_widget_get_toplevel( m_widget );
451
452 if (!GTK_IS_WINDOW (ancestor))
453 return;
454
455 GdkWindow *source = GTK_PIZZA(m_wxwindow)->bin_window;
456
457 int org_x = 0;
458 int org_y = 0;
459 gdk_window_get_origin( source, &org_x, &org_y );
460
461 gtk_window_begin_move_drag (GTK_WINDOW (ancestor),
462 2,
463 org_x + event.GetX(),
464 org_y + event.GetY(),
465 0);
466 }
467 else
468 {
469 event.Skip( true );
470 }
471 #else
472 event.Skip( true );
473 #endif
474 }
475
476 #endif // wxUSE_STATUSBAR
477