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 // wxChoicebook geometry management
 116 // ----------------------------------------------------------------------------
 117
 118 wxSize wxChoicebook::GetControllerSize() const
 119 {
 120     const wxSize sizeClient = GetClientSize(),
 121                  sizeChoice = m_controlSizer->CalcMin();
 122
 123     wxSize size;
 124     if ( IsVertical() )
 125     {
 126         size.x = sizeClient.x;
 127         size.y = sizeChoice.y;
 128     }
 129     else // left/right aligned
 130     {
 131         size.x = sizeChoice.x;
 132         size.y = sizeClient.y;
 133     }
 134
 135     return size;
 136 }
 137
 138 wxSize wxChoicebook::CalcSizeFromPage(const wxSize& sizePage) const
 139 {
 140     // we need to add the size of the choice control and the border between
 141     const wxSize sizeChoice = GetControllerSize();
 142
 143     wxSize size = sizePage;
 144     if ( IsVertical() )
 145     {
 146         if ( sizeChoice.x > sizePage.x )
 147             size.x = sizeChoice.x;
 148         size.y += sizeChoice.y + GetInternalBorder();
 149     }
 150     else // left/right aligned
 151     {
 152         size.x += sizeChoice.x + GetInternalBorder();
 153         if ( sizeChoice.y > sizePage.y )
 154             size.y = sizeChoice.y;
 155     }
 156
 157     return size;
 158 }
 159
 160
 161 // ----------------------------------------------------------------------------
 162 // accessing the pages
 163 // ----------------------------------------------------------------------------
 164
 165 bool wxChoicebook::SetPageText(size_t n, const wxString& strText)
 166 {
 167     GetChoiceCtrl()->SetString(n, strText);
 168
 169     return true;
 170 }
 171
 172 wxString wxChoicebook::GetPageText(size_t n) const
 173 {
 174     return GetChoiceCtrl()->GetString(n);
 175 }
 176
 177 int wxChoicebook::GetPageImage(size_t WXUNUSED(n)) const
 178 {
 179     return wxNOT_FOUND;
 180 }
 181
 182 bool wxChoicebook::SetPageImage(size_t WXUNUSED(n), int WXUNUSED(imageId))
 183 {
 184     // fail silently, the code may be written to use one of several book
 185     // classes and call SetPageImage() unconditionally, it's better to just
 186     // ignore it (which is the best we can do short of rewriting this class to
 187     // use wxBitmapComboBox anyhow) than complain loudly about a rather
 188     // harmless problem
 189
 190     return false;
 191 }
 192
 193 // ----------------------------------------------------------------------------
 194 // miscellaneous other stuff
 195 // ----------------------------------------------------------------------------
 196
 197 void wxChoicebook::DoSetWindowVariant(wxWindowVariant variant)
 198 {
 199     wxBookCtrlBase::DoSetWindowVariant(variant);
 200     if (m_bookctrl)
 201         m_bookctrl->SetWindowVariant(variant);
 202 }
 203
 204 void wxChoicebook::SetImageList(wxImageList *imageList)
 205 {
 206     // TODO: can be implemented in form of static bitmap near choice control
 207
 208     wxBookCtrlBase::SetImageList(imageList);
 209 }
 210
 211 // ----------------------------------------------------------------------------
 212 // selection
 213 // ----------------------------------------------------------------------------
 214
 215 int wxChoicebook::GetSelection() const
 216 {
 217     return m_selection;
 218 }
 219
 220 wxBookCtrlEvent* wxChoicebook::CreatePageChangingEvent() const
 221 {
 222     return new wxBookCtrlEvent(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, m_windowId);
 223 }
 224
 225 void wxChoicebook::MakeChangedEvent(wxBookCtrlEvent &event)
 226 {
 227     event.SetEventType(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED);
 228 }
 229
 230 // ----------------------------------------------------------------------------
 231 // adding/removing the pages
 232 // ----------------------------------------------------------------------------
 233
 234 bool
 235 wxChoicebook::InsertPage(size_t n,
 236                          wxWindow *page,
 237                          const wxString& text,
 238                          bool bSelect,
 239                          int imageId)
 240 {
 241     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
 242         return false;
 243
 244     GetChoiceCtrl()->Insert(text, n);
 245
 246     // if the inserted page is before the selected one, we must update the
 247     // index of the selected page
 248     if ( int(n) <= m_selection )
 249     {
 250         // one extra page added
 251         m_selection++;
 252         GetChoiceCtrl()->Select(m_selection);
 253     }
 254
 255     // some page should be selected: either this one or the first one if there
 256     // is still no selection
 257     int selNew = wxNOT_FOUND;
 258     if ( bSelect )
 259         selNew = n;
 260     else if ( m_selection == wxNOT_FOUND )
 261         selNew = 0;
 262
 263     if ( selNew != m_selection )
 264         page->Hide();
 265
 266     if ( selNew != wxNOT_FOUND )
 267         SetSelection(selNew);
 268
 269     return true;
 270 }
 271
 272 wxWindow *wxChoicebook::DoRemovePage(size_t page)
 273 {
 274     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 275
 276     if ( win )
 277     {
 278         GetChoiceCtrl()->Delete(page);
 279
 280         if ( m_selection >= (int)page )
 281         {
 282             // ensure that the selection is valid
 283             int sel;
 284             if ( GetPageCount() == 0 )
 285                 sel = wxNOT_FOUND;
 286             else
 287                 sel = m_selection ? m_selection - 1 : 0;
 288
 289             // if deleting current page we shouldn't try to hide it
 290             m_selection = m_selection == (int)page ? wxNOT_FOUND
 291                                                    : m_selection - 1;
 292
 293             if ( sel != wxNOT_FOUND && sel != m_selection )
 294                 SetSelection(sel);
 295         }
 296     }
 297
 298     return win;
 299 }
 300
 301
 302 bool wxChoicebook::DeleteAllPages()
 303 {
 304     m_selection = wxNOT_FOUND;
 305     GetChoiceCtrl()->Clear();
 306     return wxBookCtrlBase::DeleteAllPages();
 307 }
 308
 309 // ----------------------------------------------------------------------------
 310 // wxChoicebook events
 311 // ----------------------------------------------------------------------------
 312
 313 void wxChoicebook::OnChoiceSelected(wxCommandEvent& eventChoice)
 314 {
 315     if ( eventChoice.GetEventObject() != m_bookctrl )
 316     {
 317         eventChoice.Skip();
 318         return;
 319     }
 320
 321     const int selNew = eventChoice.GetSelection();
 322
 323     if ( selNew == m_selection )
 324     {
 325         // this event can only come from our own Select(m_selection) below
 326         // which we call when the page change is vetoed, so we should simply
 327         // ignore it
 328         return;
 329     }
 330
 331     SetSelection(selNew);
 332
 333     // change wasn't allowed, return to previous state
 334     if (m_selection != selNew)
 335         GetChoiceCtrl()->Select(m_selection);
 336 }
 337
 338 #endif // wxUSE_CHOICEBOOK