src/generic/choicbkg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/choicbkg.cpp
   3 // Purpose:     generic implementation of wxChoicebook
   4 // Author:      Vadim Zeitlin
   5 // Modified by: Wlodzimierz ABX Skiba from generic/listbkg.cpp
   6 // Created:     15.09.04
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin, Wlodzimierz Skiba
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_CHOICEBOOK
  28
  29 #include "wx/choicebk.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/settings.h"
  33     #include "wx/choice.h"
  34     #include "wx/sizer.h"
  35 #endif
  36
  37 #include "wx/imaglist.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // various wxWidgets macros
  41 // ----------------------------------------------------------------------------
  42
  43 // check that the page index is valid
  44 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
  45
  46 // ----------------------------------------------------------------------------
  47 // event table
  48 // ----------------------------------------------------------------------------
  49
  50 IMPLEMENT_DYNAMIC_CLASS(wxChoicebook, wxBookCtrlBase)
  51
  52 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, wxBookCtrlEvent );
  53 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED,  wxBookCtrlEvent );
  54
  55 BEGIN_EVENT_TABLE(wxChoicebook, wxBookCtrlBase)
  56     EVT_CHOICE(wxID_ANY, wxChoicebook::OnChoiceSelected)
  57 END_EVENT_TABLE()
  58
  59 // ============================================================================
  60 // wxChoicebook implementation
  61 // ============================================================================
  62
  63 // ----------------------------------------------------------------------------
  64 // wxChoicebook creation
  65 // ----------------------------------------------------------------------------
  66
  67 void wxChoicebook::Init()
  68 {
  69     m_selection = wxNOT_FOUND;
  70 }
  71
  72 bool
  73 wxChoicebook::Create(wxWindow *parent,
  74                      wxWindowID id,
  75                      const wxPoint& pos,
  76                      const wxSize& size,
  77                      long style,
  78                      const wxString& name)
  79 {
  80     if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
  81     {
  82         style |= wxBK_TOP;
  83     }
  84
  85     // no border for this control, it doesn't look nice together with
  86     // wxChoice border
  87     style &= ~wxBORDER_MASK;
  88     style |= wxBORDER_NONE;
  89
  90     if ( !wxControl::Create(parent, id, pos, size, style,
  91                             wxDefaultValidator, name) )
  92         return false;
  93
  94     m_bookctrl = new wxChoice
  95                  (
  96                     this,
  97                     wxID_ANY,
  98                     wxDefaultPosition,
  99                     wxDefaultSize
 100                  );
 101
 102     wxSizer* mainSizer = new wxBoxSizer(IsVertical() ? wxVERTICAL : wxHORIZONTAL);
 103
 104     if (style & wxBK_RIGHT || style & wxBK_BOTTOM)
 105         mainSizer->Add(0, 0, 1, wxEXPAND, 0);
 106
 107     m_controlSizer = new wxBoxSizer(IsVertical() ? wxHORIZONTAL : wxVERTICAL);
 108     m_controlSizer->Add(m_bookctrl, 1, (IsVertical() ? wxALIGN_CENTRE_VERTICAL : wxALIGN_CENTRE) |wxGROW, 0);
 109     mainSizer->Add(m_controlSizer, 0, (IsVertical() ? (int) wxGROW : (int) wxALIGN_CENTRE_VERTICAL)|wxALL, m_controlMargin);
 110     SetSizer(mainSizer);
 111     return true;
 112 }
 113
 114 // ----------------------------------------------------------------------------
 115 // accessing the pages
 116 // ----------------------------------------------------------------------------
 117
 118 bool wxChoicebook::SetPageText(size_t n, const wxString& strText)
 119 {
 120     GetChoiceCtrl()->SetString(n, strText);
 121
 122     return true;
 123 }
 124
 125 wxString wxChoicebook::GetPageText(size_t n) const
 126 {
 127     return GetChoiceCtrl()->GetString(n);
 128 }
 129
 130 int wxChoicebook::GetPageImage(size_t WXUNUSED(n)) const
 131 {
 132     return wxNOT_FOUND;
 133 }
 134
 135 bool wxChoicebook::SetPageImage(size_t WXUNUSED(n), int WXUNUSED(imageId))
 136 {
 137     // fail silently, the code may be written to use one of several book
 138     // classes and call SetPageImage() unconditionally, it's better to just
 139     // ignore it (which is the best we can do short of rewriting this class to
 140     // use wxBitmapComboBox anyhow) than complain loudly about a rather
 141     // harmless problem
 142
 143     return false;
 144 }
 145
 146 // ----------------------------------------------------------------------------
 147 // miscellaneous other stuff
 148 // ----------------------------------------------------------------------------
 149
 150 void wxChoicebook::DoSetWindowVariant(wxWindowVariant variant)
 151 {
 152     wxBookCtrlBase::DoSetWindowVariant(variant);
 153     if (m_bookctrl)
 154         m_bookctrl->SetWindowVariant(variant);
 155 }
 156
 157 void wxChoicebook::SetImageList(wxImageList *imageList)
 158 {
 159     // TODO: can be implemented in form of static bitmap near choice control
 160
 161     wxBookCtrlBase::SetImageList(imageList);
 162 }
 163
 164 // ----------------------------------------------------------------------------
 165 // selection
 166 // ----------------------------------------------------------------------------
 167
 168 int wxChoicebook::GetSelection() const
 169 {
 170     return m_selection;
 171 }
 172
 173 wxBookCtrlEvent* wxChoicebook::CreatePageChangingEvent() const
 174 {
 175     return new wxBookCtrlEvent(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, m_windowId);
 176 }
 177
 178 void wxChoicebook::MakeChangedEvent(wxBookCtrlEvent &event)
 179 {
 180     event.SetEventType(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED);
 181 }
 182
 183 // ----------------------------------------------------------------------------
 184 // adding/removing the pages
 185 // ----------------------------------------------------------------------------
 186
 187 bool
 188 wxChoicebook::InsertPage(size_t n,
 189                          wxWindow *page,
 190                          const wxString& text,
 191                          bool bSelect,
 192                          int imageId)
 193 {
 194     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
 195         return false;
 196
 197     GetChoiceCtrl()->Insert(text, n);
 198
 199     // if the inserted page is before the selected one, we must update the
 200     // index of the selected page
 201     if ( int(n) <= m_selection )
 202     {
 203         // one extra page added
 204         m_selection++;
 205         GetChoiceCtrl()->Select(m_selection);
 206     }
 207
 208     // some page should be selected: either this one or the first one if there
 209     // is still no selection
 210     int selNew = wxNOT_FOUND;
 211     if ( bSelect )
 212         selNew = n;
 213     else if ( m_selection == wxNOT_FOUND )
 214         selNew = 0;
 215
 216     if ( selNew != m_selection )
 217         page->Hide();
 218
 219     if ( selNew != wxNOT_FOUND )
 220         SetSelection(selNew);
 221
 222     return true;
 223 }
 224
 225 wxWindow *wxChoicebook::DoRemovePage(size_t page)
 226 {
 227     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 228
 229     if ( win )
 230     {
 231         GetChoiceCtrl()->Delete(page);
 232
 233         if ( m_selection >= (int)page )
 234         {
 235             // ensure that the selection is valid
 236             int sel;
 237             if ( GetPageCount() == 0 )
 238                 sel = wxNOT_FOUND;
 239             else
 240                 sel = m_selection ? m_selection - 1 : 0;
 241
 242             // if deleting current page we shouldn't try to hide it
 243             m_selection = m_selection == (int)page ? wxNOT_FOUND
 244                                                    : m_selection - 1;
 245
 246             if ( sel != wxNOT_FOUND && sel != m_selection )
 247                 SetSelection(sel);
 248         }
 249     }
 250
 251     return win;
 252 }
 253
 254
 255 bool wxChoicebook::DeleteAllPages()
 256 {
 257     m_selection = wxNOT_FOUND;
 258     GetChoiceCtrl()->Clear();
 259     return wxBookCtrlBase::DeleteAllPages();
 260 }
 261
 262 // ----------------------------------------------------------------------------
 263 // wxChoicebook events
 264 // ----------------------------------------------------------------------------
 265
 266 void wxChoicebook::OnChoiceSelected(wxCommandEvent& eventChoice)
 267 {
 268     if ( eventChoice.GetEventObject() != m_bookctrl )
 269     {
 270         eventChoice.Skip();
 271         return;
 272     }
 273
 274     const int selNew = eventChoice.GetSelection();
 275
 276     if ( selNew == m_selection )
 277     {
 278         // this event can only come from our own Select(m_selection) below
 279         // which we call when the page change is vetoed, so we should simply
 280         // ignore it
 281         return;
 282     }
 283
 284     SetSelection(selNew);
 285
 286     // change wasn't allowed, return to previous state
 287     if (m_selection != selNew)
 288         GetChoiceCtrl()->Select(m_selection);
 289 }
 290
 291 #endif // wxUSE_CHOICEBOOK