samples/widgets/widgets.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Program:     wxWindows Widgets Sample
   3 // Name:        widgets.cpp
   4 // Purpose:     Sample showing most of the simple wxWindows widgets
   5 // Author:      Vadim Zeitlin
   6 // Created:     27.03.01
   7 // Id:          $Id$
   8 // Copyright:   (c) 2001 Vadim Zeitlin
   9 // License:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // for compilers that support precompilation, includes "wx/wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 // for all others, include the necessary headers
  28 #ifndef WX_PRECOMP
  29     #include "wx/app.h"
  30     #include "wx/log.h"
  31     #include "wx/frame.h"
  32     #include "wx/button.h"
  33     #include "wx/checkbox.h"
  34     #include "wx/listbox.h"
  35     #include "wx/statbox.h"
  36     #include "wx/stattext.h"
  37     #include "wx/textctrl.h"
  38 #endif
  39
  40 #include "wx/notebook.h"
  41 #include "wx/sizer.h"
  42
  43 #include "widgets.h"
  44
  45 // ----------------------------------------------------------------------------
  46 // constants
  47 // ----------------------------------------------------------------------------
  48
  49 // control ids
  50 enum
  51 {
  52     Widgets_ClearLog = 100,
  53     Widgets_Quit
  54 };
  55
  56 // ----------------------------------------------------------------------------
  57 // our classes
  58 // ----------------------------------------------------------------------------
  59
  60 // Define a new application type, each program should derive a class from wxApp
  61 class WidgetsApp : public wxApp
  62 {
  63 public:
  64     // override base class virtuals
  65     // ----------------------------
  66
  67     // this one is called on application startup and is a good place for the app
  68     // initialization (doing it here and not in the ctor allows to have an error
  69     // return: if OnInit() returns false, the application terminates)
  70     virtual bool OnInit();
  71 };
  72
  73 // Define a new frame type: this is going to be our main frame
  74 class WidgetsFrame : public wxFrame
  75 {
  76 public:
  77     // ctor(s) and dtor
  78     WidgetsFrame(const wxString& title);
  79     virtual ~WidgetsFrame();
  80
  81 protected:
  82     // event handlers
  83     void OnButtonClearLog(wxCommandEvent& event);
  84     void OnButtonQuit(wxCommandEvent& event);
  85
  86     // initialize the notebook: add all pages to it
  87     void InitNotebook();
  88
  89 private:
  90     // the panel containing everything
  91     wxPanel *m_panel;
  92
  93     // the listbox for logging messages
  94     wxListBox *m_lboxLog;
  95
  96     // the log target we use to redirect messages to the listbox
  97     wxLog *m_logTarget;
  98
  99     // the notebook containing the test pages
 100     wxNotebook *m_notebook;
 101
 102     // and the image list for it
 103     wxImageList *m_imaglist;
 104
 105     // any class wishing to process wxWindows events must use this macro
 106     DECLARE_EVENT_TABLE()
 107 };
 108
 109 // A log target which just redirects the messages to a listbox
 110 class LboxLogger : public wxLog
 111 {
 112 public:
 113     LboxLogger(wxListBox *lbox, wxLog *logOld)
 114     {
 115         m_lbox = lbox;
 116         //m_lbox->Disable(); -- looks ugly under MSW
 117         m_logOld = logOld;
 118     }
 119
 120     virtual ~LboxLogger()
 121     {
 122         wxLog::SetActiveTarget(m_logOld);
 123     }
 124
 125 private:
 126     // implement sink functions
 127     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 128     {
 129         // don't put trace messages into listbox or we can get into infinite
 130         // recursion
 131         if ( level == wxLOG_Trace )
 132         {
 133             if ( m_logOld )
 134             {
 135                 // cast is needed to call protected method
 136                 ((LboxLogger *)m_logOld)->DoLog(level, szString, t);
 137             }
 138         }
 139         else
 140         {
 141             wxLog::DoLog(level, szString, t);
 142         }
 143     }
 144
 145     virtual void DoLogString(const wxChar *szString, time_t t)
 146     {
 147         wxString msg;
 148         TimeStamp(&msg);
 149         msg += szString;
 150
 151         #ifdef __WXUNIVERSAL__
 152             m_lbox->AppendAndEnsureVisible(msg);
 153         #else // other ports don't have this method yet
 154             m_lbox->Append(msg);
 155             m_lbox->SetFirstItem(m_lbox->GetCount() - 1);
 156         #endif
 157     }
 158
 159     // the control we use
 160     wxListBox *m_lbox;
 161
 162     // the old log target
 163     wxLog *m_logOld;
 164 };
 165
 166 // array of pages
 167 WX_DEFINE_ARRAY(WidgetsPage *, ArrayWidgetsPage);
 168
 169 // ----------------------------------------------------------------------------
 170 // misc macros
 171 // ----------------------------------------------------------------------------
 172
 173 IMPLEMENT_APP(WidgetsApp)
 174
 175 // ----------------------------------------------------------------------------
 176 // event tables
 177 // ----------------------------------------------------------------------------
 178
 179 BEGIN_EVENT_TABLE(WidgetsFrame, wxFrame)
 180     EVT_BUTTON(Widgets_ClearLog, WidgetsFrame::OnButtonClearLog)
 181     EVT_BUTTON(Widgets_Quit, WidgetsFrame::OnButtonQuit)
 182 END_EVENT_TABLE()
 183
 184 // ============================================================================
 185 // implementation
 186 // ============================================================================
 187
 188 // ----------------------------------------------------------------------------
 189 // app class
 190 // ----------------------------------------------------------------------------
 191
 192 bool WidgetsApp::OnInit()
 193 {
 194     if ( !wxApp::OnInit() )
 195         return FALSE;
 196
 197     // the reason for having these ifdef's is that I often run two copies of
 198     // this sample side by side and it is useful to see which one is which
 199     wxString title;
 200 #if defined(__WXUNIVERSAL__)
 201     title = _T("wxUniv/");
 202 #endif
 203
 204 #if defined(__WXMSW__)
 205     title += _T("wxMSW");
 206 #elif defined(__WXGTK__)
 207     title += _T("wxGTK");
 208 #else
 209     title += _T("wxWindows");
 210 #endif
 211
 212     wxFrame *frame = new WidgetsFrame(title + _T(" widgets demo"));
 213     frame->Show();
 214
 215     //wxLog::AddTraceMask(_T("listbox"));
 216     //wxLog::AddTraceMask(_T("scrollbar"));
 217
 218     return TRUE;
 219 }
 220
 221 // ----------------------------------------------------------------------------
 222 // WidgetsFrame construction
 223 // ----------------------------------------------------------------------------
 224
 225 WidgetsFrame::WidgetsFrame(const wxString& title)
 226             : wxFrame(NULL, -1, title, wxPoint(0, 50))
 227 {
 228     // init everything
 229     m_lboxLog = (wxListBox *)NULL;
 230     m_logTarget = (wxLog *)NULL;
 231     m_notebook = (wxNotebook *)NULL;
 232     m_imaglist = (wxImageList *)NULL;
 233
 234     // create controls
 235     m_panel = new wxPanel(this, -1);
 236
 237     wxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
 238
 239     // we have 2 panes: notebook which pages demonstrating the controls in the
 240     // upper one and the log window with some buttons in the lower
 241
 242     m_notebook = new wxNotebook(m_panel, -1);
 243     InitNotebook();
 244     wxSizer *sizerUp = new wxNotebookSizer(m_notebook);
 245
 246     // the lower one only has the log listbox and a button to clear it
 247     wxSizer *sizerDown = new wxStaticBoxSizer
 248                              (
 249                                new wxStaticBox(m_panel, -1, _T("&Log window")),
 250                                wxVERTICAL
 251                              );
 252     m_lboxLog = new wxListBox(m_panel, -1);
 253     sizerDown->Add(m_lboxLog, 1, wxGROW | wxALL, 5);
 254     wxBoxSizer *sizerBtns = new wxBoxSizer(wxHORIZONTAL);
 255     wxButton *btn = new wxButton(m_panel, Widgets_ClearLog, _T("Clear &log"));
 256     sizerBtns->Add(btn);
 257     sizerBtns->Add(10, 0); // spacer
 258     btn = new wxButton(m_panel, Widgets_Quit, _T("E&xit"));
 259     sizerBtns->Add(btn);
 260     sizerDown->Add(sizerBtns, 0, wxALL | wxALIGN_RIGHT, 5);
 261
 262     // put everything together
 263     sizerTop->Add(sizerUp, 1, wxGROW | (wxALL & ~(wxTOP | wxBOTTOM)), 10);
 264     sizerTop->Add(0, 5, 0, wxGROW); // spacer in between
 265     sizerTop->Add(sizerDown, 0,  wxGROW | (wxALL & ~wxTOP), 10);
 266
 267     m_panel->SetAutoLayout(TRUE);
 268     m_panel->SetSizer(sizerTop);
 269
 270     sizerTop->Fit(this);
 271     sizerTop->SetSizeHints(this);
 272
 273     // now that everything is created we can redirect the log messages to the
 274     // listbox
 275     m_logTarget = new LboxLogger(m_lboxLog, wxLog::GetActiveTarget());
 276     wxLog::SetActiveTarget(m_logTarget);
 277 }
 278
 279 void WidgetsFrame::InitNotebook()
 280 {
 281     m_imaglist = new wxImageList(32, 32);
 282
 283     ArrayWidgetsPage pages;
 284     wxArrayString labels;
 285
 286     // we need to first create all pages and only then add them to the notebook
 287     // as we need the image list first
 288     WidgetsPageInfo *info = WidgetsPage::ms_widgetPages;
 289     while ( info )
 290     {
 291         WidgetsPage *page = (*info->GetCtor())(m_notebook, m_imaglist);
 292         pages.Add(page);
 293
 294         labels.Add(info->GetLabel());
 295
 296         info = info->GetNext();
 297     }
 298
 299     m_notebook->SetImageList(m_imaglist);
 300
 301     // now do add them
 302     size_t count = pages.GetCount();
 303     for ( size_t n = 0; n < count; n++ )
 304     {
 305         m_notebook->AddPage(
 306                             pages[n],
 307                             labels[n],
 308                             FALSE, // don't select
 309                             n // image id
 310                            );
 311     }
 312 }
 313
 314 WidgetsFrame::~WidgetsFrame()
 315 {
 316     delete m_logTarget;
 317     delete m_imaglist;
 318 }
 319
 320 // ----------------------------------------------------------------------------
 321 // WidgetsFrame event handlers
 322 // ----------------------------------------------------------------------------
 323
 324 void WidgetsFrame::OnButtonQuit(wxCommandEvent& WXUNUSED(event))
 325 {
 326     Close();
 327 }
 328
 329 void WidgetsFrame::OnButtonClearLog(wxCommandEvent& event)
 330 {
 331     m_lboxLog->Clear();
 332 }
 333
 334 // ----------------------------------------------------------------------------
 335 // WidgetsPageInfo
 336 // ----------------------------------------------------------------------------
 337
 338 WidgetsPageInfo *WidgetsPage::ms_widgetPages = NULL;
 339
 340 WidgetsPageInfo::WidgetsPageInfo(Constructor ctor, const wxChar *label)
 341                : m_label(label)
 342 {
 343     m_ctor = ctor;
 344
 345     m_next = WidgetsPage::ms_widgetPages;
 346     WidgetsPage::ms_widgetPages = this;
 347 }
 348
 349 // ----------------------------------------------------------------------------
 350 // WidgetsPage
 351 // ----------------------------------------------------------------------------
 352
 353 WidgetsPage::WidgetsPage(wxNotebook *notebook)
 354            : wxPanel(notebook, -1)
 355 {
 356 }
 357
 358 wxSizer *WidgetsPage::CreateSizerWithText(wxControl *control,
 359                                           wxWindowID id,
 360                                           wxTextCtrl **ppText)
 361 {
 362     wxSizer *sizerRow = new wxBoxSizer(wxHORIZONTAL);
 363     wxTextCtrl *text = new wxTextCtrl(this, id, _T(""));
 364     sizerRow->Add(control, 0, wxRIGHT | wxALIGN_CENTRE_VERTICAL, 5);
 365     sizerRow->Add(text, 1, wxLEFT | wxALIGN_CENTRE_VERTICAL, 5);
 366
 367     if ( ppText )
 368         *ppText = text;
 369
 370     return sizerRow;
 371 }
 372
 373 // create a sizer containing a label and a text ctrl
 374 wxSizer *WidgetsPage::CreateSizerWithTextAndLabel(const wxString& label,
 375                                                   wxWindowID id,
 376                                                   wxTextCtrl **ppText)
 377 {
 378     return CreateSizerWithText(new wxStaticText(this, -1, label), id, ppText);
 379 }
 380
 381 // create a sizer containing a button and a text ctrl
 382 wxSizer *WidgetsPage::CreateSizerWithTextAndButton(wxWindowID idBtn,
 383                                                    const wxString& label,
 384                                                    wxWindowID id,
 385                                                    wxTextCtrl **ppText)
 386 {
 387     return CreateSizerWithText(new wxButton(this, idBtn, label), id, ppText);
 388 }
 389
 390 wxCheckBox *WidgetsPage::CreateCheckBoxAndAddToSizer(wxSizer *sizer,
 391                                                      const wxString& label,
 392                                                      wxWindowID id)
 393 {
 394     wxCheckBox *checkbox = new wxCheckBox(this, id, label);
 395     sizer->Add(checkbox, 0, wxLEFT | wxRIGHT, 5);
 396     sizer->Add(0, 2, 0, wxGROW); // spacer
 397
 398     return checkbox;
 399 }
 400