]> git.saurik.com Git - wxWidgets.git/blame - src/generic/listbkg.cpp
The Great wxRegion Refactoring:
[wxWidgets.git] / src / generic / listbkg.cpp
CommitLineData
e9c0df38 1///////////////////////////////////////////////////////////////////////////////
2ddb4d13 2// Name: src/generic/listbkg.cpp
e9c0df38
VZ
3// Purpose: generic implementation of wxListbook
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 19.08.03
7// RCS-ID: $Id$
8// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
65571936 9// Licence: wxWindows licence
e9c0df38
VZ
10///////////////////////////////////////////////////////////////////////////////
11
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
19
e9c0df38
VZ
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_LISTBOOK
28
9eddec69
WS
29#include "wx/listbook.h"
30
31#ifndef WX_PRECOMP
32 #include "wx/settings.h"
33#endif
34
e9c0df38
VZ
35#include "wx/listctrl.h"
36#include "wx/statline.h"
5b24f0d3 37#include "wx/imaglist.h"
e9c0df38 38
e9c0df38 39// ----------------------------------------------------------------------------
77ffb593 40// various wxWidgets macros
e9c0df38
VZ
41// ----------------------------------------------------------------------------
42
1f30c176
WS
43// check that the page index is valid
44#define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
45
46// ----------------------------------------------------------------------------
47// event table
48// ----------------------------------------------------------------------------
49
2ddb4d13 50IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxBookCtrlBase)
e9c0df38
VZ
51IMPLEMENT_DYNAMIC_CLASS(wxListbookEvent, wxNotifyEvent)
52
9cf0f6ae 53#if !WXWIN_COMPATIBILITY_EVENT_TYPES
e9c0df38
VZ
54const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
55const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();
9cf0f6ae 56#endif
f29395d0 57const int wxID_LISTBOOKLISTVIEW = wxNewId();
e9c0df38 58
61c083e7 59BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)
e9c0df38 60 EVT_SIZE(wxListbook::OnSize)
f29395d0 61 EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)
e9c0df38
VZ
62END_EVENT_TABLE()
63
64// ============================================================================
65// wxListbook implementation
66// ============================================================================
67
68// ----------------------------------------------------------------------------
69// wxListbook creation
70// ----------------------------------------------------------------------------
71
72void wxListbook::Init()
73{
e9c0df38
VZ
74 m_selection = wxNOT_FOUND;
75}
76
77bool
78wxListbook::Create(wxWindow *parent,
79 wxWindowID id,
80 const wxPoint& pos,
81 const wxSize& size,
82 long style,
83 const wxString& name)
84{
2ddb4d13 85 if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
e9c0df38
VZ
86 {
87#ifdef __WXMAC__
2ddb4d13 88 style |= wxBK_TOP;
e9c0df38 89#else // !__WXMAC__
2ddb4d13 90 style |= wxBK_LEFT;
e9c0df38
VZ
91#endif // __WXMAC__/!__WXMAC__
92 }
93
ef0120c1
VZ
94 // no border for this control, it doesn't look nice together with
95 // wxListCtrl border
96 style &= ~wxBORDER_MASK;
97 style |= wxBORDER_NONE;
98
e9c0df38
VZ
99 if ( !wxControl::Create(parent, id, pos, size, style,
100 wxDefaultValidator, name) )
101 return false;
102
2ddb4d13 103 m_bookctrl = new wxListView
e9c0df38
VZ
104 (
105 this,
f29395d0 106 wxID_LISTBOOKLISTVIEW,
e9c0df38
VZ
107 wxDefaultPosition,
108 wxDefaultSize,
ef0120c1 109 wxLC_ICON | wxLC_SINGLE_SEL |
4a06b348 110 (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
e9c0df38
VZ
111 );
112
a9092ede 113#ifdef __WXMSW__
2ddb4d13 114 // On XP with themes enabled the GetViewRect used in GetControllerSize() to
a9092ede 115 // determine the space needed for the list view will incorrectly return
7b45094a 116 // (0,0,0,0) the first time. So send a pending event so OnSize will be
a9092ede
RD
117 // called again after the window is ready to go. Technically we don't
118 // need to do this on non-XP windows, but if things are already sized
119 // correctly then nothing changes and so there is no harm.
120 wxSizeEvent evt;
121 GetEventHandler()->AddPendingEvent(evt);
122#endif
e9c0df38
VZ
123 return true;
124}
125
126// ----------------------------------------------------------------------------
127// wxListbook geometry management
128// ----------------------------------------------------------------------------
129
2ddb4d13 130wxSize wxListbook::GetControllerSize() const
e9c0df38 131{
4a06b348 132 const wxSize sizeClient = GetClientSize(),
2ddb4d13
WS
133 sizeBorder = m_bookctrl->GetSize() - m_bookctrl->GetClientSize(),
134 sizeList = GetListView()->GetViewRect().GetSize() + sizeBorder;
e9c0df38
VZ
135
136 wxSize size;
2ddb4d13 137
e9c0df38
VZ
138 if ( IsVertical() )
139 {
140 size.x = sizeClient.x;
4a06b348 141 size.y = sizeList.y;
e9c0df38
VZ
142 }
143 else // left/right aligned
144 {
4a06b348 145 size.x = sizeList.x;
e9c0df38
VZ
146 size.y = sizeClient.y;
147 }
148
149 return size;
150}
151
e9c0df38
VZ
152void wxListbook::OnSize(wxSizeEvent& event)
153{
9f29226d
WS
154 // arrange the icons before calling SetClientSize(), otherwise it wouldn't
155 // account for the scrollbars the list control might need and, at least
156 // under MSW, we'd finish with an ugly looking list control with both
157 // vertical and horizontal scrollbar (with one of them being added because
158 // the other one is not accounted for in client size computations)
2ddb4d13
WS
159 wxListView *list = GetListView();
160 if (list) list->Arrange();
161 wxBookCtrlBase::OnSize(event);
e9c0df38
VZ
162}
163
d0a84b63 164int wxListbook::HitTest(const wxPoint& pt, long *flags) const
851b88c3
VZ
165{
166 int pagePos = wxNOT_FOUND;
167
d0a84b63 168 if ( flags )
9804d540 169 *flags = wxBK_HITTEST_NOWHERE;
851b88c3 170
d0a84b63
VZ
171 // convert from listbook control coordinates to list control coordinates
172 const wxListView * const list = GetListView();
173 const wxPoint listPt = list->ScreenToClient(ClientToScreen(pt));
174
175 // is the point inside list control?
22a35096 176 if ( wxRect(list->GetSize()).Contains(listPt) )
851b88c3
VZ
177 {
178 int flagsList;
d0a84b63 179 pagePos = list->HitTest(listPt, flagsList);
851b88c3 180
d0a84b63 181 if ( flags )
851b88c3 182 {
d0a84b63
VZ
183 if ( pagePos != wxNOT_FOUND )
184 *flags = 0;
185
186 if ( flagsList & (wxLIST_HITTEST_ONITEMICON |
187 wxLIST_HITTEST_ONITEMSTATEICON ) )
9804d540 188 *flags |= wxBK_HITTEST_ONICON;
d0a84b63
VZ
189
190 if ( flagsList & wxLIST_HITTEST_ONITEMLABEL )
9804d540 191 *flags |= wxBK_HITTEST_ONLABEL;
851b88c3
VZ
192 }
193 }
d0a84b63
VZ
194 else // not over list control at all
195 {
22a35096 196 if ( flags && GetPageRect().Contains(pt) )
9804d540 197 *flags |= wxBK_HITTEST_ONPAGE;
d0a84b63 198 }
851b88c3
VZ
199
200 return pagePos;
201}
202
e9c0df38
VZ
203wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
204{
159e6235 205 // we need to add the size of the list control and the border between
2ddb4d13 206 const wxSize sizeList = GetControllerSize();
e9c0df38
VZ
207
208 wxSize size = sizePage;
209 if ( IsVertical() )
210 {
159e6235 211 size.y += sizeList.y + GetInternalBorder();
e9c0df38
VZ
212 }
213 else // left/right aligned
214 {
159e6235 215 size.x += sizeList.x + GetInternalBorder();
e9c0df38
VZ
216 }
217
218 return size;
219}
220
221
222// ----------------------------------------------------------------------------
223// accessing the pages
224// ----------------------------------------------------------------------------
225
226bool wxListbook::SetPageText(size_t n, const wxString& strText)
227{
2ddb4d13 228 GetListView()->SetItemText(n, strText);
e9c0df38
VZ
229
230 return true;
231}
232
233wxString wxListbook::GetPageText(size_t n) const
234{
2ddb4d13 235 return GetListView()->GetItemText(n);
e9c0df38
VZ
236}
237
238int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
239{
240 wxFAIL_MSG( _T("wxListbook::GetPageImage() not implemented") );
241
9f29226d 242 return wxNOT_FOUND;
e9c0df38
VZ
243}
244
245bool wxListbook::SetPageImage(size_t n, int imageId)
246{
2ddb4d13 247 return GetListView()->SetItemImage(n, imageId);
e9c0df38
VZ
248}
249
250// ----------------------------------------------------------------------------
251// image list stuff
252// ----------------------------------------------------------------------------
253
254void wxListbook::SetImageList(wxImageList *imageList)
255{
2ddb4d13 256 GetListView()->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
e9c0df38 257
61c083e7 258 wxBookCtrlBase::SetImageList(imageList);
e9c0df38
VZ
259}
260
261// ----------------------------------------------------------------------------
262// selection
263// ----------------------------------------------------------------------------
264
265int wxListbook::GetSelection() const
266{
267 return m_selection;
268}
269
270int wxListbook::SetSelection(size_t n)
271{
1f30c176
WS
272 wxCHECK_MSG( IS_VALID_PAGE(n), wxNOT_FOUND,
273 wxT("invalid page index in wxListbook::SetSelection()") );
e9c0df38 274
1f30c176 275 const int oldSel = m_selection;
e9c0df38 276
1f30c176 277 if ( int(n) != m_selection )
e9c0df38 278 {
1f30c176
WS
279 wxListbookEvent event(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
280 event.SetSelection(n);
281 event.SetOldSelection(m_selection);
282 event.SetEventObject(this);
283 if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
284 {
285 if ( m_selection != wxNOT_FOUND )
286 m_pages[m_selection]->Hide();
e9c0df38 287
1f30c176
WS
288 wxWindow *page = m_pages[n];
289 page->SetSize(GetPageRect());
290 page->Show();
bb08a4a1 291
716dc245 292 // change m_selection now to ignore the selection change event
1f30c176 293 m_selection = n;
2ddb4d13
WS
294 GetListView()->Select(n);
295 GetListView()->Focus(n);
1f30c176
WS
296
297 // program allows the page change
298 event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
299 (void)GetEventHandler()->ProcessEvent(event);
300 }
e9c0df38
VZ
301 }
302
1f30c176 303 return oldSel;
e9c0df38
VZ
304}
305
e9c0df38
VZ
306// ----------------------------------------------------------------------------
307// adding/removing the pages
308// ----------------------------------------------------------------------------
309
310bool
311wxListbook::InsertPage(size_t n,
312 wxWindow *page,
313 const wxString& text,
314 bool bSelect,
315 int imageId)
316{
61c083e7 317 if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
e9c0df38
VZ
318 return false;
319
2ddb4d13 320 GetListView()->InsertItem(n, text, imageId);
e9c0df38 321
716dc245
WS
322 // if the inserted page is before the selected one, we must update the
323 // index of the selected page
324 if ( int(n) <= m_selection )
e9c0df38 325 {
42841dfc 326 // one extra page added
716dc245 327 m_selection++;
2ddb4d13
WS
328 GetListView()->Select(m_selection);
329 GetListView()->Focus(m_selection);
e9c0df38 330 }
716dc245
WS
331
332 // some page should be selected: either this one or the first one if there
333 // is still no selection
334 int selNew = -1;
335 if ( bSelect )
336 selNew = n;
337 else if ( m_selection == -1 )
338 selNew = 0;
339
340 if ( selNew != m_selection )
e9c0df38 341 page->Hide();
716dc245
WS
342
343 if ( selNew != -1 )
344 SetSelection(selNew);
e9c0df38 345
37144cf0 346 InvalidateBestSize();
6a82a0d0 347 // GetListView()->InvalidateBestSize();
2ddb4d13 348 GetListView()->Arrange();
9eddec69 349
6a82a0d0
JS
350 if (GetPageCount() == 1)
351 {
352 wxSizeEvent sz(GetSize(), GetId());
353 ProcessEvent(sz);
354 }
e9c0df38
VZ
355 return true;
356}
357
358wxWindow *wxListbook::DoRemovePage(size_t page)
359{
4a10ea8b 360 const size_t page_count = GetPageCount();
61c083e7 361 wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
bb08a4a1 362
e9c0df38
VZ
363 if ( win )
364 {
2ddb4d13 365 GetListView()->DeleteItem(page);
33ebfc3b
VZ
366
367 if (m_selection >= (int)page)
368 {
369 // force new sel valid if possible
370 int sel = m_selection - 1;
371 if (page_count == 1)
bb08a4a1 372 sel = wxNOT_FOUND;
33ebfc3b
VZ
373 else if ((page_count == 2) || (sel == -1))
374 sel = 0;
bb08a4a1 375
33ebfc3b 376 // force sel invalid if deleting current page - don't try to hide it
bb08a4a1
WS
377 m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1;
378
379 if ((sel != wxNOT_FOUND) && (sel != m_selection))
33ebfc3b
VZ
380 SetSelection(sel);
381 }
9f29226d 382
2ddb4d13 383 GetListView()->Arrange();
6a82a0d0
JS
384 if (GetPageCount() == 0)
385 {
386 wxSizeEvent sz(GetSize(), GetId());
387 ProcessEvent(sz);
388 }
e9c0df38
VZ
389 }
390
391 return win;
392}
393
fbd11d30
RD
394
395bool wxListbook::DeleteAllPages()
396{
2ddb4d13 397 GetListView()->DeleteAllItems();
6a82a0d0
JS
398 if (!wxBookCtrlBase::DeleteAllPages())
399 return false;
9eddec69 400
6a82a0d0
JS
401 m_selection = -1;
402
403 wxSizeEvent sz(GetSize(), GetId());
404 ProcessEvent(sz);
9eddec69 405
6a82a0d0 406 return true;
fbd11d30
RD
407}
408
e9c0df38
VZ
409// ----------------------------------------------------------------------------
410// wxListbook events
411// ----------------------------------------------------------------------------
412
413void wxListbook::OnListSelected(wxListEvent& eventList)
414{
415 const int selNew = eventList.GetIndex();
416
417 if ( selNew == m_selection )
418 {
419 // this event can only come from our own Select(m_selection) below
420 // which we call when the page change is vetoed, so we should simply
421 // ignore it
422 return;
423 }
424
716dc245 425 SetSelection(selNew);
e9c0df38 426
716dc245
WS
427 // change wasn't allowed, return to previous state
428 if (m_selection != selNew)
e9c0df38 429 {
2ddb4d13
WS
430 GetListView()->Select(m_selection);
431 GetListView()->Focus(m_selection);
e9c0df38 432 }
e9c0df38
VZ
433}
434
435#endif // wxUSE_LISTBOOK