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 IMPLEMENT_DYNAMIC_CLASS(wxChoicebookEvent, wxNotifyEvent)
  52
  53 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
  54 const wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING = wxNewEventType();
  55 const wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED = wxNewEventType();
  56 #endif
  57 const int wxID_CHOICEBOOKCHOICE = wxNewId();
  58
  59 BEGIN_EVENT_TABLE(wxChoicebook, wxBookCtrlBase)
  60     EVT_CHOICE(wxID_CHOICEBOOKCHOICE, wxChoicebook::OnChoiceSelected)
  61 END_EVENT_TABLE()
  62
  63 // ============================================================================
  64 // wxChoicebook implementation
  65 // ============================================================================
  66
  67 // ----------------------------------------------------------------------------
  68 // wxChoicebook creation
  69 // ----------------------------------------------------------------------------
  70
  71 void wxChoicebook::Init()
  72 {
  73     m_selection = wxNOT_FOUND;
  74 }
  75
  76 bool
  77 wxChoicebook::Create(wxWindow *parent,
  78                      wxWindowID id,
  79                      const wxPoint& pos,
  80                      const wxSize& size,
  81                      long style,
  82                      const wxString& name)
  83 {
  84     if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
  85     {
  86         style |= wxBK_TOP;
  87     }
  88
  89     // no border for this control, it doesn't look nice together with
  90     // wxChoice border
  91     style &= ~wxBORDER_MASK;
  92     style |= wxBORDER_NONE;
  93
  94     if ( !wxControl::Create(parent, id, pos, size, style,
  95                             wxDefaultValidator, name) )
  96         return false;
  97
  98     m_bookctrl = new wxChoice
  99                  (
 100                     this,
 101                     wxID_CHOICEBOOKCHOICE,
 102                     wxDefaultPosition,
 103                     wxDefaultSize
 104                  );
 105
 106     wxSizer* mainSizer = new wxBoxSizer(IsVertical() ? wxVERTICAL : wxHORIZONTAL);
 107
 108     if (style & wxBK_RIGHT || style & wxBK_BOTTOM)
 109         mainSizer->Add(0, 0, 1, wxEXPAND, 0);
 110
 111     m_controlSizer = new wxBoxSizer(IsVertical() ? wxHORIZONTAL : wxVERTICAL);
 112     m_controlSizer->Add(m_bookctrl, 1, (IsVertical() ? wxALIGN_CENTRE_VERTICAL : wxALIGN_CENTRE) |wxGROW, 0);
 113     mainSizer->Add(m_controlSizer, 0, wxGROW|wxALL, m_controlMargin);
 114     SetSizer(mainSizer);
 115     return true;
 116 }
 117
 118 // ----------------------------------------------------------------------------
 119 // wxChoicebook geometry management
 120 // ----------------------------------------------------------------------------
 121
 122 wxSize wxChoicebook::GetControllerSize() const
 123 {
 124     const wxSize sizeClient = GetClientSize(),
 125                  // sizeChoice = m_bookctrl->GetBestFittingSize();
 126                  sizeChoice = m_controlSizer->CalcMin();
 127
 128     wxSize size;
 129     if ( IsVertical() )
 130     {
 131         size.x = sizeClient.x;
 132         size.y = sizeChoice.y;
 133     }
 134     else // left/right aligned
 135     {
 136         size.x = sizeChoice.x;
 137         size.y = sizeClient.y;
 138     }
 139
 140     return size;
 141 }
 142
 143 wxSize wxChoicebook::CalcSizeFromPage(const wxSize& sizePage) const
 144 {
 145     // we need to add the size of the choice control and the border between
 146     const wxSize sizeChoice = GetControllerSize();
 147
 148     wxSize size = sizePage;
 149     if ( IsVertical() )
 150     {
 151         size.y += sizeChoice.y + GetInternalBorder();
 152     }
 153     else // left/right aligned
 154     {
 155         size.x += sizeChoice.x + GetInternalBorder();
 156     }
 157
 158     return size;
 159 }
 160
 161
 162 // ----------------------------------------------------------------------------
 163 // accessing the pages
 164 // ----------------------------------------------------------------------------
 165
 166 bool wxChoicebook::SetPageText(size_t n, const wxString& strText)
 167 {
 168     GetChoiceCtrl()->SetString(n, strText);
 169
 170     return true;
 171 }
 172
 173 wxString wxChoicebook::GetPageText(size_t n) const
 174 {
 175     return GetChoiceCtrl()->GetString(n);
 176 }
 177
 178 int wxChoicebook::GetPageImage(size_t WXUNUSED(n)) const
 179 {
 180     wxFAIL_MSG( _T("wxChoicebook::GetPageImage() not implemented") );
 181
 182     return wxNOT_FOUND;
 183 }
 184
 185 bool wxChoicebook::SetPageImage(size_t WXUNUSED(n), int WXUNUSED(imageId))
 186 {
 187     wxFAIL_MSG( _T("wxChoicebook::SetPageImage() not implemented") );
 188
 189     return false;
 190 }
 191
 192 // ----------------------------------------------------------------------------
 193 // image list stuff
 194 // ----------------------------------------------------------------------------
 195
 196 void wxChoicebook::SetImageList(wxImageList *imageList)
 197 {
 198     // TODO: can be implemented in form of static bitmap near choice control
 199
 200     wxBookCtrlBase::SetImageList(imageList);
 201 }
 202
 203 // ----------------------------------------------------------------------------
 204 // selection
 205 // ----------------------------------------------------------------------------
 206
 207 int wxChoicebook::GetSelection() const
 208 {
 209     return m_selection;
 210 }
 211
 212 int wxChoicebook::SetSelection(size_t n)
 213 {
 214     wxCHECK_MSG( IS_VALID_PAGE(n), wxNOT_FOUND,
 215                  wxT("invalid page index in wxChoicebook::SetSelection()") );
 216
 217     const int oldSel = m_selection;
 218
 219     if ( int(n) != m_selection )
 220     {
 221         wxChoicebookEvent event(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, m_windowId);
 222         event.SetSelection(n);
 223         event.SetOldSelection(m_selection);
 224         event.SetEventObject(this);
 225         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 226         {
 227             if ( m_selection != wxNOT_FOUND )
 228                 m_pages[m_selection]->Hide();
 229
 230             wxWindow *page = m_pages[n];
 231             page->SetSize(GetPageRect());
 232             page->Show();
 233
 234             // change m_selection now to ignore the selection change event
 235             m_selection = n;
 236             GetChoiceCtrl()->Select(n);
 237
 238             // program allows the page change
 239             event.SetEventType(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED);
 240             (void)GetEventHandler()->ProcessEvent(event);
 241         }
 242     }
 243
 244     return oldSel;
 245 }
 246
 247 // ----------------------------------------------------------------------------
 248 // adding/removing the pages
 249 // ----------------------------------------------------------------------------
 250
 251 bool
 252 wxChoicebook::InsertPage(size_t n,
 253                          wxWindow *page,
 254                          const wxString& text,
 255                          bool bSelect,
 256                          int imageId)
 257 {
 258     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
 259         return false;
 260
 261     GetChoiceCtrl()->Insert(text, n);
 262
 263     // if the inserted page is before the selected one, we must update the
 264     // index of the selected page
 265     if ( int(n) <= m_selection )
 266     {
 267         // one extra page added
 268         m_selection++;
 269         GetChoiceCtrl()->Select(m_selection);
 270     }
 271
 272     // some page should be selected: either this one or the first one if there
 273     // is still no selection
 274     int selNew = wxNOT_FOUND;
 275     if ( bSelect )
 276         selNew = n;
 277     else if ( m_selection == wxNOT_FOUND )
 278         selNew = 0;
 279
 280     if ( selNew != m_selection )
 281         page->Hide();
 282
 283     if ( selNew != wxNOT_FOUND )
 284         SetSelection(selNew);
 285
 286     InvalidateBestSize();
 287     return true;
 288 }
 289
 290 wxWindow *wxChoicebook::DoRemovePage(size_t page)
 291 {
 292     const size_t page_count = GetPageCount();
 293     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 294
 295     if ( win )
 296     {
 297         GetChoiceCtrl()->Delete(page);
 298
 299         if (m_selection >= (int)page)
 300         {
 301             // force new sel valid if possible
 302             int sel = m_selection - 1;
 303             if (page_count == 1)
 304                 sel = wxNOT_FOUND;
 305             else if ((page_count == 2) || (sel == -1))
 306                 sel = 0;
 307
 308             // force sel invalid if deleting current page - don't try to hide it
 309             m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1;
 310
 311             if ((sel != wxNOT_FOUND) && (sel != m_selection))
 312                 SetSelection(sel);
 313            }
 314     }
 315
 316     return win;
 317 }
 318
 319
 320 bool wxChoicebook::DeleteAllPages()
 321 {
 322     GetChoiceCtrl()->Clear();
 323     return wxBookCtrlBase::DeleteAllPages();
 324 }
 325
 326 // ----------------------------------------------------------------------------
 327 // wxChoicebook events
 328 // ----------------------------------------------------------------------------
 329
 330 void wxChoicebook::OnChoiceSelected(wxCommandEvent& eventChoice)
 331 {
 332     const int selNew = eventChoice.GetSelection();
 333
 334     if ( selNew == m_selection )
 335     {
 336         // this event can only come from our own Select(m_selection) below
 337         // which we call when the page change is vetoed, so we should simply
 338         // ignore it
 339         return;
 340     }
 341
 342     SetSelection(selNew);
 343
 344     // change wasn't allowed, return to previous state
 345     if (m_selection != selNew)
 346         GetChoiceCtrl()->Select(m_selection);
 347 }
 348
 349 #endif // wxUSE_CHOICEBOOK