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