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 const wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING = wxNewEventType();
  53 const wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED = wxNewEventType();
  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         size.y += sizeChoice.y + GetInternalBorder();
 147     }
 148     else // left/right aligned
 149     {
 150         size.x += sizeChoice.x + GetInternalBorder();
 151     }
 152
 153     return size;
 154 }
 155
 156
 157 // ----------------------------------------------------------------------------
 158 // accessing the pages
 159 // ----------------------------------------------------------------------------
 160
 161 bool wxChoicebook::SetPageText(size_t n, const wxString& strText)
 162 {
 163     GetChoiceCtrl()->SetString(n, strText);
 164
 165     return true;
 166 }
 167
 168 wxString wxChoicebook::GetPageText(size_t n) const
 169 {
 170     return GetChoiceCtrl()->GetString(n);
 171 }
 172
 173 int wxChoicebook::GetPageImage(size_t WXUNUSED(n)) const
 174 {
 175     wxFAIL_MSG( _T("wxChoicebook::GetPageImage() not implemented") );
 176
 177     return wxNOT_FOUND;
 178 }
 179
 180 bool wxChoicebook::SetPageImage(size_t WXUNUSED(n), int WXUNUSED(imageId))
 181 {
 182     wxFAIL_MSG( _T("wxChoicebook::SetPageImage() not implemented") );
 183
 184     return false;
 185 }
 186
 187 // ----------------------------------------------------------------------------
 188 // image list stuff
 189 // ----------------------------------------------------------------------------
 190
 191 void wxChoicebook::SetImageList(wxImageList *imageList)
 192 {
 193     // TODO: can be implemented in form of static bitmap near choice control
 194
 195     wxBookCtrlBase::SetImageList(imageList);
 196 }
 197
 198 // ----------------------------------------------------------------------------
 199 // selection
 200 // ----------------------------------------------------------------------------
 201
 202 int wxChoicebook::GetSelection() const
 203 {
 204     return m_selection;
 205 }
 206
 207 wxBookCtrlEvent* wxChoicebook::CreatePageChangingEvent() const
 208 {
 209     return new wxBookCtrlEvent(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, m_windowId);
 210 }
 211
 212 void wxChoicebook::MakeChangedEvent(wxBookCtrlEvent &event)
 213 {
 214     event.SetEventType(wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED);
 215 }
 216
 217 // ----------------------------------------------------------------------------
 218 // adding/removing the pages
 219 // ----------------------------------------------------------------------------
 220
 221 bool
 222 wxChoicebook::InsertPage(size_t n,
 223                          wxWindow *page,
 224                          const wxString& text,
 225                          bool bSelect,
 226                          int imageId)
 227 {
 228     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
 229         return false;
 230
 231     GetChoiceCtrl()->Insert(text, n);
 232
 233     // if the inserted page is before the selected one, we must update the
 234     // index of the selected page
 235     if ( int(n) <= m_selection )
 236     {
 237         // one extra page added
 238         m_selection++;
 239         GetChoiceCtrl()->Select(m_selection);
 240     }
 241
 242     // some page should be selected: either this one or the first one if there
 243     // is still no selection
 244     int selNew = wxNOT_FOUND;
 245     if ( bSelect )
 246         selNew = n;
 247     else if ( m_selection == wxNOT_FOUND )
 248         selNew = 0;
 249
 250     if ( selNew != m_selection )
 251         page->Hide();
 252
 253     if ( selNew != wxNOT_FOUND )
 254         SetSelection(selNew);
 255
 256     return true;
 257 }
 258
 259 wxWindow *wxChoicebook::DoRemovePage(size_t page)
 260 {
 261     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 262
 263     if ( win )
 264     {
 265         GetChoiceCtrl()->Delete(page);
 266
 267         if ( m_selection >= (int)page )
 268         {
 269             // ensure that the selection is valid
 270             int sel;
 271             if ( GetPageCount() == 0 )
 272                 sel = wxNOT_FOUND;
 273             else
 274                 sel = m_selection ? m_selection - 1 : 0;
 275
 276             // if deleting current page we shouldn't try to hide it
 277             m_selection = m_selection == (int)page ? wxNOT_FOUND
 278                                                    : m_selection - 1;
 279
 280             if ( sel != wxNOT_FOUND && sel != m_selection )
 281                 SetSelection(sel);
 282         }
 283     }
 284
 285     return win;
 286 }
 287
 288
 289 bool wxChoicebook::DeleteAllPages()
 290 {
 291     m_selection = wxNOT_FOUND;
 292     GetChoiceCtrl()->Clear();
 293     return wxBookCtrlBase::DeleteAllPages();
 294 }
 295
 296 // ----------------------------------------------------------------------------
 297 // wxChoicebook events
 298 // ----------------------------------------------------------------------------
 299
 300 void wxChoicebook::OnChoiceSelected(wxCommandEvent& eventChoice)
 301 {
 302     if ( eventChoice.GetEventObject() != m_bookctrl )
 303     {
 304         eventChoice.Skip();
 305         return;
 306     }
 307
 308     const int selNew = eventChoice.GetSelection();
 309
 310     if ( selNew == m_selection )
 311     {
 312         // this event can only come from our own Select(m_selection) below
 313         // which we call when the page change is vetoed, so we should simply
 314         // ignore it
 315         return;
 316     }
 317
 318     SetSelection(selNew);
 319
 320     // change wasn't allowed, return to previous state
 321     if (m_selection != selNew)
 322         GetChoiceCtrl()->Select(m_selection);
 323 }
 324
 325 #endif // wxUSE_CHOICEBOOK