]> git.saurik.com Git - wxWidgets.git/blame - src/generic/choicdgg.cpp
documented while event.Skip() is necessary so that nobody removes it
[wxWidgets.git] / src / generic / choicdgg.cpp
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
dfad0599 2// Name: choicdgg.cpp
c801d85f
KB
3// Purpose: Choice dialogs
4// Author: Julian Smart
d6c9c1b7 5// Modified by: 03.11.00: VZ to add wxArrayString and multiple sel functions
c801d85f
KB
6// Created: 04/01/98
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) wxWidgets team
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
d6c9c1b7
VZ
12// ============================================================================
13// declarations
14// ============================================================================
15
14f355c2 16#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
d427503c 17 #pragma implementation "choicdgg.h"
c801d85f
KB
18#endif
19
d6c9c1b7
VZ
20// ----------------------------------------------------------------------------
21// headers
22// ----------------------------------------------------------------------------
23
c801d85f
KB
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#ifdef __BORLANDC__
d427503c 28 #pragma hdrstop
c801d85f
KB
29#endif
30
1e6feb95
VZ
31#if wxUSE_CHOICEDLG
32
c801d85f 33#ifndef WX_PRECOMP
257bf510
VZ
34 #include <stdio.h>
35 #include "wx/utils.h"
36 #include "wx/dialog.h"
37 #include "wx/button.h"
38 #include "wx/listbox.h"
39 #include "wx/stattext.h"
40 #include "wx/intl.h"
92afa2b1 41 #include "wx/sizer.h"
2da2f941 42 #include "wx/arrstr.h"
dcf924a3
RR
43#endif
44
45#if wxUSE_STATLINE
c50f1fb9 46 #include "wx/statline.h"
c801d85f
KB
47#endif
48
49#include "wx/generic/choicdgg.h"
50
d6c9c1b7
VZ
51// ----------------------------------------------------------------------------
52// constants
53// ----------------------------------------------------------------------------
54
257bf510 55#define wxID_LISTBOX 3000
dcf924a3 56
4b088139
WS
57// ---------------------------------------------------------------------------
58// macros
59// ---------------------------------------------------------------------------
60
61/* Macro for avoiding #ifdefs when value have to be different depending on size of
62 device we display on
63 */
64
65#if defined(__SMARTPHONE__)
66 #define wxLARGESMALL(large,small) small
67#else
68 #define wxLARGESMALL(large,small) large
69#endif
70
d6c9c1b7
VZ
71// ----------------------------------------------------------------------------
72// private functions
73// ----------------------------------------------------------------------------
74
75// convert wxArrayString into a wxString[] which must be delete[]d by caller
76static int ConvertWXArrayToC(const wxArrayString& aChoices, wxString **choices);
77
78// ============================================================================
79// implementation
80// ============================================================================
81
82// ----------------------------------------------------------------------------
83// helpers
84// ----------------------------------------------------------------------------
85
86int ConvertWXArrayToC(const wxArrayString& aChoices, wxString **choices)
87{
88 int n = aChoices.GetCount();
89 *choices = new wxString[n];
54b84891 90
d6c9c1b7
VZ
91 for ( int i = 0; i < n; i++ )
92 {
ea660175 93 (*choices)[i] = aChoices[i];
d6c9c1b7
VZ
94 }
95
96 return n;
97}
98
99// ----------------------------------------------------------------------------
100// wrapper functions
101// ----------------------------------------------------------------------------
102
103wxString wxGetSingleChoice( const wxString& message,
104 const wxString& caption,
105 int n, const wxString *choices,
106 wxWindow *parent,
107 int WXUNUSED(x), int WXUNUSED(y),
108 bool WXUNUSED(centre),
257bf510 109 int WXUNUSED(width), int WXUNUSED(height) )
c801d85f 110{
d427503c 111 wxSingleChoiceDialog dialog(parent, message, caption, n, choices);
3ca6a5f0 112 wxString choice;
d427503c 113 if ( dialog.ShowModal() == wxID_OK )
3ca6a5f0
BP
114 choice = dialog.GetStringSelection();
115
116 return choice;
c801d85f
KB
117}
118
d6c9c1b7
VZ
119wxString wxGetSingleChoice( const wxString& message,
120 const wxString& caption,
121 const wxArrayString& aChoices,
122 wxWindow *parent,
123 int x, int y,
124 bool centre,
125 int width, int height)
126{
127 wxString *choices;
128 int n = ConvertWXArrayToC(aChoices, &choices);
129 wxString res = wxGetSingleChoice(message, caption, n, choices, parent,
130 x, y, centre, width, height);
131 delete [] choices;
132
133 return res;
134}
135
d6c9c1b7
VZ
136int wxGetSingleChoiceIndex( const wxString& message,
137 const wxString& caption,
138 int n, const wxString *choices,
139 wxWindow *parent,
140 int WXUNUSED(x), int WXUNUSED(y),
141 bool WXUNUSED(centre),
142 int WXUNUSED(width), int WXUNUSED(height) )
c801d85f 143{
d427503c 144 wxSingleChoiceDialog dialog(parent, message, caption, n, choices);
3ca6a5f0 145 int choice;
d427503c 146 if ( dialog.ShowModal() == wxID_OK )
3ca6a5f0 147 choice = dialog.GetSelection();
d427503c 148 else
3ca6a5f0
BP
149 choice = -1;
150
151 return choice;
c801d85f
KB
152}
153
2adaf596
VS
154int wxGetSingleChoiceIndex( const wxString& message,
155 const wxString& caption,
156 const wxArrayString& aChoices,
157 wxWindow *parent,
158 int x, int y,
159 bool centre,
160 int width, int height)
161{
162 wxString *choices;
163 int n = ConvertWXArrayToC(aChoices, &choices);
164 int res = wxGetSingleChoiceIndex(message, caption, n, choices, parent,
165 x, y, centre, width, height);
166 delete [] choices;
167
168 return res;
169}
170
d6c9c1b7
VZ
171void *wxGetSingleChoiceData( const wxString& message,
172 const wxString& caption,
173 int n, const wxString *choices,
174 void **client_data,
175 wxWindow *parent,
176 int WXUNUSED(x), int WXUNUSED(y),
177 bool WXUNUSED(centre),
178 int WXUNUSED(width), int WXUNUSED(height) )
c801d85f 179{
b41ec29a
VZ
180 wxSingleChoiceDialog dialog(parent, message, caption, n, choices,
181 (char **)client_data);
3ca6a5f0 182 void *data;
d427503c 183 if ( dialog.ShowModal() == wxID_OK )
3ca6a5f0 184 data = dialog.GetSelectionClientData();
d427503c 185 else
3ca6a5f0
BP
186 data = NULL;
187
188 return data;
c801d85f
KB
189}
190
b41ec29a
VZ
191void *wxGetSingleChoiceData( const wxString& message,
192 const wxString& caption,
193 const wxArrayString& aChoices,
194 void **client_data,
195 wxWindow *parent,
196 int x, int y,
197 bool centre,
198 int width, int height)
199{
200 wxString *choices;
201 int n = ConvertWXArrayToC(aChoices, &choices);
202 void *res = wxGetSingleChoiceData(message, caption, n, choices,
203 client_data, parent,
204 x, y, centre, width, height);
205 delete [] choices;
206
207 return res;
208}
209
d6c9c1b7
VZ
210size_t wxGetMultipleChoices(wxArrayInt& selections,
211 const wxString& message,
212 const wxString& caption,
213 int n, const wxString *choices,
214 wxWindow *parent,
215 int WXUNUSED(x), int WXUNUSED(y),
216 bool WXUNUSED(centre),
217 int WXUNUSED(width), int WXUNUSED(height))
218{
219 wxMultiChoiceDialog dialog(parent, message, caption, n, choices);
e93bfe3c
VZ
220
221 if ( !selections.IsEmpty() )
222 dialog.SetSelections(selections);
223
d6c9c1b7
VZ
224 if ( dialog.ShowModal() == wxID_OK )
225 selections = dialog.GetSelections();
226 else
227 selections.Empty();
c801d85f 228
d6c9c1b7
VZ
229 return selections.GetCount();
230}
c801d85f 231
59bd9598 232size_t wxGetMultipleChoices(wxArrayInt& selections,
d6c9c1b7
VZ
233 const wxString& message,
234 const wxString& caption,
235 const wxArrayString& aChoices,
236 wxWindow *parent,
237 int x, int y,
238 bool centre,
239 int width, int height)
c801d85f 240{
d6c9c1b7
VZ
241 wxString *choices;
242 int n = ConvertWXArrayToC(aChoices, &choices);
243 size_t res = wxGetMultipleChoices(selections, message, caption,
244 n, choices, parent,
245 x, y, centre, width, height);
246 delete [] choices;
247
248 return res;
c801d85f 249}
c801d85f 250
d6c9c1b7
VZ
251// ----------------------------------------------------------------------------
252// wxAnyChoiceDialog
253// ----------------------------------------------------------------------------
254
255bool wxAnyChoiceDialog::Create(wxWindow *parent,
256 const wxString& message,
257 const wxString& caption,
258 int n, const wxString *choices,
ea660175 259 long styleDlg,
d6c9c1b7
VZ
260 const wxPoint& pos,
261 long styleLbox)
262{
ca65c044
WS
263 if ( !wxDialog::Create(parent, wxID_ANY, caption, pos, wxDefaultSize, styleDlg) )
264 return false;
d6c9c1b7
VZ
265
266 wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
267
64c794f6 268 // 1) text message
718970e5 269 topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(10,0) );
64c794f6
WS
270
271 // 2) list box
272 m_listbox = new wxListBox( this, wxID_LISTBOX,
273 wxDefaultPosition, wxDefaultSize,
274 n, choices,
275 styleLbox );
276 if ( n > 0 )
277 m_listbox->SetSelection(0);
278
718970e5 279 topsizer->Add( m_listbox, 1, wxEXPAND | wxLEFT|wxRIGHT, wxLARGESMALL(15,0) );
119727ad
WS
280
281#ifdef __SMARTPHONE__
64c794f6
WS
282
283 SetRightMenu(wxID_CANCEL, _("Cancel"));
284
285#else // __SMARTPHONE__/!__SMARTPHONE__
286
d6c9c1b7
VZ
287#if wxUSE_STATLINE
288 // 3) static line
ca65c044 289 topsizer->Add( new wxStaticLine( this, wxID_ANY ), 0, wxEXPAND | wxLEFT|wxRIGHT|wxTOP, 10 );
d6c9c1b7
VZ
290#endif
291
292 // 4) buttons
ea660175 293 topsizer->Add( CreateButtonSizer( styleDlg & (wxOK|wxCANCEL) ), 0, wxCENTRE | wxALL, 10 );
d6c9c1b7 294
64c794f6
WS
295#endif // !__SMARTPHONE__
296
ca65c044 297 SetAutoLayout( true );
d6c9c1b7
VZ
298 SetSizer( topsizer );
299
300 topsizer->SetSizeHints( this );
301 topsizer->Fit( this );
302
8316ff5d
VS
303 if ( styleDlg & wxCENTRE )
304 Centre(wxBOTH);
d6c9c1b7
VZ
305
306 m_listbox->SetFocus();
307
ca65c044 308 return true;
d6c9c1b7
VZ
309}
310
584ad2a3
MB
311bool wxAnyChoiceDialog::Create(wxWindow *parent,
312 const wxString& message,
313 const wxString& caption,
314 const wxArrayString& choices,
315 long styleDlg,
316 const wxPoint& pos,
317 long styleLbox)
318{
319 wxCArrayString chs(choices);
320 return Create(parent, message, caption, chs.GetCount(), chs.GetStrings(),
321 styleDlg, pos, styleLbox);
322}
323
d6c9c1b7 324// ----------------------------------------------------------------------------
c801d85f 325// wxSingleChoiceDialog
d6c9c1b7 326// ----------------------------------------------------------------------------
c801d85f 327
c801d85f 328BEGIN_EVENT_TABLE(wxSingleChoiceDialog, wxDialog)
d427503c
VZ
329 EVT_BUTTON(wxID_OK, wxSingleChoiceDialog::OnOK)
330 EVT_LISTBOX_DCLICK(wxID_LISTBOX, wxSingleChoiceDialog::OnListBoxDClick)
c801d85f
KB
331END_EVENT_TABLE()
332
d6c9c1b7 333IMPLEMENT_DYNAMIC_CLASS(wxSingleChoiceDialog, wxDialog)
257bf510
VZ
334
335wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
336 const wxString& message,
337 const wxString& caption,
c50f1fb9 338 int n,
257bf510
VZ
339 const wxString *choices,
340 char **clientData,
341 long style,
59bd9598 342 const wxPoint& WXUNUSED(pos))
c801d85f 343{
257bf510 344 Create(parent, message, caption, n, choices, clientData, style);
c801d85f
KB
345}
346
584ad2a3
MB
347wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
348 const wxString& message,
349 const wxString& caption,
350 const wxArrayString& choices,
351 char **clientData,
352 long style,
353 const wxPoint& WXUNUSED(pos))
354{
355 Create(parent, message, caption, choices, clientData, style);
356}
357
d6c9c1b7 358bool wxSingleChoiceDialog::Create( wxWindow *parent,
c50f1fb9 359 const wxString& message,
d6c9c1b7 360 const wxString& caption,
c50f1fb9 361 int n,
257bf510
VZ
362 const wxString *choices,
363 char **clientData,
364 long style,
d6c9c1b7 365 const wxPoint& pos )
c801d85f 366{
d6c9c1b7
VZ
367 if ( !wxAnyChoiceDialog::Create(parent, message, caption,
368 n, choices,
369 style, pos) )
ca65c044 370 return false;
92afa2b1 371
d6c9c1b7 372 m_selection = n > 0 ? 0 : -1;
92afa2b1 373
92afa2b1 374 if (clientData)
d427503c 375 {
257bf510
VZ
376 for (int i = 0; i < n; i++)
377 m_listbox->SetClientData(i, clientData[i]);
d427503c 378 }
c801d85f 379
ca65c044 380 return true;
c801d85f
KB
381}
382
584ad2a3
MB
383bool wxSingleChoiceDialog::Create( wxWindow *parent,
384 const wxString& message,
385 const wxString& caption,
386 const wxArrayString& choices,
387 char **clientData,
388 long style,
389 const wxPoint& pos )
390{
391 wxCArrayString chs(choices);
392 return Create( parent, message, caption, chs.GetCount(), chs.GetStrings(),
393 clientData, style, pos );
394}
395
ef77f91e
JS
396// Set the selection
397void wxSingleChoiceDialog::SetSelection(int sel)
398{
257bf510 399 m_listbox->SetSelection(sel);
ef77f91e
JS
400 m_selection = sel;
401}
402
c801d85f
KB
403void wxSingleChoiceDialog::OnOK(wxCommandEvent& WXUNUSED(event))
404{
257bf510
VZ
405 m_selection = m_listbox->GetSelection();
406 m_stringSelection = m_listbox->GetStringSelection();
eb553cb2 407 if ( m_listbox->HasClientUntypedData() )
59af5f19 408 SetClientData(m_listbox->GetClientData(m_selection));
d427503c 409 EndModal(wxID_OK);
c801d85f
KB
410}
411
debe6624
JS
412void wxSingleChoiceDialog::OnListBoxDClick(wxCommandEvent& WXUNUSED(event))
413{
257bf510
VZ
414 m_selection = m_listbox->GetSelection();
415 m_stringSelection = m_listbox->GetStringSelection();
25f47127 416
eb553cb2 417 if ( m_listbox->HasClientUntypedData() )
59af5f19 418 SetClientData(m_listbox->GetClientData(m_selection));
d427503c
VZ
419
420 EndModal(wxID_OK);
debe6624
JS
421}
422
d6c9c1b7
VZ
423// ----------------------------------------------------------------------------
424// wxMultiChoiceDialog
425// ----------------------------------------------------------------------------
426
d6c9c1b7
VZ
427IMPLEMENT_DYNAMIC_CLASS(wxMultiChoiceDialog, wxDialog)
428
429bool wxMultiChoiceDialog::Create( wxWindow *parent,
430 const wxString& message,
431 const wxString& caption,
432 int n,
433 const wxString *choices,
434 long style,
435 const wxPoint& pos )
436{
437 if ( !wxAnyChoiceDialog::Create(parent, message, caption,
438 n, choices,
439 style, pos,
3d49ce44 440 wxLB_ALWAYS_SB | wxLB_EXTENDED) )
ca65c044 441 return false;
d6c9c1b7 442
ca65c044 443 return true;
d6c9c1b7
VZ
444}
445
584ad2a3
MB
446bool wxMultiChoiceDialog::Create( wxWindow *parent,
447 const wxString& message,
448 const wxString& caption,
449 const wxArrayString& choices,
450 long style,
451 const wxPoint& pos )
452{
453 wxCArrayString chs(choices);
454 return Create( parent, message, caption, chs.GetCount(),
455 chs.GetStrings(), style, pos );
456}
457
d6c9c1b7
VZ
458void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
459{
460 size_t count = selections.GetCount();
461 for ( size_t n = 0; n < count; n++ )
462 {
463 m_listbox->Select(selections[n]);
464 }
465}
466
3d49ce44 467bool wxMultiChoiceDialog::TransferDataFromWindow()
d6c9c1b7
VZ
468{
469 m_selections.Empty();
470 size_t count = m_listbox->GetCount();
471 for ( size_t n = 0; n < count; n++ )
472 {
473 if ( m_listbox->IsSelected(n) )
474 m_selections.Add(n);
475 }
476
ca65c044 477 return true;
d6c9c1b7 478}
1e6feb95
VZ
479
480#endif // wxUSE_CHOICEDLG