samples/statbar/statbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        statbar.cpp
   3 // Purpose:     wxStatusBar sample
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     04.02.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "statbar.cpp"
  22     #pragma interface "statbar.cpp"
  23 #endif
  24
  25 // For compilers that support precompilation, includes "wx/wx.h".
  26 #include "wx/wxprec.h"
  27
  28 #ifdef __BORLANDC__
  29     #pragma hdrstop
  30 #endif
  31
  32 #if !wxUSE_STATUSBAR
  33     #error "You need to set wxUSE_STATUSBAR to 1 to compile this sample"
  34 #endif // wxUSE_STATUSBAR
  35
  36 // for all others, include the necessary headers
  37 #ifndef WX_PRECOMP
  38     #include "wx/app.h"
  39     #include "wx/frame.h"
  40     #include "wx/statusbr.h"
  41     #include "wx/timer.h"
  42     #include "wx/checkbox.h"
  43     #include "wx/statbmp.h"
  44     #include "wx/menu.h"
  45     #include "wx/msgdlg.h"
  46     #include "wx/textdlg.h"
  47     #include "wx/sizer.h"
  48     #include "wx/stattext.h"
  49     #include "wx/bmpbuttn.h"
  50     #include "wx/dcmemory.h"
  51 #endif
  52
  53 #include "wx/datetime.h"
  54
  55 // define this for the platforms which don't support wxBitmapButton (such as
  56 // Motif), else a wxBitmapButton will be used
  57 #ifdef __WXMOTIF__
  58     #define USE_STATIC_BITMAP
  59 #endif
  60
  61 // ----------------------------------------------------------------------------
  62 // resources
  63 // ----------------------------------------------------------------------------
  64
  65 #ifdef USE_STATIC_BITMAP
  66     #include "green.xpm"
  67     #include "red.xpm"
  68 #endif // USE_STATIC_BITMAP
  69
  70 // ----------------------------------------------------------------------------
  71 // private classes
  72 // ----------------------------------------------------------------------------
  73
  74 // Define a new application type, each program should derive a class from wxApp
  75 class MyApp : public wxApp
  76 {
  77 public:
  78     // override base class virtuals
  79     // ----------------------------
  80
  81     // this one is called on application startup and is a good place for the app
  82     // initialization (doing it here and not in the ctor allows to have an error
  83     // return: if OnInit() returns false, the application terminates)
  84     virtual bool OnInit();
  85 };
  86
  87 // A custom status bar which contains controls, icons &c
  88 class MyStatusBar : public wxStatusBar
  89 {
  90 public:
  91     MyStatusBar(wxWindow *parent);
  92     virtual ~MyStatusBar();
  93
  94     void UpdateClock();
  95
  96     // event handlers
  97     void OnTimer(wxTimerEvent& event) { UpdateClock(); }
  98     void OnSize(wxSizeEvent& event);
  99     void OnToggleClock(wxCommandEvent& event);
 100     void OnButton(wxCommandEvent& event);
 101
 102 private:
 103     // toggle the state of the status bar controls
 104     void DoToggle();
 105
 106     wxBitmap CreateBitmapForButton(bool on = FALSE);
 107
 108     enum
 109     {
 110         Field_Text,
 111         Field_Checkbox,
 112         Field_Bitmap,
 113         Field_Clock,
 114         Field_Max
 115     };
 116
 117     wxTimer m_timer;
 118
 119     wxCheckBox *m_checkbox;
 120 #ifdef USE_STATIC_BITMAP
 121     wxStaticBitmap *m_statbmp;
 122 #else
 123     wxBitmapButton *m_statbmp;
 124 #endif
 125
 126     DECLARE_EVENT_TABLE()
 127 };
 128
 129 // Define a new frame type: this is going to be our main frame
 130 class MyFrame : public wxFrame
 131 {
 132 public:
 133     // ctor(s)
 134     MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
 135     virtual ~MyFrame();
 136
 137     // event handlers (these functions should _not_ be virtual)
 138     void OnQuit(wxCommandEvent& event);
 139     void OnAbout(wxCommandEvent& event);
 140
 141     void OnSetStatusFields(wxCommandEvent& event);
 142     void OnRecreateStatusBar(wxCommandEvent& event);
 143
 144 private:
 145     enum StatBarKind
 146     {
 147         StatBar_Default,
 148         StatBar_Custom,
 149         StatBar_Max
 150     } m_statbarKind;
 151
 152     void DoCreateStatusBar(StatBarKind kind);
 153
 154     wxStatusBar *m_statbarDefault;
 155     MyStatusBar *m_statbarCustom;
 156
 157     // any class wishing to process wxWindows events must use this macro
 158     DECLARE_EVENT_TABLE()
 159 };
 160
 161 // Our about dialog ith its status bar
 162 class MyAboutDialog : public wxDialog
 163 {
 164 public:
 165     MyAboutDialog(wxWindow *parent);
 166 };
 167
 168 // ----------------------------------------------------------------------------
 169 // constants
 170 // ----------------------------------------------------------------------------
 171
 172 // IDs for the controls and the menu commands
 173 enum
 174 {
 175     // menu items
 176     StatusBar_Quit = 1,
 177     StatusBar_SetFields,
 178     StatusBar_Recreate,
 179     StatusBar_About,
 180     StatusBar_Checkbox = 1000
 181 };
 182
 183 static const int BITMAP_SIZE_X = 32;
 184 static const int BITMAP_SIZE_Y = 15;
 185
 186 // ----------------------------------------------------------------------------
 187 // event tables and other macros for wxWindows
 188 // ----------------------------------------------------------------------------
 189
 190 // the event tables connect the wxWindows events with the functions (event
 191 // handlers) which process them. It can be also done at run-time, but for the
 192 // simple menu events like this the static method is much simpler.
 193 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 194     EVT_MENU(StatusBar_Quit,  MyFrame::OnQuit)
 195     EVT_MENU(StatusBar_SetFields, MyFrame::OnSetStatusFields)
 196     EVT_MENU(StatusBar_Recreate, MyFrame::OnRecreateStatusBar)
 197     EVT_MENU(StatusBar_About, MyFrame::OnAbout)
 198 END_EVENT_TABLE()
 199
 200 BEGIN_EVENT_TABLE(MyStatusBar, wxStatusBar)
 201     EVT_SIZE(MyStatusBar::OnSize)
 202     EVT_CHECKBOX(StatusBar_Checkbox, MyStatusBar::OnToggleClock)
 203     EVT_BUTTON(-1, MyStatusBar::OnButton)
 204     EVT_TIMER(-1, MyStatusBar::OnTimer)
 205 END_EVENT_TABLE()
 206
 207 // Create a new application object: this macro will allow wxWindows to create
 208 // the application object during program execution (it's better than using a
 209 // static object for many reasons) and also declares the accessor function
 210 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 211 // not wxApp)
 212 IMPLEMENT_APP(MyApp)
 213
 214 // ============================================================================
 215 // implementation
 216 // ============================================================================
 217
 218 // ----------------------------------------------------------------------------
 219 // the application class
 220 // ----------------------------------------------------------------------------
 221
 222 // `Main program' equivalent: the program execution "starts" here
 223 bool MyApp::OnInit()
 224 {
 225     // create the main application window
 226     MyFrame *frame = new MyFrame("wxStatusBar sample",
 227                                  wxPoint(50, 50), wxSize(450, 340));
 228
 229     // and show it (the frames, unlike simple controls, are not shown when
 230     // created initially)
 231     frame->Show(TRUE);
 232
 233     // success: wxApp::OnRun() will be called which will enter the main message
 234     // loop and the application will run. If we returned FALSE here, the
 235     // application would exit immediately.
 236     return TRUE;
 237 }
 238
 239 // ----------------------------------------------------------------------------
 240 // main frame
 241 // ----------------------------------------------------------------------------
 242
 243 // frame constructor
 244 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
 245        : wxFrame((wxFrame *)NULL, -1, title, pos, size)
 246 {
 247     m_statbarDefault = NULL;
 248     m_statbarCustom = NULL;
 249
 250 #ifdef __WXMAC__
 251     // we need this in order to allow the about menu relocation, since ABOUT is
 252     // not the default id of the about menu
 253     wxApp::s_macAboutMenuItemId = StatusBar_About;
 254 #endif
 255
 256     // create a menu bar
 257     wxMenu *menuFile = new wxMenu;
 258     menuFile->Append(StatusBar_Quit, "E&xit\tAlt-X", "Quit this program");
 259
 260     wxMenu *statbarMenu = new wxMenu;
 261     statbarMenu->Append(StatusBar_SetFields, "&Set field count\tCtrl-C",
 262                         "Set the number of status bar fields");
 263     statbarMenu->Append(StatusBar_Recreate, "&Recreate\tCtrl-R",
 264                         "Toggle status bar format");
 265
 266     wxMenu *helpMenu = new wxMenu;
 267     helpMenu->Append(StatusBar_About, "&About...\tCtrl-A", "Show about dialog");
 268
 269     // now append the freshly created menu to the menu bar...
 270     wxMenuBar *menuBar = new wxMenuBar();
 271     menuBar->Append(menuFile, "&File");
 272     menuBar->Append(statbarMenu, "&Status bar");
 273     menuBar->Append(helpMenu, "&Help");
 274
 275     // ... and attach this menu bar to the frame
 276     SetMenuBar(menuBar);
 277
 278     // create default status bar to start with
 279     CreateStatusBar(2);
 280     SetStatusText("Welcome to wxWindows!");
 281
 282     m_statbarDefault = GetStatusBar();
 283 }
 284
 285 MyFrame::~MyFrame()
 286 {
 287     SetStatusBar(NULL);
 288
 289     delete m_statbarDefault;
 290     delete m_statbarCustom;
 291 }
 292
 293 void MyFrame::DoCreateStatusBar(MyFrame::StatBarKind kind)
 294 {
 295     wxStatusBar *statbarOld = GetStatusBar();
 296     if ( statbarOld )
 297     {
 298         statbarOld->Hide();
 299     }
 300
 301     switch ( kind )
 302     {
 303         case StatBar_Default:
 304             SetStatusBar(m_statbarDefault);
 305             break;
 306
 307         case StatBar_Custom:
 308             if ( !m_statbarCustom )
 309             {
 310                 m_statbarCustom = new MyStatusBar(this);
 311             }
 312             SetStatusBar(m_statbarCustom);
 313             break;
 314
 315         default:
 316             wxFAIL_MSG("unknown stat bar kind");
 317     }
 318
 319     GetStatusBar()->Show();
 320     PositionStatusBar();
 321
 322     m_statbarKind = kind;
 323 }
 324
 325 // event handlers
 326 void MyFrame::OnSetStatusFields(wxCommandEvent& WXUNUSED(event))
 327 {
 328     wxStatusBar *sb = GetStatusBar();
 329
 330     long nFields = wxGetNumberFromUser
 331                    (
 332                     "Select the number of fields in the status bar",
 333                     "Fields:",
 334                     "wxWindows statusbar sample",
 335                     sb->GetFieldsCount(),
 336                     1, 5,
 337                     this
 338                    );
 339
 340     // we don't check if the number changed at all on purpose: calling
 341     // SetFieldsCount() with the same number of fields should be ok
 342     if ( nFields != -1 )
 343     {
 344         static const int widthsFor2Fields[] = { 200, -1 };
 345         static const int widthsFor3Fields[] = { -1, -2, -1 };
 346         static const int widthsFor4Fields[] = { 100, -1, 100, -2, 100 };
 347
 348         static const int *widths[] =
 349         {
 350             NULL,               // 1 field: default
 351             widthsFor2Fields,   // 2 fields: 1 fixed, 1 var
 352             widthsFor3Fields,   // 3 fields: 3 var
 353             widthsFor4Fields,   // 4 fields: 3 fixed, 2 vars
 354             NULL                // 5 fields: default (all have same width)
 355         };
 356
 357         sb->SetFieldsCount(nFields, widths[nFields - 1]);
 358
 359         wxLogStatus(this,
 360                     wxString::Format(wxT("Status bar now has %ld fields"),
 361                                      nFields));
 362     }
 363     else
 364     {
 365         wxLogStatus(this, wxT("Cancelled"));
 366     }
 367 }
 368
 369 void MyFrame::OnRecreateStatusBar(wxCommandEvent& WXUNUSED(event))
 370 {
 371     DoCreateStatusBar(m_statbarKind == StatBar_Custom ? StatBar_Default
 372                                                       : StatBar_Custom);
 373 }
 374
 375 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 376 {
 377     // TRUE is to force the frame to close
 378     Close(TRUE);
 379 }
 380
 381 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 382 {
 383     MyAboutDialog dlg(this);
 384     dlg.ShowModal();
 385 }
 386
 387 // ----------------------------------------------------------------------------
 388 // MyAboutDialog
 389 // ----------------------------------------------------------------------------
 390
 391 MyAboutDialog::MyAboutDialog(wxWindow *parent)
 392              : wxDialog(parent, -1, wxString("About statbar"),
 393                         wxDefaultPosition, wxDefaultSize,
 394                         wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
 395 {
 396     wxStaticText *text = new wxStaticText(this, -1,
 397                                           "wxStatusBar sample\n"
 398                                           "(c) 2000 Vadim Zeitlin");
 399
 400     wxButton *btn = new wxButton(this, wxID_OK, "&Close");
 401
 402     // create the top status bar without the size grip (default style),
 403     // otherwise it looks weird
 404     wxStatusBar *statbarTop = new wxStatusBar(this, -1, 0);
 405     statbarTop->SetFieldsCount(3);
 406     statbarTop->SetStatusText("This is a top status bar", 0);
 407     statbarTop->SetStatusText("in a dialog", 1);
 408     statbarTop->SetStatusText("Great, isn't it?", 2);
 409
 410     wxStatusBar *statbarBottom = new wxStatusBar(this, -1);
 411     statbarBottom->SetFieldsCount(2);
 412     statbarBottom->SetStatusText("This is a bottom status bar", 0);
 413     statbarBottom->SetStatusText("in a dialog", 1);
 414
 415     wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
 416     sizerTop->Add(statbarTop, 0, wxGROW);
 417     sizerTop->Add(-1, 10, 1, wxGROW);
 418     sizerTop->Add(text, 0, wxCENTRE | wxRIGHT | wxLEFT, 20);
 419     sizerTop->Add(-1, 10, 1, wxGROW);
 420     sizerTop->Add(btn, 0, wxCENTRE | wxRIGHT | wxLEFT, 20);
 421     sizerTop->Add(-1, 10, 1, wxGROW);
 422     sizerTop->Add(statbarBottom, 0, wxGROW);
 423
 424     SetAutoLayout(TRUE);
 425     SetSizer(sizerTop);
 426
 427     sizerTop->Fit(this);
 428     sizerTop->SetSizeHints(this);
 429 }
 430
 431 // ----------------------------------------------------------------------------
 432 // MyStatusBar
 433 // ----------------------------------------------------------------------------
 434
 435 #ifdef __VISUALC__
 436     // 'this' : used in base member initializer list -- so what??
 437     #pragma warning(disable: 4355)
 438 #endif
 439
 440 MyStatusBar::MyStatusBar(wxWindow *parent)
 441            : wxStatusBar(parent, -1), m_timer(this), m_checkbox(NULL)
 442 {
 443     static const int widths[Field_Max] = { -1, 150, BITMAP_SIZE_X, 100 };
 444
 445     SetFieldsCount(Field_Max);
 446     SetStatusWidths(Field_Max, widths);
 447
 448     m_checkbox = new wxCheckBox(this, StatusBar_Checkbox, _T("&Toggle clock"));
 449     m_checkbox->SetValue(TRUE);
 450
 451 #ifdef USE_STATIC_BITMAP
 452     m_statbmp = new wxStaticBitmap(this, -1, wxIcon(green_xpm));
 453 #else
 454     m_statbmp = new wxBitmapButton(this, -1, CreateBitmapForButton(),
 455                                    wxDefaultPosition, wxDefaultSize,
 456                                    wxBU_EXACTFIT);
 457 #endif
 458
 459     m_timer.Start(1000);
 460
 461     SetMinHeight(BITMAP_SIZE_Y);
 462
 463     UpdateClock();
 464 }
 465
 466 #ifdef __VISUALC__
 467     #pragma warning(default: 4355)
 468 #endif
 469
 470 MyStatusBar::~MyStatusBar()
 471 {
 472     if ( m_timer.IsRunning() )
 473     {
 474         m_timer.Stop();
 475     }
 476 }
 477
 478 wxBitmap MyStatusBar::CreateBitmapForButton(bool on)
 479 {
 480     static const int BMP_BUTTON_SIZE_X = 10;
 481     static const int BMP_BUTTON_SIZE_Y = 9;
 482
 483     wxBitmap bitmap(BMP_BUTTON_SIZE_X, BMP_BUTTON_SIZE_Y);
 484     wxMemoryDC dc;
 485     dc.SelectObject(bitmap);
 486     dc.SetBrush(on ? *wxGREEN_BRUSH : *wxRED_BRUSH);
 487     dc.SetBackground(*wxLIGHT_GREY_BRUSH);
 488     dc.Clear();
 489     dc.DrawEllipse(0, 0, BMP_BUTTON_SIZE_X, BMP_BUTTON_SIZE_Y);
 490     dc.SelectObject(wxNullBitmap);
 491
 492     return bitmap;
 493 }
 494
 495 void MyStatusBar::OnSize(wxSizeEvent& event)
 496 {
 497     if ( !m_checkbox )
 498         return;
 499
 500     wxRect rect;
 501     GetFieldRect(Field_Checkbox, rect);
 502
 503     m_checkbox->SetSize(rect.x + 2, rect.y + 2, rect.width - 4, rect.height - 4);
 504
 505     GetFieldRect(Field_Bitmap, rect);
 506     wxSize size = m_statbmp->GetSize();
 507
 508     m_statbmp->Move(rect.x + (rect.width - size.x) / 2,
 509                     rect.y + (rect.height - size.y) / 2);
 510
 511     event.Skip();
 512 }
 513
 514 void MyStatusBar::OnButton(wxCommandEvent& WXUNUSED(event))
 515 {
 516     m_checkbox->SetValue(!m_checkbox->GetValue());
 517
 518     DoToggle();
 519 }
 520
 521 void MyStatusBar::OnToggleClock(wxCommandEvent& WXUNUSED(event))
 522 {
 523     DoToggle();
 524 }
 525
 526 void MyStatusBar::DoToggle()
 527 {
 528     if ( m_checkbox->GetValue() )
 529     {
 530         m_timer.Start(1000);
 531
 532 #ifdef USE_STATIC_BITMAP
 533         m_statbmp->SetIcon(wxIcon(green_xpm));
 534 #else
 535         m_statbmp->SetBitmapLabel(CreateBitmapForButton(FALSE));
 536         m_statbmp->Refresh();
 537 #endif
 538
 539         UpdateClock();
 540     }
 541     else // don't show clock
 542     {
 543         m_timer.Stop();
 544
 545 #ifdef USE_STATIC_BITMAP
 546         m_statbmp->SetIcon(wxIcon(red_xpm));
 547 #else
 548         m_statbmp->SetBitmapLabel(CreateBitmapForButton(TRUE));
 549         m_statbmp->Refresh();
 550 #endif
 551
 552         SetStatusText("", Field_Clock);
 553     }
 554 }
 555
 556 void MyStatusBar::UpdateClock()
 557 {
 558     SetStatusText(wxDateTime::Now().FormatTime(), Field_Clock);
 559 }