document that SetValue() accepts values in 0..GetRange interval, inclusive

[wxWidgets.git] / src / generic / choicdgg.cpp

diff --git a/src/generic/choicdgg.cpp b/src/generic/choicdgg.cpp
index 1c270386e120e460b73a7b3ac9b6860d9ce9e21a..d037f6255d2f41bcd442625a141d51967fcc2303 100644 (file)
--- a/src/generic/choicdgg.cpp
+++ b/src/generic/choicdgg.cpp
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        choicdgg.cpp
+// Name:        src/generic/choicdgg.cpp

 // Purpose:     Choice dialogs
 // Author:      Julian Smart
 // Modified by: 03.11.00: VZ to add wxArrayString and multiple sel functions
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Purpose:     Choice dialogs
 // Author:      Julian Smart
 // Modified by: 03.11.00: VZ to add wxArrayString and multiple sel functions
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -13,10 +13,6 @@
 // declarations
 // ============================================================================
 
 // declarations
 // ============================================================================
 

-#ifdef __GNUG__
-    #pragma implementation "choicdgg.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -36,15 +32,15 @@
     #include "wx/dialog.h"
     #include "wx/button.h"
     #include "wx/listbox.h"
     #include "wx/dialog.h"
     #include "wx/button.h"
     #include "wx/listbox.h"

+    #include "wx/checklst.h"

     #include "wx/stattext.h"
     #include "wx/intl.h"
     #include "wx/sizer.h"
     #include "wx/stattext.h"
     #include "wx/intl.h"
     #include "wx/sizer.h"

+    #include "wx/arrstr.h"

 #endif
 
 #endif
 

-#if wxUSE_STATLINE
-    #include "wx/statline.h"
-#endif
-
+#include "wx/statline.h"
+#include "wx/settings.h"

 #include "wx/generic/choicdgg.h"
 
 // ----------------------------------------------------------------------------
 #include "wx/generic/choicdgg.h"
 
 // ----------------------------------------------------------------------------


@@ -118,28 +114,6 @@ wxString wxGetSingleChoice( const wxString& message,
     return res;
 }
 
     return res;
 }
 

-#if WXWIN_COMPATIBILITY_2
-// Overloaded for backward compatibility
-wxString wxGetSingleChoice( const wxString& message,
-                            const wxString& caption,
-                            int n, wxChar *choices[],
-                            wxWindow *parent,
-                            int x, int y, bool centre,
-                            int width, int height )
-{
-    wxString *strings = new wxString[n];
-    int i;
-    for ( i = 0; i < n; i++)
-    {
-        strings[i] = choices[i];
-    }
-    wxString ans(wxGetSingleChoice(message, caption, n, (const wxString *)strings, parent,
-        x, y, centre, width, height));
-    delete[] strings;
-    return ans;
-}
-#endif // WXWIN_COMPATIBILITY_2
-

 int wxGetSingleChoiceIndex( const wxString& message,
                             const wxString& caption,
                             int n, const wxString *choices,
 int wxGetSingleChoiceIndex( const wxString& message,
                             const wxString& caption,
                             int n, const wxString *choices,


@@ -175,25 +149,6 @@ int wxGetSingleChoiceIndex( const wxString& message,
     return res;
 }
 
     return res;
 }
 

-#if WXWIN_COMPATIBILITY_2
-// Overloaded for backward compatibility
-int wxGetSingleChoiceIndex( const wxString& message,
-                            const wxString& caption,
-                            int n, wxChar *choices[],
-                            wxWindow *parent,
-                            int x, int y, bool centre,
-                            int width, int height )
-{
-    wxString *strings = new wxString[n];
-    for ( int i = 0; i < n; i++)
-        strings[i] = choices[i];
-    int ans = wxGetSingleChoiceIndex(message, caption, n, (const wxString *)strings, parent,
-        x, y, centre, width, height);
-    delete[] strings;
-    return ans;
-}
-#endif // WXWIN_COMPATIBILITY_2
-

 void *wxGetSingleChoiceData( const wxString& message,
                              const wxString& caption,
                              int n, const wxString *choices,
 void *wxGetSingleChoiceData( const wxString& message,
                              const wxString& caption,
                              int n, const wxString *choices,


@@ -233,30 +188,6 @@ void *wxGetSingleChoiceData( const wxString& message,
     return res;
 }
 
     return res;
 }
 

-#if WXWIN_COMPATIBILITY_2
-// Overloaded for backward compatibility
-void *wxGetSingleChoiceData( const wxString& message,
-                             const wxString& caption,
-                             int n, wxChar *choices[],
-                             void **client_data,
-                             wxWindow *parent,
-                             int x, int y, bool centre, int width, int height )
-{
-    wxString *strings = new wxString[n];
-    int i;
-    for ( i = 0; i < n; i++)
-    {
-        strings[i] = choices[i];
-    }
-    void *data = wxGetSingleChoiceData(message, caption,
-                                       n, (const wxString *)strings,
-                                       client_data, parent,
-                                       x, y, centre, width, height);
-    delete[] strings;
-    return data;
-}
-#endif // WXWIN_COMPATIBILITY_2
-

 size_t wxGetMultipleChoices(wxArrayInt& selections,
                             const wxString& message,
                             const wxString& caption,
 size_t wxGetMultipleChoices(wxArrayInt& selections,
                             const wxString& message,
                             const wxString& caption,


@@ -268,8 +199,9 @@ size_t wxGetMultipleChoices(wxArrayInt& selections,
 {
     wxMultiChoiceDialog dialog(parent, message, caption, n, choices);
 
 {
     wxMultiChoiceDialog dialog(parent, message, caption, n, choices);
 

-    if ( !selections.IsEmpty() )
-        dialog.SetSelections(selections);
+    // call this even if selections array is empty and this then (correctly)
+    // deselects the first item which is selected by default
+    dialog.SetSelections(selections);

 
     if ( dialog.ShowModal() == wxID_OK )
         selections = dialog.GetSelections();
 
     if ( dialog.ShowModal() == wxID_OK )
         selections = dialog.GetSelections();


@@ -310,43 +242,73 @@ bool wxAnyChoiceDialog::Create(wxWindow *parent,
                                const wxPoint& pos,
                                long styleLbox)
 {
                                const wxPoint& pos,
                                long styleLbox)
 {

-    if ( !wxDialog::Create(parent, -1, caption, pos, wxDefaultSize, styleDlg) )
-        return FALSE;
+#ifdef __WXMAC__
+    // FIXME: why??
+    if ( !wxDialog::Create(parent, wxID_ANY, caption, pos, wxDefaultSize, styleDlg & (~wxCANCEL) ) )
+        return false;
+#else
+    if ( !wxDialog::Create(parent, wxID_ANY, caption, pos, wxDefaultSize, styleDlg) )
+        return false;
+#endif

 
     wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
 
     // 1) text message
 
     wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
 
     // 1) text message

-    topsizer->Add( CreateTextSizer( message ), 0, wxALL, 10 );
+    topsizer->
+        Add(CreateTextSizer(message), wxSizerFlags().Expand().TripleBorder());

 
     // 2) list box
 
     // 2) list box

-    m_listbox = new wxListBox( this, wxID_LISTBOX,
-                               wxDefaultPosition, wxDefaultSize,
-                               n, choices,
-                               styleLbox );
+    m_listbox = CreateList(n, choices, styleLbox);
+

     if ( n > 0 )
         m_listbox->SetSelection(0);
 
     if ( n > 0 )
         m_listbox->SetSelection(0);
 

-    topsizer->Add( m_listbox, 1, wxEXPAND | wxLEFT|wxRIGHT, 15 );
+    topsizer->
+        Add(m_listbox, wxSizerFlags().Expand().Proportion(1).TripleBorder(wxLEFT | wxRIGHT));

 
 

-#if wxUSE_STATLINE
-    // 3) static line
-    topsizer->Add( new wxStaticLine( this, -1 ), 0, wxEXPAND | wxLEFT|wxRIGHT|wxTOP, 10 );
-#endif
-
-    // 4) buttons
-    topsizer->Add( CreateButtonSizer( styleDlg & (wxOK|wxCANCEL) ), 0, wxCENTRE | wxALL, 10 );
+    // 3) buttons if any
+    wxSizer *
+        buttonSizer = CreateSeparatedButtonSizer(styleDlg & ButtonSizerFlags);
+    if ( buttonSizer )
+    {
+        topsizer->Add(buttonSizer, wxSizerFlags().Expand().DoubleBorder());
+    }

 
 

-    SetAutoLayout( TRUE );

     SetSizer( topsizer );
 
     topsizer->SetSizeHints( this );
     topsizer->Fit( this );
 
     SetSizer( topsizer );
 
     topsizer->SetSizeHints( this );
     topsizer->Fit( this );
 

-    Centre( wxBOTH );
+    if ( styleDlg & wxCENTRE )
+        Centre(wxBOTH);

 
     m_listbox->SetFocus();
 
 
     m_listbox->SetFocus();
 

-    return TRUE;
+    return true;
+}
+
+bool wxAnyChoiceDialog::Create(wxWindow *parent,
+                               const wxString& message,
+                               const wxString& caption,
+                               const wxArrayString& choices,
+                               long styleDlg,
+                               const wxPoint& pos,
+                               long styleLbox)
+{
+    wxCArrayString chs(choices);
+    return Create(parent, message, caption, chs.GetCount(), chs.GetStrings(),
+                  styleDlg, pos, styleLbox);
+}
+
+wxListBoxBase *wxAnyChoiceDialog::CreateList(int n, const wxString *choices, long styleLbox)
+{
+       wxSize size = wxDefaultSize;
+       if (wxSystemSettings::GetScreenType() > wxSYS_SCREEN_PDA)
+               size = wxSize(300, 200);
+    return new wxListBox( this, wxID_LISTBOX,
+                          wxDefaultPosition, size,
+                          n, choices,
+                          styleLbox );

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -355,7 +317,12 @@ bool wxAnyChoiceDialog::Create(wxWindow *parent,
 
 BEGIN_EVENT_TABLE(wxSingleChoiceDialog, wxDialog)
     EVT_BUTTON(wxID_OK, wxSingleChoiceDialog::OnOK)
 
 BEGIN_EVENT_TABLE(wxSingleChoiceDialog, wxDialog)
     EVT_BUTTON(wxID_OK, wxSingleChoiceDialog::OnOK)

+#ifndef __SMARTPHONE__

     EVT_LISTBOX_DCLICK(wxID_LISTBOX, wxSingleChoiceDialog::OnListBoxDClick)
     EVT_LISTBOX_DCLICK(wxID_LISTBOX, wxSingleChoiceDialog::OnListBoxDClick)

+#endif
+#ifdef __WXWINCE__
+    EVT_JOY_BUTTON_DOWN(wxSingleChoiceDialog::OnJoystickButtonDown)
+#endif

 END_EVENT_TABLE()
 
 IMPLEMENT_DYNAMIC_CLASS(wxSingleChoiceDialog, wxDialog)
 END_EVENT_TABLE()
 
 IMPLEMENT_DYNAMIC_CLASS(wxSingleChoiceDialog, wxDialog)


@@ -372,12 +339,10 @@ wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
     Create(parent, message, caption, n, choices, clientData, style);
 }
 
     Create(parent, message, caption, n, choices, clientData, style);
 }
 

-#if WXWIN_COMPATIBILITY_2
-

 wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
                                            const wxString& message,
                                            const wxString& caption,
 wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
                                            const wxString& message,
                                            const wxString& caption,

-                                           const wxStringList& choices,
+                                           const wxArrayString& choices,

                                            char **clientData,
                                            long style,
                                            const wxPoint& WXUNUSED(pos))
                                            char **clientData,
                                            long style,
                                            const wxPoint& WXUNUSED(pos))


@@ -385,27 +350,6 @@ wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
     Create(parent, message, caption, choices, clientData, style);
 }
 
     Create(parent, message, caption, choices, clientData, style);
 }
 

-bool wxSingleChoiceDialog::Create(wxWindow *parent,
-                                  const wxString& message,
-                                  const wxString& caption,
-                                  const wxStringList& choices,
-                                  char **clientData,
-                                  long style,
-                                  const wxPoint& pos)
-{
-    wxString *strings = new wxString[choices.Number()];
-    int i;
-    for ( i = 0; i < choices.Number(); i++)
-    {
-        strings[i] = (char *)choices.Nth(i)->Data();
-    }
-    bool ans = Create(parent, message, caption, choices.Number(), strings, clientData, style, pos);
-    delete[] strings;
-    return ans;
-}
-
-#endif // WXWIN_COMPATIBILITY_2
-

 bool wxSingleChoiceDialog::Create( wxWindow *parent,
                                    const wxString& message,
                                    const wxString& caption,
 bool wxSingleChoiceDialog::Create( wxWindow *parent,
                                    const wxString& message,
                                    const wxString& caption,


@@ -418,7 +362,7 @@ bool wxSingleChoiceDialog::Create( wxWindow *parent,
     if ( !wxAnyChoiceDialog::Create(parent, message, caption,
                                     n, choices,
                                     style, pos) )
     if ( !wxAnyChoiceDialog::Create(parent, message, caption,
                                     n, choices,
                                     style, pos) )

-        return FALSE;
+        return false;

 
     m_selection = n > 0 ? 0 : -1;
 
 
     m_selection = n > 0 ? 0 : -1;
 


@@ -428,7 +372,20 @@ bool wxSingleChoiceDialog::Create( wxWindow *parent,
             m_listbox->SetClientData(i, clientData[i]);
     }
 
             m_listbox->SetClientData(i, clientData[i]);
     }
 

-    return TRUE;
+    return true;
+}
+
+bool wxSingleChoiceDialog::Create( wxWindow *parent,
+                                   const wxString& message,
+                                   const wxString& caption,
+                                   const wxArrayString& choices,
+                                   char **clientData,
+                                   long style,
+                                   const wxPoint& pos )
+{
+    wxCArrayString chs(choices);
+    return Create( parent, message, caption, chs.GetCount(), chs.GetStrings(),
+                   clientData, style, pos );

 }
 
 // Set the selection
 }
 
 // Set the selection


@@ -440,14 +397,24 @@ void wxSingleChoiceDialog::SetSelection(int sel)
 
 void wxSingleChoiceDialog::OnOK(wxCommandEvent& WXUNUSED(event))
 {
 
 void wxSingleChoiceDialog::OnOK(wxCommandEvent& WXUNUSED(event))
 {

-    m_selection = m_listbox->GetSelection();
-    m_stringSelection = m_listbox->GetStringSelection();
-    if ( m_listbox->HasClientUntypedData() )
-        SetClientData(m_listbox->GetClientData(m_selection));
-    EndModal(wxID_OK);
+    DoChoice();

 }
 
 }
 

+#ifndef __SMARTPHONE__

 void wxSingleChoiceDialog::OnListBoxDClick(wxCommandEvent& WXUNUSED(event))
 void wxSingleChoiceDialog::OnListBoxDClick(wxCommandEvent& WXUNUSED(event))

+{
+    DoChoice();
+}
+#endif
+
+#ifdef __WXWINCE__
+void wxSingleChoiceDialog::OnJoystickButtonDown(wxJoystickEvent& WXUNUSED(event))
+{
+    DoChoice();
+}
+#endif
+
+void wxSingleChoiceDialog::DoChoice()

 {
     m_selection = m_listbox->GetSelection();
     m_stringSelection = m_listbox->GetStringSelection();
 {
     m_selection = m_listbox->GetSelection();
     m_stringSelection = m_listbox->GetStringSelection();


@@ -472,19 +439,71 @@ bool wxMultiChoiceDialog::Create( wxWindow *parent,
                                   long style,
                                   const wxPoint& pos )
 {
                                   long style,
                                   const wxPoint& pos )
 {

+    long styleLbox;
+#if wxUSE_CHECKLISTBOX
+    styleLbox = wxLB_ALWAYS_SB;
+#else
+    styleLbox = wxLB_ALWAYS_SB | wxLB_EXTENDED;
+#endif
+

     if ( !wxAnyChoiceDialog::Create(parent, message, caption,
                                     n, choices,
                                     style, pos,
     if ( !wxAnyChoiceDialog::Create(parent, message, caption,
                                     n, choices,
                                     style, pos,

-                                    wxLB_ALWAYS_SB | wxLB_EXTENDED) )
-        return FALSE;
+                                    styleLbox) )
+        return false;
+
+    return true;
+}

 
 

-    return TRUE;
+bool wxMultiChoiceDialog::Create( wxWindow *parent,
+                                  const wxString& message,
+                                  const wxString& caption,
+                                  const wxArrayString& choices,
+                                  long style,
+                                  const wxPoint& pos )
+{
+    wxCArrayString chs(choices);
+    return Create( parent, message, caption, chs.GetCount(),
+                   chs.GetStrings(), style, pos );

 }
 
 void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
 {
 }
 
 void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
 {

-    size_t count = selections.GetCount();
-    for ( size_t n = 0; n < count; n++ )
+#if wxUSE_CHECKLISTBOX
+    wxCheckListBox* checkListBox = wxDynamicCast(m_listbox, wxCheckListBox);
+    if (checkListBox)
+    {
+        // first clear all currently selected items
+        size_t n,
+            count = checkListBox->GetCount();
+        for ( n = 0; n < count; ++n )
+        {
+            if (checkListBox->IsChecked(n))
+                checkListBox->Check(n, false);
+        }
+
+        // now select the ones which should be selected
+        count = selections.GetCount();
+        for ( n = 0; n < count; n++ )
+        {
+            checkListBox->Check(selections[n]);
+        }
+
+        return;
+    }
+#endif
+
+    // first clear all currently selected items
+    size_t n,
+           count = m_listbox->GetCount();
+    for ( n = 0; n < count; ++n )
+    {
+        m_listbox->Deselect(n);
+    }
+
+    // now select the ones which should be selected
+    count = selections.GetCount();
+    for ( n = 0; n < count; n++ )

     {
         m_listbox->Select(selections[n]);
     }
     {
         m_listbox->Select(selections[n]);
     }


@@ -493,6 +512,21 @@ void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
 bool wxMultiChoiceDialog::TransferDataFromWindow()
 {
     m_selections.Empty();
 bool wxMultiChoiceDialog::TransferDataFromWindow()
 {
     m_selections.Empty();

+
+#if wxUSE_CHECKLISTBOX
+    wxCheckListBox* checkListBox = wxDynamicCast(m_listbox, wxCheckListBox);
+    if (checkListBox)
+    {
+        size_t count = checkListBox->GetCount();
+        for ( size_t n = 0; n < count; n++ )
+        {
+            if ( checkListBox->IsChecked(n) )
+                m_selections.Add(n);
+        }
+        return true;
+    }
+#endif
+

     size_t count = m_listbox->GetCount();
     for ( size_t n = 0; n < count; n++ )
     {
     size_t count = m_listbox->GetCount();
     for ( size_t n = 0; n < count; n++ )
     {


@@ -500,7 +534,23 @@ bool wxMultiChoiceDialog::TransferDataFromWindow()
             m_selections.Add(n);
     }
 
             m_selections.Add(n);
     }
 

-    return TRUE;
+    return true;
+}
+
+#if wxUSE_CHECKLISTBOX
+
+wxListBoxBase *wxMultiChoiceDialog::CreateList(int n, const wxString *choices, long styleLbox)
+{
+       wxSize size = wxDefaultSize;
+       if (wxSystemSettings::GetScreenType() > wxSYS_SCREEN_PDA)
+               size = wxSize(300, 200);
+
+    return new wxCheckListBox( this, wxID_LISTBOX,
+                               wxDefaultPosition, size,
+                               n, choices,
+                               styleLbox );

 }
 
 }
 

+#endif // wxUSE_CHECKLISTBOX
+

 #endif // wxUSE_CHOICEDLG
 #endif // wxUSE_CHOICEDLG