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