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